borg2-backup/conf/borg2-backup-nc.conf.sample
2024-11-18 17:23:03 +01:00

227 lines
3.3 KiB
Plaintext

#-----------------------------
# Settings for script borg2-backup-nc.sh
#-----------------------------
# HTTP_USER
#
# User under which the webserver is running
#
# Defaults to:
#
# HTTP_USER="www-data"
#
#HTTP_USER="www-data"
# SSH_USER
#
# The (remote) user under which the SSH session for the
# data transfer is running.
#
# Defaults to:
#
# SSH_USER="borg"
#
#BACKUP_USER="borg"
# SSH_PORT
#
# The port under which the SSH service is accessible
#
# Defaults to:
#
# SSH_PORT=22
#
#SSH_PORT=22
# BORG_HOST
#
# The (remote) host on which the backups are saved.
#
# !! No Defaults - this parameter is mandatory
#
#BORG_HOST="<Fully-Qualified Host Name>"
# BORG_RSH
#
# The command, which is used instead of ssh.
#
# This can be used to specify ssh options, such as a custom identity file
# ssh -i /path/to/private/key. See man ssh for other options.
#
# Using the --rsh CMD commandline option overrides the environment variable.
#
# Defaults to:
# BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup'
#
#BORG_RSH='ssh -i /root/.ssh/id_ed25519-borg-backup'
# BORG_PASSPHRASE
#
# Password of the Borg Repository (which was used while initializing)
#
# !! No Defaults - this parameter is mandatory
#
#BORG_PASSPHRASE='borg-password>'
# BORG_REPO
#
# The repository location on the (remote) backup host.
#
# !! No Defaults - this parameter is mandatory
#
#BORG_REPO=<path-to-the-borg-repository>
# BORG_LOG_DIR
#
# Log to this directory
#
# Defaults to:
#
# BORG_LOG_DIR="/var/log/borg"
#
#BORG_LOG_DIR="/var/log/borg"
# ---
# NC related parameters
# ---
# NC_PATH
#
# Path to the Nextcloud (NC) installation directory (mostly the DocumenRoot
# directory)
#
# !! No Defaults - this parameter is mandatory
#
#NC_PATH="<Path-to-the-NC-installation-directory>"
# NC_DB_BACKUP_DIR
#
# Directory in which a current database dump is stored and transferred to the repository
#
# Defaults to:
#
# NC_DB_BACKUP_DIR="/data/backup/sql"
#
#NC_DB_BACKUP_DIR="/data/backup/sql"
# ---
# Other Backups
# ---
# BACKUP_OTHER_DIRECTORIES
#
# Directories other than NextCloud that should also be backed up
#
# Defaults to:
#
# BACKUP_OTHER_DIRECTORIES="/etc /home /root /var/spool/cron"
#
# - Blank separated list of directories -
#
#BACKUP_OTHER_DIRECTORIES="/etc /home /root /var/spool/cron"
# KEEP_DAILY
#
# Number of daily archives to keep
#
# Defaults to:
#
# KEEP_DAILY=10
#
#KEEP_DAILY=10
# KEEP_WEEKLY
#
# Number of weekly archives to keep
#
# Defaults to:
#
# KEEP_WEEKLY=5
#
#KEEP_WEEKLY=5
# KEEP_MONTHLY
#
# Number of monthly archives to keep
#
# Defaults to:
#
# KEEP_MONTHLY=6
#
#KEEP_MONTHLY=6
# KEEP_YEARLY
#
# Number of yearly archives to keep
#
# Defaults to:
#
# KEEP_YEARLY=1
#
#KEEP_YEARLY=1
# ---
# Restore Parameters
# ---
# BORG_FUSE_MOUNT_DIR
#
# Mountpoint where to mount an borg backup archiv as a FUSE filesystem.
#
# Defaults to:
#
# BORG_MOUNT_FUSE_DIR="/mnt/borg-fuse-mount"
#
#BORG_MOUNT_FUSE_DIR="/mnt/borg-fuse-mount"
# ---
# Alert Parameters
# ---
# ADMIN_EMAIL
#
# Send Informations about the backup prozess to this e-mail address
#
# Defaults to:
#
# ADMIN_EMAIL="root"
#
#ADMIN_EMAIL="root"
# FROM_ADDRESS
#
# Defaults to:
#
# "borg-backup@$(hostname -f)"
#
#FROM_ADDRESS=""
# COMPANY
#
# DEFAULTS to
# Defaults to:
#
# COMPANY="O.OPEN"
#
#COMPANY="O.OPEN"