Skip to content

Commit ab44008

Browse files
release-controller[bot]release-controller[bot]
authored andcommitted
3.18.4 release
1 parent 881b172 commit ab44008

2 files changed

Lines changed: 1 addition & 28 deletions

File tree

README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
# GitHub Enterprise Server Backup Utilities
22

3-
> [!IMPORTANT]
4-
> Did you mean: [Backup Service](https://github.com/github/ghes-backup-utils)?
5-
>
6-
> - `backup-utils` is the older backup solution for GHES. It provides a set of tools for a customer to copy data from their GHES appliance to an unrelated machine over SSH. These tools are not run on the appliance, but on the remote machine.
7-
> - `backup-service` is the newer solution. It is a service that runs on the GHES appliance itself and backs up data to a disk mounted at `/data/backup`.
8-
>
9-
> `backup-service` becomes GA in GHES 3.20 and is the preferred solution for backups. `backup-utils` will be deprecated in GHES 3.22.
10-
113
This repository includes backup and recovery utilities for
124
[GitHub Enterprise Server][1].
135

docs/backup.config-example

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ GHE_NUM_SNAPSHOTS=10
117117
#GHE_PARALLEL_MAX_JOBS=2
118118

119119
# Sets the maximum number of rsync jobs to run in parallel. Defaults to the
120-
# configured GHE_PARALLEL_MAX_JOBS, or the number of available processing
120+
# configured GHE_PARALLEL_MAX_JOBS, or the number of available processing
121121
# units on the machine.
122122
#
123123
# GHE_PARALLEL_RSYNC_MAX_JOBS=3
@@ -138,22 +138,3 @@ GHE_NUM_SNAPSHOTS=10
138138

139139
# If set to 'yes', Pages data will be included in backup and restore. Defaults to 'yes'
140140
#GHE_BACKUP_PAGES=no
141-
142-
# Elasticsearch backup strategy. Valid values: 'rsync' or 'snapshot'
143-
# 'rsync' uses the traditional on-disk rsync method (default for backward compatibility)
144-
# 'snapshot' uses native Elasticsearch snapshots stored in customer-managed cloud storage
145-
#
146-
# Requirements for snapshot strategy:
147-
# - Configure the repository via ghe-config (for example, app.elasticsearch.backup.*)
148-
# and apply it with ghe-config-apply on the appliance
149-
# - Repository name format: search_index_snapshots-{version} (e.g., search_index_snapshots-3.19.1)
150-
# - Supported storage types: S3 (repository-s3), Azure (repository-azure), Google Cloud Storage (repository-gcs)
151-
# - Backup-utils stores only snapshot metadata locally; snapshot contents remain in the configured repository
152-
#
153-
#GHE_ES_BACKUP_STRATEGY=snapshot
154-
155-
# Snapshot naming prefix
156-
#GHE_ES_SNAPSHOT_NAME_PREFIX=snapshot
157-
158-
# Elasticsearch snapshots always include cluster global state (templates, pipelines, data streams).
159-
# This setting is not configurable.

0 commit comments

Comments
 (0)