We provide a variety of utilities to help resolve particular problems or perform specific tasks. Below, you'll find a description of each utility that's available for you to use.
These commands can be executed from anywhere on the VM after signing in as an SSH admin user. You can find more information about enabling SSH access here.
top-like interface for current Git operations.
| --help | --usage ]
This utility sets a banner at the top of every GitHub Enterprise page. You can use it to broadcast a message to your users.
# Sets a message that's visible to everyone ghe-announce -s MESSAGE Announcement message set. # Removes a previously set message ghe-announce -u Removed the announcement message
This utility checks the disk for large files or files that have been deleted but still have open file handles. This should be run when you're trying to free up space on the root partition.
This utility cleans up a variety of caches that might potentially take up extra disk space on the root volume. If you find your root volume disk space usage increasing notably over time it would be a good idea to run this utility to see if it helps reduce overall usage.
This utility wipes all existing Management Console settings.
Tip: Typically, you will only execute this if you've contacted support and they've asked you to do so.
With this utility, you can both retrieve and modify the configuration settings of your GitHub Enterprise instance.
ghe-config core.github-hostname # Gets the configuration value of `core.github-hostname` ghe-config core.github-hostname 'example.com' # Sets the configuration value of `core.github-hostname` to `example.com` ghe-config -l # Lists all the configuration values
This utility applies Management Console settings, reloads system services, prepares a storage device, reloads application services, and runs any pending database migrations. It is equivalent to clicking Save settings in the Management Console's web UI or to sending a POST request to the
You will probably never need to run this manually, but it's available if you want to automate the process of saving your settings via SSH.
This utility opens the GitHub Rails console on your GitHub Enterprise appliance. Do not use this command without direction from GitHub Enterprise Support. Incorrect use could cause damage or data loss.
This utility opens a MySQL database session on your GitHub Enterprise appliance. Do not use this command without direction from GitHub Enterprise Support. Incorrect use could cause damage or data loss.
This utility performs a variety of checks and gathers information about your installation that you can send to support to help diagnose problems you're having. Currently, it does roughly the same thing browsing to
but may have additional improvements added to it over time that aren't available in the web UI.
ghe-migrator is a hi-fidelity tool to help you migrate from one GitHub instance to another. You can consolidate your instances or move your organization, users, teams, and repositories from GitHub.com to GitHub Enterprise.
For more information, please see our guide on migrating user, organization, and repository data.
This utility allows you to change to a repository's directory and open an interactive shell as the
git user. You can perform manual inspection or maintenance of a repository via commands like
This utility manually repackages a repository network to optimize pack storage. If you have a large repository, running this command may help reduce its overall size. GitHub Enterprise automatically runs this command throughout your interaction with a repository network.
You can add the optional
--prune argument to remove unreachable Git objects that aren't referenced from a branch, tag, or any other ref. This is particularly useful for immediately removing previously expunged sensitive information.
This utility lets you tail log all relevant log files from your installation. You can pass options in to limit the logs to specific sets. Use the -h flag for additional options.
This utility allows you to control the state of the installation's maintenance mode. It's designed to be used primarily by the Management Console behind-the-scenes, but it can be used directly.
This utility gives organization admin privileges to users with site admin privileges on the appliance. By default, it gives admin privileges to all site admins in all organizations. Optionally, to give these privileges to specific site admins, use the
Note that this utility only works on site admin accounts; you can promote an ordinary user account to a site admin with ghe-user-promote.
This utility displays information on background jobs, both active and in the queue. It provides the same job count numbers as the admin stats bar at the top of every page.
This utility can help identify whether the Resque server is having problems processing background jobs. Any of the following scenarios might be indicative of a problem with Resque:
- The number of background jobs is increasing, while the active jobs remain the same.
- The event feeds are not updating.
- Service hooks are not being triggered.
- The web interface is not updating after a Git push.
If you suspect Resque is failing, contact GitHub Enterprise Support for help.
With this command, you can also pause or resume jobs in the queue.
ghe-resque-info # lists queues and the number of currently queued jobs ghe-resque-info -p QUEUE # pauses the specified queue ghe-resque-info -r QUEUE # resumes the specified queue
This utility will roll your installation back to the fallback partition, restoring your root disk and reverting any migrations. If an upgrade fails, you can use this script to safely roll back to your previous version of GitHub Enterprise. However, you will still need to manually restore your data disk to a previous snapshot.
This utility lists all of the services that have been started or stopped (are running or waiting) on your appliance.
ghe-service-list start/running - github-resqued, process 12711 - github-unicorn, process 12726 - github-gitauth, process 12743 - git-daemon, process 12755 - babeld, process 12771 - github-svn-proxy, process 12802 - gist-unicorn, process 12832 - gist-resqued, process 12881 - render-unicorn, process 12939 - hookshot-unicorn, process 13076 - nodeload2, process 13192 - slumlord-unicorn, process 13304 - ghe-storage, process 2012 - enterprise-manage-unicorn, process 2024 - enterprise-manage-resque, process 2053 stop/waiting - gitmon
The service names returned from this command can be used with 'Upstart' commands to stop, start, or restart these services manually, if needed. For example:
sudo restart github-resqued
Stopping services will cause downtime on your installation, so we recommend you contact GitHub Enterprise Support before stopping or restarting any service.
ghe-set-password, you can set a new password to authenticate into the Management Console.
This utility allows you to install a custom root CA certificate on your GitHub Enterprise server. The certificate must be in PEM format. Furthermore, if your certificate provider includes multiple CA certificates in a single file, you must separate them into individual files that you then pass to
ghe-ssl-ca-certificate-install one at a time.
Run this utility when your Enterprise instance is unable to connect to another server because the latter is using a self-signed SSL certificate or an SSL certificate for which it doesn't provide the necessary CA bundle. One way to confirm this is to run
openssl s_client -connect host:port -verify 0 -CApath /etc/ssl/certs from your Enterprise instance. If the remote server's SSL certificate can be verified, your
SSL-Session should have a return code of 0, as shown below.
SSL-Session: Protocol : TLSv1 Cipher : AES128-SHA Session-ID: C794EBCC3CBC10F747C9AFC029C03C1048FC99CFC34D13D7444E0F267C58DF4C Session-ID-ctx: Master-Key: 02A7C47CFD6EEC87D3C710E9DD87390E04EF82DDD7514AE03127D5DC1945FC0CAEFB5395791AEA598667EFA61B9EA8C5 Key-Arg : None Start Time: 1394581597 Timeout : 300 (sec) Verify return code: 0 (ok)
If, on the other hand, the remote server's SSL certificate can not be verified, your
SSL-Session should have a nonzero return code:
SSL-Session: Protocol : TLSv1 Cipher : AES128-SHA Session-ID: 82CB288051A6DB66094C50A69CF1292AEE7E54C6B01B659B98AB336F8C33863E Session-ID-ctx: Master-Key: 01B025B2F764043A27919A8D1355AAECD8844FF0831B1D664042334790574A6F4025BAB085D4ED71D71AAB3091B849E5 Key-Arg : None Start Time: 1394581782 Timeout : 300 (sec) Verify return code: 27 (certificate not trusted)
You can use these additional options with the utility:
-rflag allows you to uninstall a CA certificate.
-hflag displays more usage information.
ghe-ssl-ca-certificate-install -c /path/to/certificate
Some platforms require this script to expand the user volume. For more information, see "Increasing Storage Capacity".
This utility creates a support bundle tarball containing important logs from your instance.
By default, the command creates the tarball in /tmp, but you can also have it
cat the tarball to
STDOUT for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from /setup/support doesn't work. You must use this command if you want to generate an extended bundle, containing older logs. You can also use this command to upload the support bundle directly to GitHub Enterprise support.
ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz
ssh -p 122 admin@hostname -- 'ghe-support-bundle -x -o' > support-bundle.tgz
Sending a bundle to support
ssh -p 122 admin@hostname -- 'ghe-support-bundle -u'
Sending a bundle to support and associating it with a ticket
ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-id'
This utility dumps out a list of all the users in the installation into CSV format. The CSV file includes the email address, which type of user they are (e.g., admin, user), how many repositories they have, how many SSH keys, how many organization memberships, last logged IP address, etc. Use the
-h flag for more options.
ghe-user-csv -o > users.csv
This utility promotes the specified user account to a site administrator.
This utility demotes the specified user from admin status to that of a regular user. We recommend using the web UI to perform this action, but provide this utility in case the
ghe-user-promote utility is run in error and you need to demote a user again from the CLI.
This utility suspends the specified user, preventing them from logging in, pushing, or pulling from your repositories.
This utility unsuspends the specified user, granting them access to login, push, and pull from your repositories.
This utility checks the existing SSH host keys against the list of known leaked SSH host keys.
If a leaked host key is found the utility exits with status
1 and a message:
One or more of your SSH host keys were found in the blacklist. Please reset your host keys using ghe-ssh-roll-host-keys.
If a leaked host key was not found, the utility exits with status
0 and a message:
The SSH host keys were not found in the SSH host key blacklist. No additional steps are needed/recommended at this time.
This utility rolls the SSH host keys and replaces them with newly generated keys.
sudo ghe-ssh-roll-host-keys Proceed with rolling SSH host keys? This will delete the existing keys in /etc/ssh/ssh_host_* and generate new ones. [y/N] # Press 'Y' to confirm deleting, or use the -y switch to bypass this prompt SSH host keys have successfully been rolled.