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