text stringlengths 12 91.7k | metadata dict |
|---|---|
About unauthenticated sign-ups
You can disable unauthenticated sign-ups and require an invitation to create a new user account on your instance.
Disabling unauthenticated sign-ups
1. Deselect Enable sign-up. | {
"source": "github-docs/admin/managing-iam/using-built-in-authentication/disabling-unauthenticated-sign-ups.md",
"title": "Disabling unauthenticated sign-ups"
} |
About invitations for new users
You can disable unauthenticated sign-ups and require an invitation to create a new user account on your instance. For more information, see AUTOTITLE.
Inviting people to create a user account
If you've configured email for notifications on , your instance will send the invitation to the... | {
"source": "github-docs/admin/managing-iam/using-built-in-authentication/inviting-people-to-use-your-instance.md",
"title": "Inviting people to use your instance"
} |
About CAS authentication for
CAS is a single sign-on (SSO) protocol that centralizes authentication to multiple web applications. For more information, see Central Authentication Service on Wikipedia.
After you configure CAS, people who use must use a to authenticate API or Git requests over HTTP(S). CAS credentials... | {
"source": "github-docs/admin/managing-iam/using-cas-for-enterprise-iam/using-cas.md",
"title": "Using CAS"
} |
About LDAP authentication for
LDAP is a popular application protocol for access and maintenance of directory information services, and is one of the most common protocols for integration of third-party software with large company user directories. For more information, see Lightweight Directory Access Protocol on Wiki... | {
"source": "github-docs/admin/managing-iam/using-ldap-for-enterprise-iam/using-ldap.md",
"title": "Using LDAP"
} |
About SAML with Okta
You can control access to your enterprise account in and other web applications from one central interface by configuring the enterprise account to use SAML SSO with Okta, an Identity Provider (IdP).
SAML SSO controls and secures access to enterprise account resources like organizations, repositor... | {
"source": "github-docs/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise-using-okta.md",
"title": "Configuring SAML single sign-on for your enterprise using Okta"
} |
Before following the steps in this article, make sure that your enterprise uses personal accounts. You can do so by checking whether your enterprise view has the "Users managed by ACCOUNT NAME" header bar at the top of the screen.
If you see this, your enterprise uses managed users and you must follow a different proce... | {
"source": "github-docs/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md",
"title": "Configuring SAML single sign-on for your enterprise"
} |
For more information, see AUTOTITLE.
If you decide to use SAML instead of , you must choose whether to configure SAML at the enterprise level or the organization level.
If some groups within your enterprise must use different SAML authentication providers to grant access to your resources on , configure SAML for indivi... | {
"source": "github-docs/admin/managing-iam/using-saml-for-enterprise-iam/deciding-whether-to-configure-saml-for-your-enterprise-or-your-organizations.md",
"title": "Deciding whether to configure SAML for your enterprise or your organizations"
} |
About disabled SAML SSO for your enterprise
After you disable SAML SSO for your enterprise, the following effects apply:
All external identities for your enterprise will be removed. For more information, see AUTOTITLE.
Any SAML settings configured for individual organizations within the enterprise will take effect. F... | {
"source": "github-docs/admin/managing-iam/using-saml-for-enterprise-iam/disabling-saml-single-sign-on-for-your-enterprise.md",
"title": "Disabling SAML single sign-on for your enterprise"
} |
About encrypted assertions
If your IdP support encryption of assertions, you can configure encrypted assertions on for increased security during the authentication process.
Prerequisites
To enable encrypted assertions for authentication to , you must configure SAML authentication, and your IdP must support encrypted ... | {
"source": "github-docs/admin/managing-iam/using-saml-for-enterprise-iam/enabling-encrypted-assertions.md",
"title": "Enabling encrypted assertions"
} |
About team synchronization for enterprise accounts
If you use SAML at the enterprise level with Entra ID as your IdP, you can enable team synchronization for your enterprise account to allow organization owners and team maintainers to synchronize teams in the organizations owned by your enterprise accounts with IdP gro... | {
"source": "github-docs/admin/managing-iam/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise.md",
"title": "Managing team synchronization for organizations in your enterprise"
} |
About SAML single sign-on for enterprise accounts
When you configure SAML SSO at the organization level, each organization must be configured with a unique SSO tenant in your IdP, which means that your members will be associated with a unique SAML identity record for each organization they have successfully authenticat... | {
"source": "github-docs/admin/managing-iam/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account.md",
"title": "Switching your SAML configuration from an organization to an enterprise account"
} |
About problems with SAML authentication
logs error messages for failed SAML authentication in the systemd journal logs for the github-unicorn container. You can review responses in this log, and you can also configure more verbose logging.
For more information about SAML response requirements, see AUTOTITLE.
Configur... | {
"source": "github-docs/admin/managing-iam/using-saml-for-enterprise-iam/troubleshooting-saml-authentication.md",
"title": "Troubleshooting SAML authentication"
} |
About updates to users' SAML NameID
In some situations, you may need to update values associated with a person's account on your SAML IdP. If that identifier is also the NameID that you use for authentication on , you must update the NameID mapping on your instance so the person can continue to authenticate successfull... | {
"source": "github-docs/admin/managing-iam/using-saml-for-enterprise-iam/updating-a-users-saml-nameid.md",
"title": "Updating a user's SAML NameID"
} |
About changes to enterprise slugs
When you create an enterprise, you choose a "slug" for the enterprise, which is a string used in the URL for your enterprise. For example, if you chose octo-enterprise as the slug, the URL for your enterprise on would be https://github.com/enterprises/octo-enterprise.
If your company ... | {
"source": "github-docs/admin/managing-your-enterprise-account/changing-the-url-for-your-enterprise.md",
"title": "Changing the URL for your enterprise"
} |
About user display names for enterprises
A user display name controls how enterprise members are shown across . When the feature is enabled, a member’s profile name (first and last name) appears alongside their username in places like repositories, issues, pull requests, and . The setting applies to public, private, an... | {
"source": "github-docs/admin/managing-your-enterprise-account/configuring-user-display-names-for-your-enterprise.md",
"title": "Configuring user display names for your enterprise"
} |
About READMEs for enterprises
The README is displayed on the enterprise's "Overview" page, which is the landing page you see when you navigate to the enterprise. This page is only visible to members of the enterprise.
You can also create READMEs for organizations in your enterprise, visible either publicly or only to m... | {
"source": "github-docs/admin/managing-your-enterprise-account/creating-a-readme-for-an-enterprise.md",
"title": "Creating a README for an enterprise"
} |
<!-- expires 2027-01-30 --
<!-- When this expires, check with the stakeholder for release 4079 on whether or not the content is still needed. See https://github.com/github/releases/issues/4079issuecomment-3954280272 for context. If the content is no longer needed, delete this entire article and all links to it. --
<!--... | {
"source": "github-docs/admin/managing-your-enterprise-account/creating-an-enterprise-account.md",
"title": "Creating an enterprise account"
} |
Prerequisites
Before you can delete an enterprise account, you must remove, transfer, or delete all organizations in the enterprise. For more information, see AUTOTITLE and AUTOTITLE.
After removing organizations, check the "People" tab in your enterprise settings and remove any unaffiliated members who remain in the e... | {
"source": "github-docs/admin/managing-your-enterprise-account/deleting-an-enterprise-account.md",
"title": "Deleting an enterprise account"
} |
About the benefits of
can help you anticipate the needs of your organization, understand how your team works, and show the value you get from .
Once enabled, collects aggregate data on how much certain features are used on your instance over time. Unlike other Admin Stats API endpoints, which only return data for th... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md",
"title": "About Server Statistics"
} |
You can download up to the last 365 days of data in a CSV or JSON file. This data, which includes aggregate metrics on repositories, issues, and pull requests, can help you anticipate the needs of your organization, understand how your team works, and show the value you get from .
Before you can download this data, yo... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/exporting-server-statistics.md",
"title": "Exporting Server Statistics"
} |
You can request up to 365 days of metrics in a single REST API request. This data, which includes aggregate metrics on repositories, issues, and pull requests, can help you anticipate the needs of your organization, understand how your team works, and show the value you get from . For a list of the metrics collected, ... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md",
"title": "Requesting Server Statistics using the REST API"
} |
About reports for
If you need to get information about the users, organizations, and repositories on , you can fetch data using the REST API. For more information, see AUTOTITLE.
The REST API might not provide all of the data that you want, and requires some technical expertise to use. Alternatively, you can reports c... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/accessing-reports-for-your-instance.md",
"title": "Accessing reports for your instance"
} |
Key Description
-----------------: ------------------------------------------------------------
createdat When the user account was created (as an ISO 8601 timestamp)
id Account ID for the user or organization
login Account's login name
email Account's primary em... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/accessing-reports-for-your-instance.md",
"title": "Accessing reports for your instance"
} |
Key Description
---------------: ------------------------------------------------------------
createdat When the repository was created
ownerid ID of the repository's owner
ownertype Whether the repository is owned by a user or an organization
ownername Name of the repository's owner
id ... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/accessing-reports-for-your-instance.md",
"title": "Accessing reports for your instance"
} |
About log forwarding
Forwarding logs to an external receiver allows your organization to centralize log management and retention, providing the data needed for monitoring system activity, detecting anomalies, and integrating with existing security and analytics tools.
Any log collection system that supports syslog-styl... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/log-forwarding.md",
"title": "Log forwarding"
} |
About global webhooks
You can use global webhooks to notify an external web server when events occur within your enterprise. You can configure the server to receive the webhook's payload, then run an application or code that monitors, responds to, or enforces rules for user and organization management for your enterpri... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/managing-global-webhooks.md",
"title": "Managing global webhooks"
} |
Push log entries show:
Who initiated the push
Whether it was a force push or not
The branch someone pushed to
The protocol used to push
The originating IP address
The Git client used to push
The SHA hashes from before and after the operation
For more information, see AUTOTITLE.
Viewing a repository's push logs
... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/viewing-push-logs.md",
"title": "Viewing push logs"
} |
[!NOTE] This article lists events that may appear in the audit log for an enterprise. For the events that can appear in a user account's security log or the audit log for an organization, see AUTOTITLE and AUTOTITLE.
What types of events are included?
Without , the audit log only includes events related to the enterp... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md",
"title": "Audit log events for your enterprise"
} |
About audit log configuration
You can configure a retention period for audit log data and see index storage details.
After you configure a retention period, you can enable or disable Git-related events from appearing in the audit log.
Configuring a retention period for audit log data
You can configure a retention peri... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md",
"title": "Configuring the audit log for your enterprise"
} |
About display of IP addresses in the audit log
By default, does not display the source IP address for events in your enterprise's audit log.
You are responsible for meeting any legal obligations that accompany the viewing or storage of IP addresses displayed within your enterprise's audit log.
If you choose to displa... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md",
"title": "Displaying IP addresses in the audit log for your enterprise"
} |
About exports of audit log and Git events data
You can export the audit log by downloading a JSON or CSV file from your enterprise on . When you export audit log events, you can query by one or more of these supported qualifiers to filter for specific log events to export. See AUTOTITLE.
The audit log lists events trig... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/exporting-audit-log-activity-for-your-enterprise.md",
"title": "Exporting audit log activity for your enterprise"
} |
About token data in the audit log for an enterprise
Your enterprise's audit log contains an event for each action that a user or integration performs. If the action occurred outside of 's web UI, the event's data will show details about how the user or integration authenticated.
Token data in audit log events
Identif... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/identifying-audit-log-events-performed-by-an-access-token.md",
"title": "Identifying audit log events performed by an access token"
} |
About search for the enterprise audit log
You can search your enterprise audit log directly from the user interface by using the Filters dropdown, or by typing a search query.
For more information about viewing your enterprise audit log, see AUTOTITLE.
You can also use the API to retrieve audit log events. For more inf... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise.md",
"title": "Searching the audit log for your enterprise"
} |
[!NOTE]
About audit log streaming
You can help protect intellectual property and maintain compliance for your company by using streaming to keep copies of your audit log data. The audit log details events such as changes to settings and access, user membership, app permissions, and more. See AUTOTITLE, AUTOTITLE, and... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md",
"title": "Streaming the audit log for your enterprise"
} |
[!NOTE]
Maintain compliance and secure intellectual property with endpoints relating to the audit log. See AUTOTITLE and AUTOTITLE.
For more information about the specific events that you can access via the audit log endpoints, see the following articles.
AUTOTITLE
AUTOTITLE
AUTOTITLE
Audit log details
Timestamps ... | {
"source": "github-docs/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md",
"title": "Using the audit log API for your enterprise"
} |
[!NOTE]
Support for additional nodes in a high availability configuration is currently in and subject to change.
For customers looking to scale horizontally, migrating to and operating a cluster is an option, but is resource-intensive and time-consuming. As an alternative, we recommend adding nodes to an HA configur... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/additional-nodes/configuring-additional-nodes.md",
"title": "Adding nodes to a high availability configuration"
} |
If you have teams and CI farms located around the world, you may experience reduced performance on your primary instance. While active geo-replicas can improve the performance of read requests, this comes at the cost of limiting write throughput. To reduce load on your primary instance and improve write throughput per... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/caching-repositories/about-repository-caching.md",
"title": "About repository caching"
} |
About configuration for repository caching
Then, you can set data location policies that govern which repository networks are replicated to the repository cache.
Repository caching is not supported with clustering.
DNS for repository caches
The primary instance and repository cache should have different DNS names. Fo... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/caching-repositories/configuring-a-repository-cache.md",
"title": "Configuring a repository cache"
} |
About cluster nodes
Each node in a cluster is a virtual machine (VM) that runs the software. Before you deploy a cluster, you can review hardware requirements, required services, and design recommendations.
Hardware requirements
Each node must have a root volume, as well as a separate data volume. These are minimum... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/about-cluster-nodes.md",
"title": "About cluster nodes"
} |
About clustering for
The cluster topology for provides horizontal scaling for companies with tens of thousands of developers. recommends clustering if a single primary node would routinely experience resource exhaustion.
In a cluster, the instance provides services and distributes data across multiple virtual machin... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/about-clustering.md",
"title": "About clustering"
} |
About networking for a cluster
Each node in your cluster must be able to communicate with all of the other nodes in the cluster over the network. You can review the required ports and protocols for end users, administration, and communication between nodes. To distribute traffic among front-end nodes, recommends tha... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/cluster-network-configuration.md",
"title": "Cluster network configuration"
} |
About high availability replication for clusters
You can provide protection against disruption in a datacenter or cloud region by configuring a cluster deployment of for high availability. In a high availability configuration, an identical set of replica nodes sync with the nodes in your active cluster. If hardware or... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/configuring-high-availability-replication-for-a-cluster.md",
"title": "Configuring high availability replication for a cluster"
} |
About deferring database seeding of a MySQL replica node
[!NOTE]
The ability to defer database seeding is available as a .
Adding a new MySQL replica node to your cluster when your primary node has more than seven days of data will normally trigger database seeding which can take several hours depending on the amount o... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/deferring-database-seeding.md",
"title": "Deferring database seeding"
} |
About deployment topologies for
You can deploy the virtual machines for a instance in different topologies depending on your environment and user needs.
To support a plan for disaster recovery and supplement backups, or to improve network and write performance for geographically distributed users, you can configure ... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/differences-between-clustering-and-high-availability-ha.md",
"title": "Differences between clustering and high availability (HA)"
} |
About initialization of a cluster
To deploy a cluster in your environment, you must install , upload a cluster-enabled license, configure the first node, and initialize the node with a configuration file.
Installing
To start setting up the cluster, install the appliance on each node's virtual machine (VM), then co... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/initializing-the-cluster.md",
"title": "Initializing the cluster"
} |
About failover to your replica cluster
If the data center for your active cluster experiences a failure and you've configured high availability, you can fail over to your replica cluster.
Failing over to your replica cluster promotes it to be your new active cluster, and decouples the new active cluster from the old ac... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/initiating-a-failover-to-your-replica-cluster.md",
"title": "Initiating a failover to your replica cluster"
} |
[!IMPORTANT]
is closing down and will be removed in 3.23. There is no replacement. If you have enabled , you can disable it at any time by running ghe-config app.nes.enabled false, followed by ghe-config-apply.
About
In a cluster, an individual node may become unreachable by other nodes due to a hardware or softw... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/monitoring-the-health-of-your-cluster-nodes-with-node-eligibility-service.md",
"title": "Monitoring the health of your cluster nodes with Node Eligibility Service"
} |
About cluster health
A cluster comprises multiple nodes, with redundant services distributed across two or more nodes. If an individual service or an entire node fails, users should not notice. Failures affect performance and redundancy, so it's important to monitor the health of your cluster. You can monitor the hea... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/monitoring-the-health-of-your-cluster.md",
"title": "Monitoring the health of your cluster"
} |
About workload balance for a cluster
A instance in a cluster configuration assigns each task to a node according to the node's role. This assignment is called an allocation.
If a cluster node is unreachable by other nodes due to a hardware or software failure, your instance creates a new allocation to distribute jobs... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/rebalancing-cluster-workloads.md",
"title": "Rebalancing cluster workloads"
} |
About replacement of cluster nodes
You can replace a functional node in a cluster, or you can replace a node that has failed unexpectedly.
After you replace a node, does not automatically distribute jobs to the new node. You can force your instance to balance jobs across nodes. For more information, see AUTOTITLE.
... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/replacing-a-cluster-node.md",
"title": "Replacing a cluster node"
} |
About upgrades to a cluster
Upgrading with a hotpatch
The hotpatch installation script installs the hotpatch on every node in the cluster and restarts the services in their proper sequence to avoid downtime.
1. Back up your data with .
1. From the administrative shell of any node, use the ghe-cluster-hotpatch comman... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-clustering/upgrading-a-cluster.md",
"title": "Upgrading a cluster"
} |
Multiple active replicas can provide a shorter distance to the nearest replica. For example, an organization with offices in San Francisco, New York, and London could run the primary appliance in a datacenter near New York and two replicas in datacenters near San Francisco and London. Using geolocation-aware DNS, users... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-high-availability/about-geo-replication.md",
"title": "About geo-replication"
} |
When you configure high availability, there is an automated setup of one-way, asynchronous replication of all datastores (Git repositories, MySQL, Redis, and Elasticsearch) from the primary to the replica appliance. Most configuration settings are also replicated, including the password. For more information, see AUT... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-high-availability/about-high-availability-configuration.md",
"title": "About high availability configuration"
} |
Replica types and capabilities
What are the different types of replicas used in a HA deployment?
There are three types of replicas in a high-availability (HA) deployment:
Passive replicas
Active replica
Cache replicas (known as repository caches).
Passive replicas simply sync data from the primary instance and don'... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-high-availability/answers-to-common-questions-about-high-availability-replicas.md",
"title": "Answers to common questions about high availability replicas"
} |
Creating a high availability replica
1. Set up a new appliance on your desired platform. The replica appliance should mirror the primary appliance's CPU, RAM, and storage settings. We recommend that you install the replica appliance in an independent environment. The underlying hardware, software, and network componen... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-high-availability/creating-a-high-availability-replica.md",
"title": "Creating a high availability replica"
} |
About Elasticsearch Cross-Cluster Replication
uses Elasticsearch to power search across issues, pull requests, repositories, the projects and releases pages, and the counts shown throughout the web interface. Because search is central to the product, the reliability of Elasticsearch directly affects the day-to-day adm... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-high-availability/elasticsearch-cross-cluster-replication.md",
"title": "Configuring Elasticsearch Cross-Cluster Replication for high availability"
} |
The time required to failover depends on how long it takes to manually promote the replica and redirect traffic. The average time ranges between 20-30 minutes.
1. If the primary appliance is available, to allow replication to finish before you switch appliances, on the primary appliance, put the primary appliance into ... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md",
"title": "Initiating a failover to your replica appliance"
} |
About observability for high availability
For more information, see AUTOTITLE.
After you configure high availability, you can proactively ensure redundancy by monitoring the overall health of replication and the status of each of your instance's replica nodes. You can use command-line utilities on the instance, an ove... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-high-availability/monitoring-a-high-availability-configuration.md",
"title": "Monitoring a high-availability configuration"
} |
About recovery for a high availability configuration
You can use the former primary appliance as the new replica appliance if the failover was planned or was not related to the health of the appliance. If the failover was related to an issue with the primary appliance, you may prefer to create a new replica appliance. ... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-high-availability/recovering-a-high-availability-configuration.md",
"title": "Recovering a high availability configuration"
} |
Stopping replication temporarily
1. If necessary, stop a geo-replication replica from serving user traffic by removing the Geo DNS entries for the replica.
1. On the replica where you wish to temporarily stop replication, run ghe-repl-stop.
shell
ghe-repl-stop
1. To start replication again, run ghe-repl-start.
... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/configuring-high-availability/removing-a-high-availability-replica.md",
"title": "Removing a high availability replica"
} |
Metrics
OpenTelemetry metrics were introduced in 3.18 and are the future foundation for monitoring your instance.
Collectd metrics will continue to be gathered by default, but we expect collectd metrics to be discontinued in a future release.provide monitoring capabilities for your instance.
For more information ab... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-monitoring-your-instance.md",
"title": "About monitoring your instance"
} |
About support bundles
A support bundle is a compressed archive of diagnostic data from your instance. You can use support bundles to work with on issues and to generate Health Check reports that summarize your instance's configuration, health, and activity.
<!-- expires 2026-08-18 --
[!IMPORTANT]
Beginning August 1... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-support-bundles.md",
"title": "About support bundles for GitHub Enterprise Server"
} |
About system logs for
To trace, review, and troubleshoot activity and exceptions on , you can review system logs. Your instance stores the following two types of system logs.
Plain text log files on disk, stored by syslog or specific services
Binary log files, stored by journald
By default, rotates system logs auto... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs.md",
"title": "About system logs"
} |
Accessing the monitor dashboards
1. In the top navigation bar, click Monitor.
!Screenshot of the header of the . A tab, labeled "Monitor", is highlighted with an orange outline.
1. In HA and cluster environments you can switch between nodes using the dropdown and clicking on a different hostname.
Using the monitor ... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards.md",
"title": "About the monitor dashboards"
} |
About Governor
Governor is a built-in monitor for Git activity on your instance. Use the ghe-governor command to see which repositories, users, IP addresses, and Git operations are creating load.
Use this data when CPU, memory, or disk usage increases and you need to confirm whether Git traffic is the cause. For comman... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/analyze-git-traffic.md",
"title": "Analyzing Git traffic on your {% data variables.product.prodname_ghe_server %} instance"
} |
About collectd metrics
Collectd is a daemon that collects system performance statistics periodically and stores them in a variety of ways. For , collectd gathers metrics from various system components and services, providing insight into system health and performance.
Key components
The collectd monitoring stack inclu... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/about-collectd-metrics.md",
"title": "About Collectd metrics"
} |
About collectd metrics
By default, collectd on gathers metrics related to the instance's performance.
You can learn more about the type of data that collectd gathers, and you can download a CSV file that contains a full list of metrics.
Metrics gathered by collectd plugins
Plugins provide metrics to collectd. You can... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/collectd-metrics-for-github-enterprise-server.md",
"title": "collectd metrics for GitHub Enterprise Server"
} |
includes a Prometheus metrics exporter to simplify observability and monitoring. This feature allows metrics to be scraped directly from the appliance, eliminating the need to forward collectd metrics to an external collectd server for transformation before sending them to a Prometheus system. By supporting Prometheus-... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/exporting-and-scraping-prometheus-metrics.md",
"title": "Exporting and scraping Prometheus metrics"
} |
Set up an external collectd server
If you haven't already set up an external collectd server, you will need to do so before enabling collectd forwarding on . Your collectd server must be running collectd version 5.x or higher.
1. Log into your collectd server.
1. Create or edit the collectd configuration file to load t... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/collectd-metrics/setting-up-external-monitoring-with-collectd.md",
"title": "Setting up external monitoring with collectd"
} |
[!NOTE]
Generating a Health Check is currently in for and subject to change.
About generated Health Checks
You can create a support bundle for that contains a lot of data, such as diagnostics and log files. To help analyze and interpret this data, you can generate a Health Check. For more information about support... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/generating-a-health-check-for-your-enterprise.md",
"title": "Generating a Health Check for your enterprise"
} |
SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of and know when to add more memory, storage, or processor power to the host machine.
has a standard SNMP installation, so you can take advantage of the many plugins available for Nagios ... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/monitoring-using-snmp.md",
"title": "Monitoring using SNMP"
} |
About OpenTelemetry metrics
The OpenTelemetry monitoring stack is based on industry-standard observability tools and includes various components for collecting, processing, and storing metrics. This comprehensive approach provides a complete view of your system's performance and health across all components of your in... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/about-opentelemetry-metrics.md",
"title": "About OpenTelemetry metrics"
} |
Prerequisites
OpenTelemetry metrics are enabled for your instance
Additional dashboards
When OpenTelemetry metrics are enabled, you can turn on advanced Grafana dashboards with enhanced visualization and monitoring capabilities.
When OpenTelemetry metrics are enabled, you will have access to advanced Grafana dashboa... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/advanced-dashboards.md",
"title": "Advanced dashboards of OpenTelemetry metrics"
} |
Prerequisites
3.18 or later
Administrative access to the
SSH access to your appliance
Enabling OpenTelemetry metrics
OpenTelemetry metrics are enabled by default for new installations of 3.19 and later. Upgrades to 3.19 will still have collectd metrics enabled by default, but you can choose to switch to OpenTe... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/configuring-opentelemetry-for-your-instance.md",
"title": "Configuring OpenTelemetry for your instance"
} |
External monitoring approaches
External monitoring with OpenTelemetry allows you to integrate your instance with existing monitoring infrastructure and tools. provides two primary approaches for external monitoring:
1. Prometheus endpoint: Expose metrics in Prometheus format for external tools to scrape
1. Custom Ope... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/setting-up-external-monitoring-with-opentelemetry.md",
"title": "Setting up external monitoring with OpenTelemetry"
} |
Prerequisites
OpenTelemetry metrics must be enabled on the instance. For configuration instructions, see AUTOTITLE.
Navigating to the monitor dashboards
1. Click the Monitor tab.
Metric labels
The OpenTelemetry stack exporters automatically attach labels to metrics. Common labels are:
job — the name of the exporter ... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics/using-grafana-to-analyze-opentelemetry-metrics.md",
"title": "Using Grafana to analyze OpenTelemetry metrics"
} |
About recommended alert thresholds
You can configure external monitoring systems to alert you to storage, CPU, and memory usage that may cause problems with .
For more information about OpenTelemetry metrics, see AUTOTITLE.
For more information about collectd metrics, see AUTOTITLE.
For more information about the monit... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/recommended-alert-thresholds.md",
"title": "Recommended alert thresholds"
} |
Troubleshooting common resource allocation problems on your appliance
[!NOTE]
Regularly making repeated requests (polling) to from continuous integration (CI) systems, build servers, or any other clients (such as Git or API clients) can overwhelm the system. This can lead to a denial of service (DoS) attack, causing... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/monitoring-your-instance/troubleshooting-resource-allocation-problems.md",
"title": "Troubleshooting resource allocation problems"
} |
Why introduce more disks to the GHES instance?
Improved resource distribution:
Different services have unique disk requirements.
MySQL is mostly latency and IOPS sensitive.
Some resources (such as repositories) don't benefit as much from expensive block storage.
Maximized VM limits:
A single disk is often... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/multiple-data-disks/configuring-multiple-data-disks.md",
"title": "Configuring multiple data disks"
} |
In some cases, you may need to change the platform on which runs, such as moving from VMware to Azure.
Recommendations
You should carefully plan any out migration procedures and consider first testing on a staging environment. For more information, see AUTOTITLE.
Moving platforms using a replica will require the leas... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/changing-your-platform.md",
"title": "Changing your platform"
} |
About increasing CPU or memory resources
You can accommodate more resource-intensive workloads on by increasing the VM's CPU or memory resources.
Adding CPU or memory resources on AWS
To add CPU or memory resources for an instance on AWS, you must change the instance's type. You must have access to your company's AWS... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md",
"title": "Increasing CPU or memory resources"
} |
As more users join , you may need to resize your storage volume. Refer to the documentation for your virtualization platform for information on resizing storage.
Requirements and recommendations
[!NOTE]
Before resizing any storage volume, put your instance in maintenance mode. You can validate changes by configuring... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md",
"title": "Increasing storage capacity"
} |
About generation 2 virtual machines
Generation 2 virtual machines (Gen 2 VMs) allow you to vertically scale your appliance to cope with increased demand.
Cloud service providers such as Microsoft Azure expect Gen 2 VMs to be bootable in UEFI mode. In new installations of version 3.14 and later, supports both BIOS mode... | {
"source": "github-docs/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/using-generation-2-virtual-machines.md",
"title": "Using generation 2 virtual machines"
} |
is a deployment option for , adding advanced features to , including:
SAML authentication
Additional minutes
Restriction of email notifications to verified domains
Privately published sites
Repository rulesets
's compliance reports
For a full list of features included with , see our Pricing page.
What are the ... | {
"source": "github-docs/admin/overview/about-github-enterprise-cloud.md",
"title": "About GitHub Enterprise Cloud"
} |
Your business can benefit from increased control and avoid issues associated the public cloud, while your developers can benefit from familiar features and workflows from .
is suitable for enterprises that are subject to regulatory compliance. It runs on your infrastructure and is governed by access and security contr... | {
"source": "github-docs/admin/overview/about-github-enterprise-server.md",
"title": "About GitHub Enterprise Server"
} |
Why should my business choose ?
Provide a platform developers already know. Adopting can help you attract talent, reduce onboarding time, and leverage a large open source community by using tools already familiar to more than 100 million developers.
Consolidate tools in the cloud. is a complete developer platform t... | {
"source": "github-docs/admin/overview/about-github-for-enterprises.md",
"title": "About GitHub for enterprises"
} |
With the APIs, you can automate many administrative tasks. Some examples include:
Perform a configuration run to apply changes to settings. For more information, see AUTOTITLE.
Configure LDAP sync. For more information, see AUTOTITLE.
Collect statistics about your enterprise. For more information, see AUTOTITLE.
M... | {
"source": "github-docs/admin/overview/about-the-github-enterprise-api.md",
"title": "About the GitHub Enterprise API"
} |
Feature releases
Feature releases include new functionality and feature upgrades and typically occur quarterly.
All feature releases begin with at least one release candidate.
Release candidates
Release candidates are proposed feature releases, with a complete feature set. There may be problems that can only be found ... | {
"source": "github-docs/admin/overview/about-upgrades-to-new-releases.md",
"title": "About upgrades to new releases"
} |
About 's compliance reports
You can access 's compliance reports in your enterprise settings.
Accessing compliance reports for your enterprise
1. Under "Resources", to the right of the report you want to access, click Download or View.
Further reading
AUTOTITLE
AUTOTITLE | {
"source": "github-docs/admin/overview/accessing-compliance-reports-for-your-enterprise.md",
"title": "Accessing compliance reports for your enterprise"
} |
As an enterprise owner, you are responsible for maintaining a strong security posture, complying with regulations, mitigating risks, and protecting intellectual property, within your enterprise. has tools that can help with that.
Storing your company's code on allows easy collaboration, tracking, and deployment from ... | {
"source": "github-docs/admin/overview/establishing-a-governance-framework-for-your-enterprise.md",
"title": "Establishing a governance framework for your enterprise"
} |
For more information, or to purchase , see . | {
"source": "github-docs/admin/overview/index.md",
"title": "Overview"
} |
See AUTOTITLE.
To set up a trial, you must be signed in to a personal account. If you don't have a personal account, see AUTOTITLE.
<a href="https://github.com/account/enterprises/new?refproduct=ghec&reftype=trial&refstyle=button&refplan=enterprise" target="blank" class="btn btn-primary mt-3 mr-3 no-underline"<spanSet ... | {
"source": "github-docs/admin/overview/setting-up-a-trial-of-github-enterprise-cloud.md",
"title": "Setting up a trial of GitHub Enterprise Cloud"
} |
About trials of
You can request a 45-day trial to evaluate . Your trial will be installed as a virtual appliance, with options for on-premises or cloud deployment. For more information about , and for a list of supported virtualization platforms, see AUTOTITLE.
Security alerts and are not currently available in trial... | {
"source": "github-docs/admin/overview/setting-up-a-trial-of-github-enterprise-server.md",
"title": "Setting up a trial of GitHub Enterprise Server"
} |
About
For more information, see AUTOTITLE.
Storage architecture
requires two storage volumes, one mounted to the root filesystem path (/) and the other to the user filesystem path (/data/user). This architecture simplifies the upgrade, rollback, and recovery procedures by separating the running software environmen... | {
"source": "github-docs/admin/overview/system-overview.md",
"title": "System overview"
} |
[!NOTE]
11.10 is an unsupported release from 2014. For a list of supported releases, see AUTOTITLE.
Migrations from 11.10.348 and later are supported. Migrating from 11.10.348 and earlier is not supported. You must first upgrade to 11.10.348 in several upgrades. For more information, see the 11.10.348 upgrading pro... | {
"source": "github-docs/admin/upgrading-your-instance/performing-an-upgrade/migrating-from-github-enterprise-1110x-to-2123.md",
"title": "Migrating from GitHub Enterprise 11.10.x to 2.1.23"
} |
Using the , you can install a hotpatch immediately or schedule it for later installation. You can use the administrative shell to install a hotpatch with the ghe-upgrade utility. See AUTOTITLE and AUTOTITLE.
Upgrading a standalone instance using a hotpatch
If you're upgrading an instance with one node using a hotpatch... | {
"source": "github-docs/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-a-hotpatch.md",
"title": "Upgrading with a hotpatch"
} |
Using the administrative shell, you can install an upgrade package with the ghe-upgrade utility.
If you're running back-to-back feature version upgrades, you must ensure background jobs are complete before proceeding with the following upgrade to a feature release. recommends waiting for any background upgrade tasks t... | {
"source": "github-docs/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package.md",
"title": "Upgrading with an upgrade package"
} |
Upgrading to newer versions of typically increases resource consumption. Each feature release adds new functionality, some enabled by default, others opt-in, which requires more processing power. Customer usage patterns also affect demand; for example, enterprises with tens of thousands of organizations may see higher... | {
"source": "github-docs/admin/upgrading-your-instance/preparing-to-upgrade/check-system-capacity-before-upgrading.md",
"title": "Check system capacity before upgrading"
} |
About automatic update checks
When an upgrade package is automatically downloaded for , you'll receive a message letting you know you can upgrade . Packages download to the /var/lib/ghe-updates directory on . For more information about the recommendations and requirements for upgrades, see AUTOTITLE.
If a hotpatch is a... | {
"source": "github-docs/admin/upgrading-your-instance/preparing-to-upgrade/enabling-automatic-update-checks.md",
"title": "Enabling automatic update checks"
} |
You are responsible for upgrades to your instance. See AUTOTITLE.
To upgrade an instance, you must:
1. Plan your upgrade strategy by choosing your upgrade version and the appropriate upgrade package, and scheduling a maintenance window.
1. Communicate the upgrade before and during the upgrade process.
1. Prepare your b... | {
"source": "github-docs/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process.md",
"title": "Overview of the upgrade process"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.