Skip to content

Commit 69dd222

Browse files
Add section on configuring backups from replica node (#58696)
Co-authored-by: Sam Browning <[email protected]>
1 parent 41f47d5 commit 69dd222

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ If you're migrating from {% data variables.product.prodname_enterprise_backup_ut
125125

126126
Use the `--dry-run` flag to preview changes without applying them.
127127

128-
### Scheduling automated backups
128+
#### Scheduling automated backups
129129

130130
Once the service is configured, you can define a backup schedule.
131131

@@ -134,3 +134,27 @@ Once the service is configured, you can define a backup schedule.
134134
1. Click **Save** to apply the changes.
135135

136136
The first run will be a full backup. Future runs will be incremental. If a new backup attempt starts while a previous one is still running, it may be skipped or fail. In that case, adjust the schedule to avoid overlap.
137+
138+
{% ifversion ghes > 3.19 %}
139+
140+
### Configuring backups from a replica node
141+
142+
For high availability, you can designate a replica node as your backup server. To minimize latency, {% data variables.product.github %} recommends picking a replica node in the same region or datacenter as your primary node.
143+
144+
> [!IMPORTANT]
145+
> Backups from cache replica nodes or active geo replica nodes are not supported.
146+
147+
To configure your backup server, run the following commands, replacing `HOSTNAME` with the hostname of the node:
148+
149+
```shell
150+
ghe-config cluster.HOSTNAME.backup-server true
151+
152+
ghe-config-apply
153+
```
154+
155+
You can now run `ghe-backup` directly on your replica node.
156+
157+
> [!WARNING]
158+
> Due to the latency between primary and replica nodes, you may lose data when backing up from a replica node.
159+
160+
{% endif %}

0 commit comments

Comments
 (0)