xref: /freebsd/usr.sbin/periodic/periodic.conf (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1#!/bin/sh
2#
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.
8#
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.
12#
13# For a more detailed explanation of all the periodic.conf variables, please
14# refer to the periodic.conf(5) manual page.
15#
16# $FreeBSD$
17#
18
19# What files override these defaults ?
20periodic_conf_files="/etc/periodic.conf /etc/periodic.conf.local"
21
22# periodic script dirs
23local_periodic="/usr/local/etc/periodic"
24
25# Max time to sleep to avoid causing congestion on download servers
26anticongestion_sleeptime=3600
27
28# Daily options
29
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)
34#
35daily_output="root"					# user or /file
36daily_show_success="YES"				# scripts returning 0
37daily_show_info="YES"					# scripts returning 1
38daily_show_badconfig="NO"				# scripts returning 2
39
40# 100.clean-disks
41daily_clean_disks_enable="NO"				# Delete files daily
42daily_clean_disks_files="[#,]* .#* a.out *.core *.CKP .emacs_[0-9]*"
43daily_clean_disks_days=3				# If older than this
44daily_clean_disks_verbose="YES"				# Mention files deleted
45
46# 110.clean-tmps
47daily_clean_tmps_enable="NO"				# Delete stuff daily
48daily_clean_tmps_dirs="/tmp"				# Delete under here
49daily_clean_tmps_days="3"				# If not accessed for
50daily_clean_tmps_ignore=".X*-lock .X11-unix .ICE-unix .font-unix .XIM-unix"
51daily_clean_tmps_ignore="$daily_clean_tmps_ignore quota.user quota.group .snap"
52daily_clean_tmps_ignore="$daily_clean_tmps_ignore .sujournal"
53							# Don't delete these
54daily_clean_tmps_verbose="YES"				# Mention files deleted
55
56# 120.clean-preserve
57daily_clean_preserve_enable="YES"			# Delete files daily
58daily_clean_preserve_days=7				# If not modified for
59daily_clean_preserve_verbose="YES"			# Mention files deleted
60
61# 130.clean-msgs
62daily_clean_msgs_enable="YES"				# Delete msgs daily
63daily_clean_msgs_days=					# If not modified for
64
65# 140.clean-rwho
66daily_clean_rwho_enable="YES"				# Delete rwho daily
67daily_clean_rwho_days=7					# If not modified for
68daily_clean_rwho_verbose="YES"				# Mention files deleted
69
70# 150.clean-hoststat
71daily_clean_hoststat_enable="YES"			# Purge sendmail host
72							# status cache daily
73
74# 200.backup-passwd
75daily_backup_passwd_enable="YES"			# Backup passwd & group
76
77# 210.backup-aliases
78daily_backup_aliases_enable="YES"			# Backup mail aliases
79
80# 221.backup-gpart
81daily_backup_gpart_enable="YES"             		# Backup partition table/boot partition/MBR
82daily_backup_gpart_verbose="NO"             		# Be verbose if new backup differs from the old one
83daily_backup_efi_enable="NO"                		# Backup EFI system partition (ESP)
84
85# 222.backup-gmirror
86daily_backup_gmirror_enable="NO"			# Backup of gmirror info (i.e., output of `gmirror list`)
87daily_backup_gmirror_verbose="NO"			# Log diff if new backup differs from the old one
88
89# 223.backup-zfs
90daily_backup_zfs_enable="NO"				# Backup output from zpool/zfs list
91daily_backup_zfs_props_enable="NO"			# Backup zpool/zfs filesystem properties
92daily_backup_zfs_get_flags="all"			# flags passed to `zfs get`
93daily_backup_zfs_list_flags=""				# flags passed to `zfs list`
94daily_backup_zpool_get_flags="all"			# flags passed to `zpool get`
95daily_backup_zpool_list_flags="-v"			# flags passed to `zpool list`
96daily_backup_zfs_verbose="NO"				# Report diff between the old and new backups.
97
98# 300.calendar
99daily_calendar_enable="NO"				# Run calendar -a
100
101# 310.accounting
102daily_accounting_enable="YES"				# Rotate acct files
103daily_accounting_compress="NO"				# Gzip rotated files
104daily_accounting_flags=-q				# Flags to /usr/sbin/sa
105daily_accounting_save=3					# How many files to save
106
107# 330.news
108daily_news_expire_enable="YES"				# Run news.expire
109
110# 400.status-disks
111daily_status_disks_enable="YES"				# Check disk status
112daily_status_disks_df_flags="-l -h"			# df(1) flags for check
113
114# 401.status-graid
115daily_status_graid_enable="NO"				# Check graid(8)
116
117# 404.status-zfs
118daily_status_zfs_enable="NO"				# Check ZFS
119daily_status_zfs_zpool_list_enable="YES"		# List ZFS pools
120
121# 406.status-gmirror
122daily_status_gmirror_enable="NO"			# Check gmirror(8)
123
124# 407.status-graid3
125daily_status_graid3_enable="NO" 			# Check graid3(8)
126
127# 408.status-gstripe
128daily_status_gstripe_enable="NO"			# Check gstripe(8)
129
130# 409.status-gconcat
131daily_status_gconcat_enable="NO"			# Check gconcat(8)
132
133# 410.status-mfi
134daily_status_mfi_enable="NO"				# Check mfiutil(8)
135
136# 420.status-network
137daily_status_network_enable="YES"			# Check network status
138daily_status_network_usedns="YES"			# DNS lookups are ok
139daily_status_network_netstat_flags="-d -W"		# netstat(1) flags
140
141# 430.status-uptime
142daily_status_uptime_enable="YES"			# Check system uptime
143
144# 440.status-mailq
145daily_status_mailq_enable="YES"				# Check mail status
146daily_status_mailq_shorten="NO"				# Shorten output
147daily_status_include_submit_mailq="YES"			# Also submit queue
148
149# 450.status-security
150daily_status_security_enable="YES"			# Security check
151# See also "Security options" below for more options
152daily_status_security_inline="NO"			# Run inline ?
153daily_status_security_output="root"			# user or /file
154
155# 460.status-mail-rejects
156daily_status_mail_rejects_enable="YES"			# Check mail rejects
157daily_status_mail_rejects_logs=3			# How many logs to check
158daily_status_mail_rejects_shorten="NO"			# Shorten output
159
160# 480.leapfile-ntpd
161daily_ntpd_leapfile_enable="YES"			# Fetch NTP leapfile
162
163# 480.status-ntpd
164daily_status_ntpd_enable="NO"				# Check NTP status
165
166# 500.queuerun
167daily_queuerun_enable="YES"				# Run mail queue
168daily_submit_queuerun="YES"				# Also submit queue
169
170# 510.status-world-kernel
171daily_status_world_kernel="YES"				# Check the running
172							# userland/kernel version
173
174# 800.scrub-zfs
175daily_scrub_zfs_enable="NO"
176daily_scrub_zfs_pools=""			# empty string selects all pools
177daily_scrub_zfs_default_threshold="35"		# days between scrubs
178#daily_scrub_zfs_${poolname}_threshold="35"	# pool specific threshold
179
180# 999.local
181daily_local="/etc/daily.local"				# Local scripts
182
183
184# Weekly options
185
186# These options are used by periodic(8) itself to determine what to do
187# with the output of the sub-programs that are run, and where to send
188# that output.  $weekly_output might be set to /var/log/weekly.log if you
189# wish to log the weekly output and have the files rotated by newsyslog(8)
190#
191weekly_output="root"					# user or /file
192weekly_show_success="YES"				# scripts returning 0
193weekly_show_info="YES"					# scripts returning 1
194weekly_show_badconfig="NO"				# scripts returning 2
195
196# 310.locate
197weekly_locate_enable="YES"				# Update locate weekly
198
199# 320.whatis
200weekly_whatis_enable="YES"				# Update whatis weekly
201
202# 340.noid
203weekly_noid_enable="NO"					# Find unowned files
204weekly_noid_dirs="/"					# Look here
205
206# 450.status-security
207weekly_status_security_enable="YES"			# Security check
208# See also "Security options" above for more options
209weekly_status_security_inline="NO"			# Run inline ?
210weekly_status_security_output="root"			# user or /file
211
212# 999.local
213weekly_local="/etc/weekly.local"			# Local scripts
214
215
216# Monthly options
217
218# These options are used by periodic(8) itself to determine what to do
219# with the output of the sub-programs that are run, and where to send
220# that output.  $monthly_output might be set to /var/log/monthly.log if you
221# wish to log the monthly output and have the files rotated by newsyslog(8)
222#
223monthly_output="root"					# user or /file
224monthly_show_success="YES"				# scripts returning 0
225monthly_show_info="YES"					# scripts returning 1
226monthly_show_badconfig="NO"				# scripts returning 2
227
228# 200.accounting
229monthly_accounting_enable="YES"				# Login accounting
230
231# 450.status-security
232monthly_status_security_enable="YES"			# Security check
233# See also "Security options" above for more options
234monthly_status_security_inline="NO"			# Run inline ?
235monthly_status_security_output="root"			# user or /file
236
237# 999.local
238monthly_local="/etc/monthly.local"			# Local scripts
239
240
241# Security options
242
243security_show_success="YES"				# scripts returning 0
244security_show_info="YES"				# scripts returning 1
245security_show_badconfig="NO"				# scripts returning 2
246
247# These options are used by the security periodic(8) scripts spawned in
248# daily and weekly 450.status-security.
249security_status_logdir="/var/log"			# Directory for logs
250security_status_diff_flags="-b -u"			# flags for diff output
251
252# Each of the security_status_*_period options below can have one of the
253# following values:
254# - NO: do not run at all
255# - daily: only run during the daily security status
256# - weekly: only run during the weekly security status
257# - monthly: only run during the monthly security status
258# Note that if periodic security scripts are run from crontab(5) directly,
259# they will be run unless _enable or _period is set to "NO".
260
261# 100.chksetuid
262security_status_chksetuid_enable="YES"
263security_status_chksetuid_period="daily"
264
265# 110.neggrpperm
266security_status_neggrpperm_enable="YES"
267security_status_neggrpperm_period="daily"
268
269# 200.chkmounts
270security_status_chkmounts_enable="YES"
271security_status_chkmounts_period="daily"
272#security_status_chkmounts_ignore="^amd:"		# Don't check matching
273							# FS types
274security_status_noamd="NO"				# Don't check amd mounts
275
276# 300.chkuid0
277security_status_chkuid0_enable="YES"
278security_status_chkuid0_period="daily"
279
280# 400.passwdless
281security_status_passwdless_enable="YES"
282security_status_passwdless_period="daily"
283
284# 410.logincheck
285security_status_logincheck_enable="YES"
286security_status_logincheck_period="daily"
287
288# 500.ipfwdenied
289security_status_ipfwdenied_enable="YES"
290security_status_ipfwdenied_period="daily"
291
292# 510.ipfdenied
293security_status_ipfdenied_enable="YES"
294security_status_ipfdenied_period="daily"
295
296# 520.pfdenied
297security_status_pfdenied_enable="YES"
298security_status_pfdenied_period="daily"
299
300# 550.ipfwlimit
301security_status_ipfwlimit_enable="YES"
302security_status_ipfwlimit_period="daily"
303
304# 610.ipf6denied
305security_status_ipf6denied_enable="YES"
306security_status_ipf6denied_period="daily"
307
308# 700.kernelmsg
309security_status_kernelmsg_enable="YES"
310security_status_kernelmsg_period="daily"
311
312# 800.loginfail
313security_status_loginfail_enable="YES"
314security_status_loginfail_period="daily"
315
316# 900.tcpwrap
317security_status_tcpwrap_enable="YES"
318security_status_tcpwrap_period="daily"
319
320
321
322# Define source_periodic_confs, the mechanism used by /etc/periodic/*/*
323# scripts to source defaults/periodic.conf overrides safely.
324
325if [ -z "${source_periodic_confs_defined}" ]; then
326        source_periodic_confs_defined=yes
327
328	# Sleep for a random amount of time in order to mitigate the thundering
329	# herd problem of multiple hosts running periodic simultaneously.
330	# Will not sleep when used interactively.
331	# Will sleep at most once per invocation of periodic
332	anticongestion() {
333		[ -n "$PERIODIC_IS_INTERACTIVE" ] && return
334		if [ -f "$PERIODIC_ANTICONGESTION_FILE" ]; then
335			rm -f $PERIODIC_ANTICONGESTION_FILE
336			sleep `jot -r 1 0 ${anticongestion_sleeptime}`
337		fi
338	}
339
340	# Compatibility with old daily variable names.
341	# They can be removed in stable/11.
342	security_daily_compat_var() {
343		local var=$1 dailyvar value
344
345		dailyvar=daily_status_security${var#security_status}
346		periodvar=${var%enable}period
347		eval value=\"\$$dailyvar\"
348		[ -z "$value" ] && return
349		echo "Warning: Variable \$$dailyvar is deprecated," \
350		    "use \$$var instead." >&2
351		case "$value" in
352		[Yy][Ee][Ss])
353			eval $var=YES
354			eval $periodvar=daily
355			;;
356		*)
357			eval $var=\"$value\"
358			;;
359		esac
360	}
361
362	check_yesno_period() {
363		local var="$1" periodvar value period
364
365		eval value=\"\$$var\"
366		case "$value" in
367		[Yy][Ee][Ss]) ;;
368		*) return 1 ;;
369		esac
370
371		periodvar=${var%enable}period
372		eval period=\"\$$periodvar\"
373		case "$PERIODIC" in
374		"security daily")
375			case "$period" in
376			[Dd][Aa][Ii][Ll][Yy]) return 0 ;;
377			*) return 1 ;;
378			esac
379			;;
380		"security weekly")
381			case "$period" in
382			[Ww][Ee][Ee][Kk][Ll][Yy]) return 0 ;;
383			*) return 1 ;;
384			esac
385			;;
386		"security monthly")
387			case "$period" in
388			[Mm][Oo][Nn][Tt][Hh][Ll][Yy]) return 0 ;;
389			*) return 1 ;;
390			esac
391			;;
392		security)
393			# Run directly from crontab(5).
394			case "$period" in
395			[Nn][Oo]) return 1 ;;
396			*) return 0 ;;
397			esac
398			;;
399                '')
400                        # Script run manually.
401                        return 0
402                        ;;
403		*)
404			echo "ASSERTION FAILED: Unexpected value for" \
405			    "\$PERIODIC: '$PERIODIC'" >&2
406			exit 127
407			;;
408		esac
409	}
410
411        source_periodic_confs() {
412                local i sourced_files
413
414                for i in ${periodic_conf_files}; do
415                        case ${sourced_files} in
416                        *:$i:*)
417                                ;;
418                        *)
419                                sourced_files="${sourced_files}:$i:"
420                                [ -r $i ] && . $i
421                                ;;
422                        esac
423                done
424        }
425fi
426