Use the Management Console to set up and configure your GitHub Enterprise instance, schedule maintenance windows, troubleshoot issues, and manage your license.

In this article:

About the Management Console

Use the Management Console for basic administrative activities:

  • Initial setup: When first launching your GitHub Enterprise instance, visiting your GitHub Enterprise instance's IP address in your browser will walk you through the initial setup process.
  • Configuring basic settings for your instance: You can configure DNS, hostname, SSL, user authentication, email, monitoring services, and log forwarding on the Settings page.
  • Scheduling maintenance windows: You can take your GitHub Enterprise instance offline while performing maintenance using the Management Console or administrative shell.
  • Troubleshooting: Generate a support bundle or view high level diagnostic information.
  • License management: View or update your GitHub Enterprise license.

You can always reach the Management Console using your GitHub Enterprise instance's IP address, even when the instance is in maintenance mode, or there is a critical application failure or hostname/SSL misconfiguration.

To access the Management Console, you must use the administrator password established during initial setup of your GitHub Enterprise instance. You must also be able to connect to the virtual machine host on port 8443. If you're having trouble reaching the Management Console, please check intermediate firewall and security group configurations.

Accessing the Management Console as a site administrator

The first time that you access the Management Console as a site administrator, you must upload your GitHub Enterprise license file to authenticate into the app. For more information, see "License files."

  1. In the upper-right corner of any page, click . Rocketship icon for accessing site admin settings

  2. In the left sidebar, click Management Console. Management Console tab in the left sidebar

  3. If prompted, type your Management Console password. Management Console unlock screen

Accessing the Management Console as an unauthenticated user

  1. Visit this URL in your browser, replacing hostname with your actual GitHub Enterprise hostname or IP address:

  2. If prompted, type your Management Console password. Management Console unlock screen

Unlocking the Management Console after failed login attempts

The Management Console is locked after ten failed login attempts in the span of ten minutes. Once locked, the login screen will automatically unlock when fewer than ten failed login attempts are made during the previous ten minute period. Once a successful login occurs, the counter is reset.

To immediately unlock the Management Console, use the ghe-reactivate-admin-login command via the administrative shell. For more information, see "Command line utilities" and "Accessing the administrative shell (SSH)."