docs/content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/backup-service-settings-reference.md at main

mirror of synced 2025-12-19 18:10:59 -05:00

Files

Sophie 0f3cc6e990 GitHub Enterprise Server 3.17 release candidate (#55411 )

Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com>
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
Co-authored-by: Pallavi <96553709+pallsama@users.noreply.github.com>
Co-authored-by: Stephanie Sabota <80356791+steph-sabotasan@users.noreply.github.com>
Co-authored-by: Casey Tucker <dctucker@github.com>
Co-authored-by: Hao Jiang <45571951+jianghao0718@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>

2025-05-15 16:32:44 +00:00

1.8 KiB

Raw Permalink Blame History

title, shortTitle, intro, versions, type, topics

title

shortTitle

intro

versions

type

topics

Backup service settings reference

Backup settings

Reference for all configurable options available in the Backup Service section of the {% data variables.enterprise.management_console %}.

ghes
>= 3.17

reference

Backups

You can configure the following options in the "Backup Service" section of the {% data variables.enterprise.management_console %}.

Snapshot retention

Number of snapshots: Sets how many backup snapshots to retain (default: 10). Older snapshots are automatically pruned after each successful backup.

Restore options

Skip audit logs restore: Excludes audit logs during a restore.
Restore Management Console password: If enabled, restores the root site admin password from snapshot data (default: true).

Performance tuning

Process priority:
- Nice: Sets the CPU scheduling priority (nice -n 19 by default).
- Ionice: Sets the I/O scheduling priority (ionice -c 3 by default).
Rsync compression: Uses compression for rsync transfers during backup and restore, reducing bandwidth usage.

MSSQL backup schedule

MSSQL backup cadence: Sets the schedule for full, differential, and transaction log backups, in minutes (default: 10080,1440,15).

Backup content

Include Pages: Adds {% data variables.product.prodname_pages %} data to snapshots.
Skip search indices: Excludes search index data from snapshots.

Parallelization settings

Enable parallel jobs: Allows multiple backup jobs to run concurrently.
Max jobs: Limits the total number of parallel backup jobs.
Max rsync jobs: Limits the number of parallel rsync jobs.
Max system load: Sets a load limit to throttle parallel processing when needed.

1.8 KiB Raw Permalink Blame History