# GitHub Enterprise Server backup configuration file

# The hostname of the GitHub Enterprise Server appliance to back up. The host

# must be reachable via SSH from the backup host.

GHE_HOSTNAME="github.example.com"

# Path to where backup data is stored. By default this is the "data"

# directory next to this file but can be set to an absolute path

# elsewhere for backing up to a separate partition / mount point.

GHE_DATA_DIR="data"

# The number of backup snapshots to retain. Old snapshots are pruned after each

# successful ghe-backup run. This option should be tuned based on the frequency

# of scheduled backup runs. If backups are scheduled hourly, snapshots will be

# available for the past N hours; if backups are scheduled daily, snapshots will

# be available for the past N days ...

GHE_NUM_SNAPSHOTS=10

# Pruning snapshots can be scheduled outside of the backup process.

# If set to 'yes', snapshots will not be pruned by ghe-backup.

# Instead, ghe-prune-snapshots will need to be invoked separately via cron

#GHE_PRUNING_SCHEDULED=yes

# If GHE_ROUTE_VERIFICATION is set to true then ghe-repository-backup and

# ghe-storage-backup will issue a warning if the repositories and objects in

# the backup do not match the pre-backup inventory of routes.

#GHE_ROUTE_VERIFICATION=false

# If GHE_MANAGE_CONSOLE_PW_RESTORE is set to false then management-console password

# will not be restored from backed-up snapshot data, it is restored by default

#GHE_MANAGE_CONSOLE_PW_RESTORE=true

# If GHE_SKIP_CHECKS is set to true (or if --skip-checks is used with ghe-backup) then ghe-host-check

# disk space validation and software version checks on the backup-host will be disabled.

#GHE_SKIP_CHECKS=false

# Cluster filesystem to check if it's writable as part of ghe-host-check

# By default it is /data/user/tmp but can be updated if needed

#GHE_FILE_SYSTEM_WRITE_CHECK="/data/user/tmp"

# The hostname of the GitHub appliance to restore. If you've set up a separate

# GitHub appliance to act as a standby for recovery, specify its IP or hostname

# here. The host to restore to may also be specified directly when running

# ghe-restore so use of this variable isn't strictly required.

#

#GHE_RESTORE_HOST="github-standby.example.com"

# If set to 'yes', ghe-restore will omit the restore of audit logs.

#

#GHE_RESTORE_SKIP_AUDIT_LOGS=no

# If set to 'yes', backup and restore of Elasticsearch indices will be skipped

#

#GHE_SKIP_SEARCH_INDICES=no

# When verbose output is enabled with `-v`, it's written to stdout by default. If

# you'd prefer it to be written to a separate file, set this option.

#

#GHE_VERBOSE_LOG="/var/log/backup-verbose.log"

# Any extra options passed to the SSH command.

# In a single instance environment, nothing is required by default.

# In a clustering environment, "-i abs-path-to-ssh-private-key" is required.

#

#GHE_EXTRA_SSH_OPTS=""

#

# All backup processes are ran with the lowest priority for scheduling by default.

# To change throttling behaviour/allow higher priority for backup processes, set higher values for following variables.

# default value for GHENICE=nice -n 19

# default value for GHE_IONICE=ionice -c 3

#GHE_NICE=""

#GHE_IONICE=""

# Any extra options passed to the rsync command. Nothing required by default.

#

#GHE_EXTRA_RSYNC_OPTS=""

# If set to 'yes', rsync will be set to use compression during backups and restores transfers. Defaults to 'no'.

#

#GHE_RSYNC_COMPRESSION_ENABLED=yes

# If enabled and set to 'no', rsync warning message during backups will be suppressed.

#RSYNC_WARNING=no

# If set to 'yes', logging output will be colorized.

#

#OUTPUT_COLOR=no

# If set to 'no', GHE_DATA_DIR will not be created automatically

# and restore/backup will exit 8

#

#GHE_CREATE_DATA_DIR=yes

# If set to 'yes', git fsck will run on the repositories

# and print some additional info.

#

# WARNING: do not enable this, only useful for debugging/development

#GHE_BACKUP_FSCK=no

# Cadence of MSSQL backups

# <full>,<differential>,<transactionlog> all in minutes

# e.g.

# - Full backup every week (10080 minutes)

# - Differential backup every day (1440 minutes)

# - Transactionlog backup every 15 minutes

#

#GHE_MSSQL_BACKUP_CADENCE=10080,1440,15

# If set to 'yes', ghe-backup jobs will run in parallel. Defaults to 'no'.

#

#GHE_PARALLEL_ENABLED=yes

# Sets the maximum number of jobs to run in parallel. Defaults to the number

# of available processing units on the machine.

#

#GHE_PARALLEL_MAX_JOBS=2

# Sets the maximum number of rsync jobs to run in parallel. Defaults to the

# configured GHE_PARALLEL_MAX_JOBS, or the number of available processing

# units on the machine.

#

# GHE_PARALLEL_RSYNC_MAX_JOBS=3

# When jobs are running in parallel wait as needed to avoid starting new jobs

# when the system's load average is not below the specified percentage. Defaults to

# unrestricted.

#

#GHE_PARALLEL_MAX_LOAD=50

# When running an external mysql database, run this script to trigger a MySQL backup

# rather than attempting to backup via backup-utils directly.

#EXTERNAL_DATABASE_BACKUP_SCRIPT="/bin/false"

# When running an external mysql database, run this script to trigger a MySQL restore

# rather than attempting to backup via backup-utils directly.

#EXTERNAL_DATABASE_RESTORE_SCRIPT="/bin/false"

# If set to 'yes', Pages data will be included in backup and restore. Defaults to 'yes'

#GHE_BACKUP_PAGES=no

# Elasticsearch backup strategy. Valid values: 'rsync' or 'snapshot'

# 'rsync' uses the traditional on-disk rsync method (default for backward compatibility)

# 'snapshot' uses native Elasticsearch snapshots stored in customer-managed cloud storage

#

# Requirements for snapshot strategy:

# - Configure the repository via ghe-config (for example, app.elasticsearch.backup.*)

# and apply it with ghe-config-apply on the appliance

# - Repository name format: search_index_snapshots-{version} (e.g., search_index_snapshots-3.19.1)

# - Supported storage types: S3 (repository-s3), Azure (repository-azure), Google Cloud Storage (repository-gcs)

# - Backup-utils stores only snapshot metadata locally; snapshot contents remain in the configured repository

#

#GHE_ES_BACKUP_STRATEGY=snapshot

# Snapshot naming prefix

#GHE_ES_SNAPSHOT_NAME_PREFIX=snapshot

# Elasticsearch snapshots always include cluster global state (templates, pipelines, data streams).

# This setting is not configurable.