Skip to content

Commit 891e81b

Browse files
mattpollardrachmarifelicitymaySarah Edwardsdavidjarzebowski
authored
[DO NOT MERGE] GitHub Enterprise Server 3.8 release candidate (github#34113)
Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Sarah Edwards <skedwards88@github.com> Co-authored-by: David Jarzebowski <davidjarzebowski@github.com> Co-authored-by: Steve Guntrip <stevecat@github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> Co-authored-by: docubot <67483024+docubot@users.noreply.github.com>
1 parent d7b52e7 commit 891e81b

124 files changed

Lines changed: 801820 additions & 352 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
68 KB
Loading
167 KB
Loading
120 KB
Loading
112 KB
Loading
106 KB
Loading
Binary file not shown.
-9.15 KB
Binary file not shown.
-13.1 KB
Binary file not shown.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: About the Management Console
3+
shortTitle: About
4+
intro: '{% data reusables.enterprise_site_admin_settings.management-console-overview %}'
5+
versions:
6+
ghes: '*'
7+
type: overview
8+
topics:
9+
- Administrator
10+
- Enterprise
11+
- Fundamentals
12+
- Networking
13+
- Monitoring
14+
---
15+
16+
## About the {% data variables.enterprise.management_console %}
17+
18+
The {% data variables.enterprise.management_console %} allows you to manage the low-level configuration of {% data variables.location.product_location %}. For example, you can complete initial setup, manage licensing and low-level settings, configure authentication, schedule maintenance windows, and monitor your instance.
19+
20+
You can always reach the {% data variables.enterprise.management_console %} using {% data variables.location.product_location %}'s IP address, even when the instance is in maintenance mode, or there is a critical application failure or hostname or SSL misconfiguration.
21+
22+
To access the {% data variables.enterprise.management_console %}, {% ifversion enterprise-management-console-multi-user-auth %}you can use the root site administrator password established during initial setup of {% data variables.location.product_location %} or log in as a {% data variables.enterprise.management_console %} user. For more information, see "[Accessing the {% data variables.enterprise.management_console %}](/admin/configuration/administering-your-instance-from-the-management-console/accessing-the-management-console)." {% else %}you must use the administrator password established during initial setup of {% data variables.location.product_location %}. {% endif %}You must also be able to connect to the virtual machine host on port 8443. If you're having trouble reaching the {% data variables.enterprise.management_console %}, please check intermediate firewall and security group configurations.
23+
24+
The {% data variables.enterprise.management_console %} password hash is stored in `/data/user/common/secrets.conf`. If high availability or clustering is configured, the file is automatically synced from the primary node to any additional nodes. Any change to the primary's password will automatically be replicated to all of the instance's nodes. For more information about high availability, see "[About high availability configuration](/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration)."
25+
26+
## Examples of activities in the {% data variables.enterprise.management_console %}
27+
28+
In the {% data variables.enterprise.management_console %}, you can perform administrative tasks for {% data variables.location.product_location %}, including:
29+
30+
- **Initial setup**: Walk through the initial setup process when first launching {% data variables.location.product_location %} by visiting {% data variables.location.product_location %}'s IP address in your browser.
31+
{%- ifversion enterprise-management-console-multi-user-auth %}
32+
- **Identity and access management**: Improve the security of {% data variables.location.product_location %} by creating dedicated user accounts for the {% data variables.enterprise.management_console %}. The root site administrator account can control these user accounts' access by assigning either the editor or operator role. For more information, see "[Managing access to the {% data variables.enterprise.management_console %}](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console)."
33+
{%- endif %}
34+
- **Configuring authentication policies for the {% data variables.enterprise.management_console %}**: Set rate limits for login attempts, and the lockout duration if someone exceeds the rate limit. For more information, see "[Managing access to the {% data variables.enterprise.management_console %}](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console#configuring-rate-limits-for-authentication-to-the-management-console)."
35+
- **Configuring basic settings for your instance**: Configure DNS, hostname, SSL, user authentication, email, monitoring services, and log forwarding on the Settings page.
36+
- **Scheduling maintenance windows**: Take {% data variables.location.product_location %} offline while performing maintenance using the {% data variables.enterprise.management_console %} or administrative shell.
37+
- **Troubleshooting**: Generate a support bundle or view high level diagnostic information.
38+
- **License management**: View or update your {% data variables.product.prodname_enterprise %} license.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Accessing the Management Console
3+
shortTitle: Access
4+
intro: 'You can access the {% data variables.enterprise.management_console %} {% ifversion ghes < 3.8 %}using the {% data variables.enterprise.management_console %} password{% elsif enterprise-management-console-multi-user-auth %}as the root site administrator or a {% data variables.enterprise.management_console %} user{% endif %}.'
5+
versions:
6+
ghes: '*'
7+
type: how_to
8+
topics:
9+
- Enterprise
10+
- Authentication
11+
---
12+
13+
{% data reusables.enterprise_site_admin_settings.management-console-access %}
14+
15+
## Accessing the {% data variables.enterprise.management_console %}
16+
17+
The first time that you access the {% data variables.enterprise.management_console %} for {% data variables.location.product_location %}, you must upload your license file. For more information, see "[Managing your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise)."
18+
19+
{% data reusables.enterprise_site_admin_settings.access-settings %}
20+
{% data reusables.enterprise_site_admin_settings.management-console %}
21+
{% data reusables.enterprise_management_console.type-management-console-password %}
22+
{% data reusables.enterprise_management_console.click-continue-authentication %}
23+
24+
## Accessing the {% data variables.enterprise.management_console %} as an unauthenticated user
25+
26+
1. Visit this URL in your browser, replacing `hostname` with your actual {% data variables.product.prodname_ghe_server %} hostname or IP address:
27+
```shell
28+
http(s)://HOSTNAME/setup
29+
```
30+
{% data reusables.enterprise_management_console.type-management-console-password %}
31+
{% data reusables.enterprise_management_console.click-continue-authentication %}

0 commit comments

Comments
 (0)