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