Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ versions:
ghes: '*'
shortTitle: Access the admin shell (SSH)
contentType: how-tos
category:
- Install and configure your instance
---
## About administrative shell access

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ versions:
feature: ghes-manage-api-cli-extension
shortTitle: Using the GitHub CLI
contentType: how-tos
category:
- Install and configure your instance
---
## About the `gh es` extension for {% data variables.product.prodname_cli %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ redirect_from:
versions:
ghes: '*'
contentType: reference
category:
- Install and configure your instance
---

You can execute these commands from anywhere on the VM after signing in as an SSH admin user. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ redirect_from:
versions:
ghes: '*'
contentType: concepts
category:
- Install and configure your instance
---

## About the {% data variables.enterprise.management_console %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ redirect_from:
versions:
ghes: '*'
contentType: how-tos
category:
- Install and configure your instance
---

{% data reusables.enterprise_site_admin_settings.management-console-access %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ redirect_from:
versions:
ghes: '*'
contentType: how-tos
category:
- Install and configure your instance
---

{% data reusables.enterprise_site_admin_settings.management-console-access %} For more information about {% data variables.enterprise.management_console %} access, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ permissions: Enterprise owners can manage search indices for a {% data variables
versions:
ghes: '*'
contentType: reference
category:
- Install and configure your instance
---

## About search for {% data variables.product.prodname_ghe_server %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ redirect_from:
versions:
ghes: '*'
contentType: how-tos
category:
- Install and configure your instance
---

## About problems with {% data variables.enterprise.management_console %} access
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ versions:
ghes: '*'
shortTitle: Configure maintenance mode
contentType: how-tos
category:
- Install and configure your instance
---

## About maintenance mode
Expand Down
2 changes: 2 additions & 0 deletions content/admin/all-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ allowTitleToDifferFromFilename: true
versions:
ghes: '*'
shortTitle: Releases
category:
- Get started with GitHub Enterprise
---

{% data reusables.enterprise.constantly-improving %} See [AUTOTITLE](/admin/overview/about-upgrades-to-new-releases).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Learn what the built-in backup service offers and how it differs from a H
versions:
ghes: '>=3.17'
contentType: concepts
category:
- Back up and upgrade your instance
---

{% ifversion ghes < 3.20 %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Enable backup from a high availability replica node.
versions:
ghes: '> 3.19'
contentType: how-tos
category:
- Back up and upgrade your instance
---

## Configuring backups from a replica node
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Enable backup from a node in cluster.
versions:
ghes: '> 3.19'
contentType: how-tos
category:
- Back up and upgrade your instance
---

## Configuring backups from a cluster node
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Reference for all configurable options available in the Backup Service se
versions:
ghes: '>= 3.17'
contentType: reference
category:
- Back up and upgrade your instance
---

You can configure the following options in the "Backup Service" section of the {% data variables.enterprise.management_console %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Enable a remote archive for backups through SSH.
versions:
ghes: '> 3.19'
contentType: how-tos
category:
- Back up and upgrade your instance
---

If you are running {% data variables.product.prodname_ghe_server %} on a cloud platform or virtualization platform that supports disk snapshots, we recommend that you use snapshots to archive your backup disk, and recreate a new backup disk for testing, restoring, or disaster recovery purposes. However, if your infrastructure does not support disk snapshots or similar solutions, you can setup a {% data variables.product.prodname_ghe_server %} backup archive on a remote {% data variables.product.prodname_ghe_server %} appliance for data replication and restoration purposes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Enable and configure the built-in backup service in the {% data variables
versions:
ghes: '>=3.17'
contentType: how-tos
category:
- Back up and upgrade your instance
---

Before configuring the backup service, ensure you have:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Run manual backups, understand backup types, and monitor backup activity
versions:
ghes: '>= 3.17'
contentType: how-tos
category:
- Back up and upgrade your instance
---

## About backup types
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Restore a {% data variables.product.prodname_ghe_server %} instance using
versions:
ghes: '>= 3.17'
contentType: how-tos
category:
- Back up and upgrade your instance
---

You can restore a {% data variables.product.prodname_ghe_server %} instance from a backup using the command line. The backup service supports full instance restoration, including configuration and user data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Learn how to prepare for and restore backups when {% data variables.produ
versions:
ghes: '>= 3.17'
contentType: how-tos
category:
- Back up and upgrade your instance
---

>[!IMPORTANT] Data stored in your configured external storage for {% data variables.product.prodname_actions %}—such as logs, artifacts, and other blobs—is not included in {% data variables.product.prodname_enterprise_backup_service %} snapshots. You must back up this data separately using your storage provider's tools and best practices.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ shortTitle: Understand the backup service
intro: 'Answers to common questions about using the backup service with {% data variables.product.prodname_ghe_server %}.'
versions:
ghes: '>= 3.17'
category:
- Back up and upgrade your instance
---

## Does backing up or restoring impact performance?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Understand the structure and contents of backup snapshot directories, inc
versions:
ghes: '>= 3.17'
contentType: reference
category:
- Back up and upgrade your instance
---

Each backup snapshot is stored in a timestamped directory (e.g., `YYYYMMDDTHHMMSS`) under the backup target path (e.g., `/data/backup/data`). Snapshots include full exports of key data stores. Git repositories, {% data variables.product.prodname_pages %}, and other components are stored using hard links to optimize storage and enable efficient point-in-time restores.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ intro: As part of a disaster recovery plan, you can protect production data on {
versions:
ghes: '*'
contentType: how-tos
category:
- Back up and upgrade your instance
---

{% ifversion ghes > 3.16 %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ redirect_from:
- /admin/concepts/best-practices-for-enterprises
- /admin/concepts/best-practices
allowTitleToDifferFromFilename: true
category:
- Get started with GitHub Enterprise
---

{% data reusables.enterprise-onboarding.best-practices %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ versions:
ghes: '*'
contentType: concepts
allowTitleToDifferFromFilename: true
category:
- Get started with GitHub Enterprise
---

{% data reusables.enterprise-onboarding.use-innersource %}
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: Learn how {% data variables.product.prodname_github_apps %}, external ser
versions:
feature: enterprise-apps-public-beta
contentType: concepts
category:
- Get started with GitHub Enterprise
---

Automation on {% data variables.product.github %} typically involves multiple components working together. The most important {% data variables.product.github %} native components are:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ versions:
ghec: '*'
ghes: '*'
contentType: concepts
category:
- Get started with GitHub Enterprise
---

An enterprise account is the central point of administration for your business on {% data variables.product.github %}. It brings together administrative tools for access management, policies, billing, and more. Enterprise administrators can set up features and policies efficiently at scale before deploying them across the business.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ shortTitle: Roles
redirect_from:
- /admin/overview/about-roles
contentType: concepts
category:
- Get started with GitHub Enterprise
---

{% data reusables.enterprise-onboarding.about-roles %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ shortTitle: Teams
redirect_from:
- /admin/overview/about-teams
contentType: concepts
category:
- Get started with GitHub Enterprise
---

{% data reusables.enterprise-onboarding.about-teams %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ versions:
ghec: '*'
contentType: concepts
allowTitleToDifferFromFilename: true
category:
- Provision and manage enterprise users
---

## What are Enterprise Managed Users in {% data variables.product.github %}?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ redirect_from:
- /admin/identity-and-access-management/managing-iam-for-your-enterprise/about-identity-and-access-management
- /admin/identity-and-access-management/understanding-iam-for-enterprises/about-identity-and-access-management
- /admin/managing-iam/understanding-iam-for-enterprises/about-identity-and-access-management
category:
- Configure authentication
---

## What is IAM for {% data variables.product.github %}?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Setup user
intro: 'The setup user is used only to configure authentication and provisioning for {% data variables.product.prodname_emus %}.'
versions:
ghec: '*'
category:
- Provision and manage enterprise users
---

## How should I use the setup user?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: 'Manage access with confidence by understanding the recommended approach
versions:
ghec: '*'
contentType: concepts
category:
- Provision and manage enterprise users
---

## How should I offboard users?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ versions:
ghes: '*'
ghec: '*'
contentType: concepts
category:
- Secure and govern your enterprise
---

{% data reusables.enterprise-onboarding.about-audit-logs %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ contentType: concepts
redirect_from:
- /admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/about-enterprise-policies
category:
- Secure and govern your enterprise
---

## What are enterprise policies and why are they important?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ versions:
ghes: '*'
shortTitle: Configure package ecosystems
contentType: how-tos
category:
- Enable GitHub features for your enterprise
---

{% data reusables.package_registry.packages-ghes-release-stage %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ shortTitle: Enable Packages with AWS
redirect_from:
- /admin/packages/enabling-github-packages-with-aws
contentType: tutorials
category:
- Enable GitHub features for your enterprise
---

> [!WARNING]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ shortTitle: Enable Packages with Azure
redirect_from:
- /admin/packages/enabling-github-packages-with-azure-blob-storage
contentType: tutorials
category:
- Enable GitHub features for your enterprise
---

> [!WARNING]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ redirect_from:
- /admin/packages/enabling-github-packages-with-minio
- /admin/configuring-packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages
contentType: tutorials
category:
- Enable GitHub features for your enterprise
---

> [!WARNING]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ redirect_from:
versions:
ghes: '*'
contentType: how-tos
category:
- Enable GitHub features for your enterprise
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ versions:
shortTitle: Migrate to Container registry
redirect_from:
- /admin/packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry
category:
- Enable GitHub features for your enterprise
---

{% data reusables.package_registry.container-registry-ghes-beta %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ versions:
redirect_from:
- /admin/configuration/configuring-github-connect/about-github-connect
contentType: concepts
category:
- Install and configure your instance
---

{% data variables.product.prodname_github_connect %} allows {% data variables.location.product_location %} to connect to your enterprise on {% data variables.product.prodname_ghe_cloud %} in limited ways.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ intro: 'You can disable {% data variables.product.prodname_github_connect %} to
versions:
ghes: '*'
permissions: 'Enterprise owners'
category:
- Install and configure your instance
---

When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account and credentials stored on {% data variables.location.product_location %} are deleted.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ versions:
ghes: '*'
shortTitle: Automatic user license sync
contentType: how-tos
category:
- Install and configure your instance
---
## About automatic license synchronization

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ permissions: Enterprise owners can set up {% data variables.product.prodname_dep
versions:
ghes: '*'
contentType: how-tos
category:
- Install and configure your instance
---

## About {% data variables.product.prodname_dependabot %} for {% data variables.product.prodname_ghe_server %}
Expand Down
Loading
Loading