This version of GitHub Enterprise will be discontinued on 2022-02-16. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Removing a high availability replica

You can stop replication to a GitHub Enterprise Server replica temporarily, or permanently remove replication.

Stopping replication temporarily

  1. If necessary, stop a geo-replication replica from serving user traffic by removing the Geo DNS entries for the replica.
  2. On the replica where you wish to temporarily stop replication, run ghe-repl-stop.
    $ ghe-repl-stop
  3. To start replication again, run ghe-repl-start.
    $ ghe-repl-start

Removing replication permanently

  1. If necessary, stop a geo-replication replica from serving user traffic by removing the Geo DNS entries for the replica.

  2. On the replica you wish to remove replication from, run ghe-repl-stop.

    $ ghe-repl-stop
  3. On the replica, to tear down the replication state, run ghe-repl-teardown.

    $ ghe-repl-teardown

    Note: If you have GitHub Actions enabled, you should decommission the former replica server or update its GitHub Actions configuration to use different external storage. For more information, see "High availability for GitHub Actions."

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.