mkinitrd.sh: Fix comment typo.
[dragonfly.git] / etc / defaults / periodic.conf
blobb73c288e52a4fe4796a8b4e7f5503fa3cf203804
1 #!/bin/sh
3 # This is defaults/periodic.conf - a file full of useful variables that
4 # you can set to change the default behaviour of periodic jobs on your
5 # system. You should not edit this file! Put any overrides into one of the
6 # $periodic_conf_files instead and you will be able to update these defaults
7 # later without spamming your local configuration information.
9 # The $periodic_conf_files files should only contain values which override
10 # values set in this file. This eases the upgrade path when defaults
11 # are changed and new features are added.
13 # For a more detailed explanation of all the periodic.conf variables, please
14 # refer to the periodic.conf(5) manual page.
16 # $FreeBSD: head/etc/defaults/periodic.conf 324738 2017-10-19 03:17:50Z cy $
19 # What files override these defaults ?
20 periodic_conf_files="/etc/periodic.conf /etc/periodic.conf.local"
22 # periodic script dirs
23 local_periodic="/usr/local/etc/periodic"
25 # Max time to sleep to avoid causing congestion on download servers
26 anticongestion_sleeptime=3600
28 # Daily options
30 # These options are used by periodic(8) itself to determine what to do
31 # with the output of the sub-programs that are run, and where to send
32 # that output. $daily_output might be set to /var/log/daily.log if you
33 # wish to log the daily output and have the files rotated by newsyslog(8)
35 daily_output="root" # user or /file
36 daily_show_success="YES" # scripts returning 0
37 daily_show_info="YES" # scripts returning 1
38 daily_show_badconfig="NO" # scripts returning 2
40 # 100.clean-disks
41 daily_clean_disks_enable="NO" # Delete files daily
42 daily_clean_disks_files="[#,]* .#* a.out *.core *.CKP .emacs_[0-9]*"
43 daily_clean_disks_days=3 # If older than this
44 daily_clean_disks_verbose="YES" # Mention files deleted
46 # 110.clean-tmps
47 daily_clean_tmps_enable="NO" # Delete stuff daily
48 daily_clean_tmps_dirs="/tmp" # Delete under here
49 daily_clean_tmps_days="3" # If not accessed for
50 daily_clean_tmps_ignore=".X*-lock .X11-unix .ICE-unix .font-unix .XIM-unix"
51 daily_clean_tmps_ignore="$daily_clean_tmps_ignore quota.user quota.group .snap"
52 daily_clean_tmps_ignore="$daily_clean_tmps_ignore .sujournal"
53 # Don't delete these
54 daily_clean_tmps_verbose="YES" # Mention files deleted
56 # 120.clean-preserve
57 daily_clean_preserve_enable="YES" # Delete files daily
58 daily_clean_preserve_days=7 # If not modified for
59 daily_clean_preserve_verbose="YES" # Mention files deleted
61 # 130.clean-msgs
62 daily_clean_msgs_enable="YES" # Delete msgs daily
63 daily_clean_msgs_days= # If not modified for
65 # 140.clean-rwho
66 daily_clean_rwho_enable="YES" # Delete rwho daily
67 daily_clean_rwho_days=7 # If not modified for
68 daily_clean_rwho_verbose="YES" # Mention files deleted
70 # 150.clean-hoststat
71 daily_clean_hoststat_enable="YES" # Purge sendmail host
72 # status cache daily
74 # 160.clean-hammer
75 daily_clean_hammer_enable="YES" # HAMMER maintenance
76 daily_clean_hammer_verbose="NO" # Be verbose
77 daily_clean_hammer_pfslist="" # default: mounted pfs
79 # 161.clean-hammer2
80 daily_clean_hammer2_enable="YES" # HAMMER2 maintenance
81 daily_clean_hammer2_verbose="NO" # Be verbose
82 daily_clean_hammer2_pfslist="" # default: all mounted
84 # 200.backup-passwd
85 daily_backup_passwd_enable="YES" # Backup passwd & group
87 # 210.backup-aliases
88 daily_backup_aliases_enable="YES" # Backup mail aliases
90 # 300.calendar
91 daily_calendar_enable="NO" # Run calendar -a
93 # 310.accounting
94 daily_accounting_enable="YES" # Rotate acct files
95 daily_accounting_compress="NO" # Gzip rotated files
96 daily_accounting_flags=-q # Flags to /usr/sbin/sa
97 daily_accounting_save=3 # How many files to save
99 # 330.news
100 daily_news_expire_enable="YES" # Run news.expire
102 # 400.status-disks
103 daily_status_disks_enable="YES" # Check disk status
104 daily_status_disks_df_flags="-l -h" # df(1) flags for check
106 # 410.status-mfi
107 daily_status_mfi_enable="NO" # Check mfiutil(8)
109 # 420.status-network
110 daily_status_network_enable="YES" # Check network status
111 daily_status_network_usedns="YES" # DNS lookups are ok
112 daily_status_network_netstat_flags="-d" # netstat(1) flags
114 # 430.status-uptime
115 daily_status_uptime_enable="YES" # Check system uptime
117 # 440.status-mailq
118 daily_status_mailq_enable="YES" # Check mail status
119 daily_status_mailq_shorten="NO" # Shorten output
120 daily_status_include_submit_mailq="YES" # Also submit queue
122 # 450.status-security
123 daily_status_security_enable="YES" # Security check
124 # See also "Security options" below for more options
125 daily_status_security_inline="NO" # Run inline ?
126 daily_status_security_output="root" # user or /file
128 # 460.status-mail-rejects
129 daily_status_mail_rejects_enable="YES" # Check mail rejects
130 daily_status_mail_rejects_logs=3 # How many logs to check
131 daily_status_mail_rejects_shorten="NO" # Shorten output
133 # 500.queuerun
134 daily_queuerun_enable="YES" # Run mail queue
135 daily_submit_queuerun="YES" # Also submit queue
137 # 999.local
138 daily_local="/etc/daily.local" # Local scripts
141 # Weekly options
143 # These options are used by periodic(8) itself to determine what to do
144 # with the output of the sub-programs that are run, and where to send
145 # that output. $weekly_output might be set to /var/log/weekly.log if you
146 # wish to log the weekly output and have the files rotated by newsyslog(8)
148 weekly_output="root" # user or /file
149 weekly_show_success="YES" # scripts returning 0
150 weekly_show_info="YES" # scripts returning 1
151 weekly_show_badconfig="NO" # scripts returning 2
153 # 310.locate
154 weekly_locate_enable="YES" # Update locate weekly
156 # 320.whatis
157 weekly_whatis_enable="YES" # Update whatis weekly
159 # 330.catman
160 weekly_catman_enable="NO" # Preformat man pages
162 # 340.noid
163 weekly_noid_enable="NO" # Find unowned files
164 weekly_noid_dirs="/" # Look here
166 # 450.status-security
167 weekly_status_security_enable="YES" # Security check
168 # See also "Security options" below for more options
169 weekly_status_security_inline="NO" # Run inline ?
170 weekly_status_security_output="root" # user or /file
172 # 999.local
173 weekly_local="/etc/weekly.local" # Local scripts
176 # Monthly options
178 # These options are used by periodic(8) itself to determine what to do
179 # with the output of the sub-programs that are run, and where to send
180 # that output. $monthly_output might be set to /var/log/monthly.log if you
181 # wish to log the monthly output and have the files rotated by newsyslog(8)
183 monthly_output="root" # user or /file
184 monthly_show_success="YES" # scripts returning 0
185 monthly_show_info="YES" # scripts returning 1
186 monthly_show_badconfig="NO" # scripts returning 2
188 # 200.accounting
189 monthly_accounting_enable="YES" # Login accounting
191 # 450.status-security
192 monthly_status_security_enable="YES" # Security check
193 # See also "Security options" below for more options
194 monthly_status_security_inline="NO" # Run inline ?
195 monthly_status_security_output="root" # user or /file
197 # 999.local
198 monthly_local="/etc/monthly.local" # Local scripts
201 # Security options
203 security_show_success="YES" # scripts returning 0
204 security_show_info="YES" # scripts returning 1
205 security_show_badconfig="NO" # scripts returning 2
207 # These options are used by the security periodic(8) scripts spawned in
208 # daily and weekly 450.status-security.
209 security_status_logdir="/var/log" # Directory for logs
210 security_status_diff_flags="-b -u" # flags for diff output
212 # Each of the security_status_*_period options below can have one of the
213 # following values:
214 # - NO: do not run at all
215 # - daily: only run during the daily security status
216 # - weekly: only run during the weekly security status
217 # - monthly: only run during the monthly security status
218 # Note that if periodic security scripts are run from crontab(5) directly,
219 # they will be run unless _enable or _period is set to "NO".
221 # 100.chksetuid
222 security_status_chksetuid_enable="YES"
223 security_status_chksetuid_period="daily"
225 # 110.neggrpperm
226 security_status_neggrpperm_enable="YES"
227 security_status_neggrpperm_period="daily"
229 # 200.chkmounts
230 security_status_chkmounts_enable="YES"
231 security_status_chkmounts_period="daily"
232 #security_status_chkmounts_ignore="^mfs:" # Don't check matching
233 # FS types
234 security_status_nomfs="NO" # Don't check mfs mounts
236 # 300.chkuid0
237 security_status_chkuid0_enable="YES"
238 security_status_chkuid0_period="daily"
240 # 400.passwdless
241 security_status_passwdless_enable="YES"
242 security_status_passwdless_period="daily"
244 # 410.logincheck
245 security_status_logincheck_enable="YES"
246 security_status_logincheck_period="daily"
248 # 500.ipfwdenied
249 security_status_ipfwdenied_enable="YES"
250 security_status_ipfwdenied_period="daily"
252 # 520.pfdenied
253 security_status_pfdenied_enable="YES"
254 security_status_pfdenied_period="daily"
256 # 550.ipfwlimit
257 security_status_ipfwlimit_enable="YES"
258 security_status_ipfwlimit_period="daily"
260 # 600.ip6fwdenied
261 security_status_ip6fwdenied_enable="YES"
262 security_status_ip6fwdenied_period="daily"
264 # 650.ip6fwlimit
265 security_status_ip6fwlimit_enable="YES"
266 security_status_ip6fwlimit_period="daily"
268 # 700.kernelmsg
269 security_status_kernelmsg_enable="YES"
270 security_status_kernelmsg_period="daily"
272 # 800.loginfail
273 security_status_loginfail_enable="YES"
274 security_status_loginfail_period="daily"
276 # 900.tcpwrap
277 security_status_tcpwrap_enable="YES"
278 security_status_tcpwrap_period="daily"
282 # Define source_periodic_confs, the mechanism used by /etc/periodic/*/*
283 # scripts to source defaults/periodic.conf overrides safely.
285 if [ -z "${source_periodic_confs_defined}" ]; then
286 source_periodic_confs_defined=yes
287 source_periodic_confs() {
288 local i sourced_files
290 for i in ${periodic_conf_files}; do
291 case ${sourced_files} in
292 *:$i:*)
295 sourced_files="${sourced_files}:$i:"
296 [ -r $i ] && . $i
298 esac
299 done
302 # Sleep for a random amount of time in order to mitigate the thundering
303 # herd problem of multiple hosts running periodic simultaneously.
304 # Will not sleep when used interactively.
305 # Will sleep at most once per invocation of periodic
306 anticongestion() {
307 [ -n "$PERIODIC_IS_INTERACTIVE" ] && return
308 if [ -f "$PERIODIC_ANTICONGESTION_FILE" ]; then
309 rm -f $PERIODIC_ANTICONGESTION_FILE
310 sleep `jot -r 1 0 ${anticongestion_sleeptime}`
314 # Compatibility with old daily variable names.
315 # They can be removed in stable/11.
316 security_daily_compat_var() {
317 local var=$1 dailyvar value
319 dailyvar=daily_status_security${var#security_status}
320 periodvar=${var%enable}period
321 eval value=\"\$$dailyvar\"
322 [ -z "$value" ] && return
323 echo "Warning: Variable \$$dailyvar is deprecated," \
324 "use \$$var instead." >&2
325 case "$value" in
326 [Yy][Ee][Ss])
327 eval $var=YES
328 eval $periodvar=daily
331 eval $var=\"$value\"
333 esac
336 check_yesno_period() {
337 local var="$1" periodvar value period
339 eval value=\"\$$var\"
340 case "$value" in
341 [Yy][Ee][Ss]) ;;
342 *) return 1 ;;
343 esac
345 periodvar=${var%enable}period
346 eval period=\"\$$periodvar\"
347 case "$PERIODIC" in
348 "security daily")
349 case "$period" in
350 [Dd][Aa][Ii][Ll][Yy]) return 0 ;;
351 *) return 1 ;;
352 esac
354 "security weekly")
355 case "$period" in
356 [Ww][Ee][Ee][Kk][Ll][Yy]) return 0 ;;
357 *) return 1 ;;
358 esac
360 "security monthly")
361 case "$period" in
362 [Mm][Oo][Nn][Tt][Hh][Ll][Yy]) return 0 ;;
363 *) return 1 ;;
364 esac
366 security)
367 # Run directly from crontab(5).
368 case "$period" in
369 [Nn][Oo]) return 1 ;;
370 *) return 0 ;;
371 esac
374 # Script run manually.
375 return 0
378 echo "ASSERTION FAILED: Unexpected value for" \
379 "\$PERIODIC: '$PERIODIC'" >&2
380 exit 127
382 esac