###############################################################################
## Config for ``bin/cron/osh-orphaned-homedir.sh``
##
## Any file in ``/etc/bastion/osh-orphaned-homedir.conf.d`` will also be
## sourced, in alphabetical order, and take precedence over any
## option specified in this file.
##
## Please ensure this file is owned by root and not world-writable.
##
## As it'll be sourced, THIS FILE MUST BE A VALID SHELL SCRIPT.
##
#@ .. note::
#@
#@    This script is called by cron and is responsible for clearing up
#@    orphaned home directories on secondary bastions.
#@    Indeed, once the user has been deleted, a few files may remain,
#@    such as logs, so this script handles the proper archiving
#@    of these sparse files, before removing the orphaned home directory.
###############################################################################
#
# > Logging & activation
# >> Script logging configuration and script activation
#
# LOGFILE (string, path to a file)
#    DESC: File where the logs will be written to (don't forget to configure ``logrotate``!).
#          Note that using this configuration option, the script will directly write to the file, without using syslog.
#          If empty, won't log directly to any file.
# DEFAULT: ""
LOGFILE=""
#
# LOG_FACILITY (string)
#    DESC: The syslog facility to use for logging the script output.
#          If set to the empty string, we'll not log through syslog at all.
#          If this configuration option is missing from your config file altogether,
#          the default value will be used (local6), which means that we'll log to syslog.
# DEFAULT: "local6"
LOG_FACILITY="local6"
#
# ENABLED (0 or 1)
#    DESC: If set to 1, the script is enabled and will run when started by crond.
# DEFAULT: 1
ENABLED=1