env.example

# env.example - environment variables needed by the toolbox
# ----------------------------------------------------------------------------
# Load this file before invoking any of the scripts.
#
# None of the values below are real, they are placeholders. Replace
# them with your own values and chmod the resulting file to 0600.
# ----------------------------------------------------------------------------

# ---- Mail alerts ----
# Recipient for failure alerts. Multiple addresses can be passed
# comma-separated to swaks via several --to flags
ALERT_TO="admin@example.org"

# Envelope sender used by swaks. Each script can overrides this with its
# own per-host default if needed.
ALERT_FROM="root@orchestrator.example.net"

# SMTP relay used to send the alert mail. In the production setup, the
# web-mail node serves as the relay for every other host, including
# itself when it has internal connectivity to localhost.
ALERT_SMTP_SERVER="web-mail.example.org"
ALERT_SMTP_PORT="465"          # 465 = implicit TLS, 587 = STARTTLS
ALERT_SMTP_USER="admin@example.org"

# Path to a 0600 file containing only the SMTP password.
# See orchestrator/.smtp_pass.example for the expected layout.
ALERT_SMTP_PASSWORD_FILE="/root/backup-orchestrator/.smtp_pass"

# ---- Orchestrator behaviour ----
# 0 = mail only on failure (default)
# 1 = also send a daily OK summary
BACKUP_SEND_OK="0"

# Override paths for environments where /root/backup-orchestrator does
# not fit. The orchestrator must be able to write logs under $BACKUP_BASE/log.
# BACKUP_BASE="/srv/backup-orchestrator"

# ---- LUKS lifecycle (managed by luks_functions.sh) ----
# Regex matching the mapper names this toolbox is allowed to close.
BACKUP_MAPPER_REGEX='^(Backup_.*_crypt|NasCore_crypt)$'

# Default mountpoint for opened LUKS containers.
MOUNT_POINT_DEFAULT="/home/tmp_crypt"

# Path to the docker binary on Synology DSM, used as a fallback for
# `swaks` when the native package is unavailable. Has no effect on
# non-Synology hosts.
DOCKER_BIN="/usr/local/bin/docker"

# ---- Verification (managed by verification/ scripts) ----
# Override the log paths used by the restoration tests if /var/log is
# not writable for them.
# RESTORE_TEST_RSYNC_LOG="/var/log/restore-test-rsync.log"
# RESTORE_TEST_MYSQL_LOG="/var/log/restore-test-mysql.log"