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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,4 @@ translations/

# Shared local volume (bufo)
.local
docs-ghes-3.14/
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# ---------------------------------------------------------------
# To update the sha:
# https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble
FROM ghcr.io/github/gh-base-image/gh-base-noble:20260326-105710-g59112a0a7@sha256:ba809251141daf76a02c7c064ae2c3b27a904f2f62b16582f62fe4328267f38f AS base
FROM ghcr.io/github/gh-base-image/gh-base-noble:20260501-222137-g8063ecb13@sha256:9c650d5e53cbf6c95951373d197ede7955329ef695f5fc6fb8a1c56a8e3b817f AS base

# Install curl for Node install and determining the early access branch
# Install git for cloning docs-early-access & translations repos
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -830,7 +830,7 @@ jobs:

> [!NOTE]
> * The webhook payload available to GitHub Actions does not include the `added`, `removed`, and `modified` attributes in the `commit` object. You can retrieve the full commit object using the API. For information, see [AUTOTITLE](/graphql/reference/objects#commit) in the GraphQL API documentation or [AUTOTITLE](/rest/commits#get-a-commit).
> * {% ifversion fpt or ghec or ghes > 3.14 %}Events will not be created if more than 5,000 branches are pushed at once. {% endif %}Events will not be created for tags when more than three tags are pushed at once.
> * Events will not be created if more than 5,000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.

Runs your workflow when you push a commit or tag, or when you create a repository from a template.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ category:

{% data reusables.enterprise-licensing.about-license-sync %} For more information, see [AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect#data-transmission).

If you enable automatic user license sync for your enterprise, every week, {% data variables.product.prodname_github_connect %} will automatically synchronize license usage between {% data variables.product.prodname_ghe_server %} and your enterprise on {% data variables.product.prodname_dotcom_the_website %}{% ifversion ghecom-license-sync %} or {% data variables.enterprise.data_residency_site %}{% endif %}. You can also synchronize your license data at any time outside of the automatic weekly sync, by manually triggering a license sync job. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud#triggering-a-license-sync-job).
If you enable automatic user license sync for your enterprise, every week, {% data variables.product.prodname_github_connect %} will automatically synchronize license usage between {% data variables.product.prodname_ghe_server %} and your enterprise on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %}. You can also synchronize your license data at any time outside of the automatic weekly sync, by manually triggering a license sync job. For more information, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud#triggering-a-license-sync-job).

If you use multiple {% data variables.product.prodname_ghe_server %} instances, you can enable automatic license sync between each of your instances and the same enterprise account on {% data variables.product.prodname_ghe_cloud %}.

Expand All @@ -34,7 +34,7 @@ You can also manually upload {% data variables.product.prodname_ghe_server %} us

## Enabling license synchronization

Before enabling license synchronization on {% data variables.location.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. See {% ifversion ghecom-license-sync %}[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom) or {% endif %}[AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom).
Before enabling license synchronization on {% data variables.location.product_location %}, you must enable {% data variables.product.prodname_github_connect %}. See [AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-ghecom) or [AUTOTITLE](/admin/configuring-settings/configuring-github-connect/enabling-github-connect-for-githubcom).

{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.github-connect-tab %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Regardless of the chosen policy, {% data variables.product.pat_generic_caps_plur

{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
1. Under **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies**, click **{% data variables.product.pat_generic_caps_plural %}**. {% ifversion tabbed-pat-settings-ui %}
1. Select either the **Fine-grained tokens** or **Tokens (classic)** tab to enforce this policy based on the token type. {% endif %}
1. Under **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies**, click **{% data variables.product.pat_generic_caps_plural %}**.
1. Select either the **Fine-grained tokens** or **Tokens (classic)** tab to enforce this policy based on the token type.
1. Under **{% data variables.product.pat_v2_caps_plural %}** or **Restrict {% data variables.product.pat_v1_plural %} from accessing your organizations**, select your access policy.
1. Click **Save**.

Expand Down Expand Up @@ -72,7 +72,7 @@ By default, organizations require approval of {% data variables.product.pat_v2_p

{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
1. Under **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies**, click **{% data variables.product.pat_generic_caps_plural %}**. {% ifversion tabbed-pat-settings-ui %}
1. Select the **Fine-grained tokens** tab. {% endif %}
1. Under **{% octicon "law" aria-hidden="true" aria-label="law" %} Policies**, click **{% data variables.product.pat_generic_caps_plural %}**.
1. Select the **Fine-grained tokens** tab.
1. Under **Require approval of {% data variables.product.pat_v2_plural %}**, select your approval policy:
1. Click **Save**.
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ category:

You can use {% data variables.product.prodname_AS %} features to harden security for the organizations in your enterprise.

{% ifversion security-configurations %}{% data reusables.security-configurations.enable-security-features-with-gh-config %}
{% data reusables.security-configurations.enable-security-features-with-gh-config %}

To manage individual {% data variables.product.prodname_GHAS %} features, {% else %}To streamline management of {% data variables.product.prodname_AS %}, {% endif %}you can enable or disable each feature for all existing and/or new repositories within the organizations owned by your enterprise.
To manage individual {% data variables.product.prodname_GHAS %} features, you can enable or disable each feature for all existing and/or new repositories within the organizations owned by your enterprise.

{% ifversion security-configurations-ghes-only %}

Expand Down Expand Up @@ -49,8 +49,8 @@ When you enable one or more security and analysis features for existing reposito

* To the right of the feature, click **Disable all** or **Enable all**. If the control for "{% data variables.product.prodname_GHAS %}" is disabled, you have no available licenses for {% data variables.product.prodname_GHAS %}.
* To confirm the change, click the **Enable/Disable all** or **Enable/Disable for eligible repositories** button in the dialog that is displayed.
1. Optionally, to enable or disable a feature automatically when new private and internal repositories{% ifversion secret-scanning-user-owned-repos %}, user namespace repositories{% endif %}, or public repositories and repositories with {% data variables.product.prodname_GHAS %} enabled are created, select the checkbox below the feature.{% ifversion org-npp-enablement-security-configurations %}
1. Optionally, to enable the scanning of non-provider patterns, to the right of "Scan for non-provider patterns", click **Enable all**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).{% endif %}
1. Optionally, to enable or disable a feature automatically when new private and internal repositories{% ifversion secret-scanning-user-owned-repos %}, user namespace repositories{% endif %}, or public repositories and repositories with {% data variables.product.prodname_GHAS %} enabled are created, select the checkbox below the feature.
1. Optionally, to enable the scanning of non-provider patterns, to the right of "Scan for non-provider patterns", click **Enable all**. To learn more about scanning for non-provider patterns, see [AUTOTITLE](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#non-provider-patterns) and [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts).
1. Optionally, to include a resource link in the message that members will see when they attempt to push a secret, select **Add a resource link in the CLI and web UI when a commit is blocked**, then type a URL, and click **Save link**.

> [!NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ category:
- Monitor and audit your enterprise
---


>[!NOTE] {% ifversion ghes %}{% data reusables.webhooks.webhooks-as-audit-log-alternative %}{% else %}{% data reusables.webhooks.webhooks-as-audit-log-alternative %}{% endif %}
## About audit log streaming
Expand Down Expand Up @@ -114,8 +113,7 @@ From {% data variables.product.prodname_dotcom %}:
1. Under "Authentication", click **Access keys**.{% endif %}
1. Configure the stream settings.

{% ifversion ghec or ghes > 3.14 %}
- Under "Region", select the bucket's region. For example, `us-east-1`.{% endif %}
- Under "Region", select the bucket's region. For example, `us-east-1`.
- Under "Bucket", type the name of the bucket you want to stream to. For example, `auditlog-streaming-test`.
- Under "Access Key ID", type your access key ID. For example, `ABCAIOSFODNN7EXAMPLE1`.
- Under "Secret Key", type your secret key. For example, `aBcJalrXUtnWXYZ/A1MDENG/zPxRfiCYEXAMPLEKEY`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,7 @@ Use an upgrade package to upgrade a {% data variables.product.prodname_ghe_serve
### Upgrading the cluster nodes

1. Enable maintenance mode according to your scheduled window by connecting to the administrative shell of any cluster node and running `ghe-cluster-maintenance -s`.
{% ifversion ghes < 3.15 %}
1. If you're upgrading from version 3.11 or 3.12 to version 3.13 or later, Elasticsearch will be upgraded as part of the upgrade to your cluster. For more information, see [AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade).

Before upgrading, you will need to run a script to prepare your cluster for an upgrade to 3.13 or 3.14.
1. Ensure you are running the required patch release for your current version: **3.11.9** or later for 3.11, or **3.12.3** or later for 3.12.
1. On any `elasticsearch-server` node, run `/usr/local/share/enterprise/ghe-es-auditlog-cluster-rebalance`.
{% endif %}
1. **With the exception of the primary MySQL node**, connect to the administrative shell of each of the {% data variables.product.prodname_ghe_server %} nodes.
Run the `ghe-upgrade` command, providing the package file name you downloaded in step 4 of [Preparing to upgrade](#preparing-to-upgrade):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ As more users join {% data variables.location.product_location %}, you may need
### Minimum recommended requirements

{% ifversion ghes > 3.14 %}{% data reusables.enterprise_installation.hardware-rec-table %}{% else %}{% data reusables.enterprise_installation.hardware-rec-table-legacy %}{% endif %}
{% data reusables.enterprise_installation.hardware-rec-table %}

Root storage refers to the total size of your instance's root disk. The available space on the root filesystem is 50% of the total storage available on the root disk. For more information, see [AUTOTITLE](/admin/overview/system-overview#storage-architecture).

Expand Down
2 changes: 1 addition & 1 deletion content/admin/overview/system-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ category:

The root filesystem is included in the distributed machine image. It contains the base operating system and the {% data variables.product.prodname_ghe_server %} application environment. The root filesystem should be treated as ephemeral. Any data on the root filesystem will be replaced when upgrading to future {% data variables.product.prodname_ghe_server %} releases.

The root storage volume is split into two equally-sized partitions. One of the partitions will be mounted as the root filesystem (`/`). The other partition is only mounted during upgrades and rollbacks of upgrades as `/mnt/upgrade`, to facilitate easier rollbacks if necessary. For example, if a {% ifversion ghes > 3.14 %}400GB root volume is allocated, there will be 200GB allocated to the root filesystem and 200GB{% else %}200GB root volume is allocated, there will be 100GB allocated to the root filesystem and 100GB{% endif %} reserved for the upgrades and rollbacks.
The root storage volume is split into two equally-sized partitions. One of the partitions will be mounted as the root filesystem (`/`). The other partition is only mounted during upgrades and rollbacks of upgrades as `/mnt/upgrade`, to facilitate easier rollbacks if necessary. For example, if a 400GB root volume is allocated, there will be 200GB allocated to the root filesystem and 200GB reserved for the upgrades and rollbacks.

In new installations of 3.14 and later, the root storage volume is split into four partitions. Two small partitions are for the supported boot modes (BIOS and UEFI), and the other two equally large partitions are for the {% data variables.product.prodname_ghe_server %} primary, and upgrades and rollbacks.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ children:
- /upgrading-with-a-hotpatch
- /upgrading-with-an-upgrade-package
- /migrating-from-github-enterprise-1110x-to-2123
- /preparing-for-the-elasticsearch-upgrade
shortTitle: Perform an upgrade
redirect_from:
- /admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade
---

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,6 @@ We have extended the support window for versions 3.14, 3.15, 3.16, and 3.17. The

We will continue to release patches for 3.14, 3.15, 3.16, and 3.17 throughout this extended support window.

{% ifversion ghes < 3.15 %}

## Elasticsearch Upgrade

As part of upgrading GitHub Enterprise Server to version 3.13 or later, the Elasticsearch service will be upgraded. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade).
{% endif %}

{% ifversion ghes > 3.14 %}

## Required root disk size increased to 400GB

> [!Note]
Expand Down Expand Up @@ -68,7 +59,6 @@ In case you did not have the opportunity to run the encryption diagnostics scrip
If undecryptable records are detected, you will be prompted whether you want to proceed with the upgrade or not. If you proceed, the upgrade process deletes the undecryptable records. Otherwise, the upgrade process will exit.

If you have any questions during the upgrade, you can reach out to {% data variables.contact.github_support %}. Once you have had the time and opportunity to understand the impact, you can retrigger the upgrade.
{% endif %}

{% ifversion ghes < 3.17 %}

Expand Down
Loading
Loading