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