text stringlengths 12 91.7k | metadata dict |
|---|---|
Requirements for self-hosted runner machines
You can use a machine as a self-hosted runner as long as it meets these requirements:
You can install and run the self-hosted runner application on the machine. See Supported operating systems and Supported processor architectures.
The machine can communicate with .
The m... | {
"source": "github-docs/actions/reference/runners/self-hosted-runners.md",
"title": "Self-hosted runners reference"
} |
OIDC token claims
To see all the claims supported by 's OIDC provider, review the claimssupported entries at
https://HOSTNAME/services/token/.well-known/openid-configurationhttps://token.actions.githubusercontent.com/.well-known/openid-configuration.
The OIDC token includes the following claims.
Standard audience, iss... | {
"source": "github-docs/actions/reference/security/oidc.md",
"title": "OpenID Connect reference"
} |
Naming your secrets
[!TIP]
To help ensure that redacts your secrets in logs correctly, avoid using structured data as the values of secrets.
The following rules apply to secret names:
Similarly, if an organization, repository, and environment all have a secret with the same name, the environment-level secret takes p... | {
"source": "github-docs/actions/reference/security/secrets.md",
"title": "Secrets reference"
} |
Find information about security best practices when you are writing workflows and using security features.
Writing workflows
Use secrets for sensitive information
Because there are multiple ways a secret value can be transformed, automatic redaction is not guaranteed. Adhere to the following best practices to limit ... | {
"source": "github-docs/actions/reference/security/secure-use.md",
"title": "Secure use reference"
} |
This guide helps you assess whether your workflow should use the pullrequesttarget event and understand the security risks involved. It also explains the protection applies to actions/checkout v7 and later to reduce these risks by default, and when to opt out of that protection if necessary.
Read pullrequesttarget bef... | {
"source": "github-docs/actions/reference/security/securely-using-pull_request_target.md",
"title": "Securely using pull_request_target"
} |
Available contexts
Context name Type Description
----------------------------------
github object Information about the workflow run. For more information, see github context.
env object Contains variables set in a workflow, job, or step. For more information, see env context.
vars object Contains variab... | {
"source": "github-docs/actions/reference/workflows-and-actions/contexts.md",
"title": "Contexts reference"
} |
cache action usage
The cache action will attempt the following sequence when restoring a cache:
1. First, it searches for an exact match to your provided key.
1. If no exact match is found, it will search for partial matches of the key.
1. If there is still no match found, and you've provided restore-keys, these keys w... | {
"source": "github-docs/actions/reference/workflows-and-actions/dependency-caching.md",
"title": "Dependency caching reference"
} |
Deployment protection rules
Deployment protection rules require specific conditions to pass before a job referencing the environment can proceed. You can use deployment protection rules to require a manual approval, delay a job, or restrict the environment to certain branches. You can also create and implement custom p... | {
"source": "github-docs/actions/reference/workflows-and-actions/deployments-and-environments.md",
"title": "Deployments and environments"
} |
USER
Docker actions must be run by the default Docker user (root). Do not use the USER instruction in your Dockerfile, because you won't be able to access the GITHUBWORKSPACE directory. For more information, see AUTOTITLE and USER reference in the Docker documentation.
FROM
The first instruction in the Dockerfile must... | {
"source": "github-docs/actions/reference/workflows-and-actions/dockerfile-support.md",
"title": "Dockerfile support for GitHub Actions"
} |
About events that trigger workflows
Workflow triggers are events that cause a workflow to run. For more information about how to use workflow triggers, see AUTOTITLE.
Some events have multiple activity types. For these events, you can specify which activity types will trigger a workflow run. For more information about ... | {
"source": "github-docs/actions/reference/workflows-and-actions/events-that-trigger-workflows.md",
"title": "Events that trigger workflows"
} |
Literals
As part of an expression, you can use boolean, null, number, or string data types.
Data type Literal value
--------------------------
boolean true or false
null null
number Any number format supported by JSON.
string You don't need to enclose strings in $. However, if you do, you must use si... | {
"source": "github-docs/actions/reference/workflows-and-actions/expressions.md",
"title": "Evaluate expressions in workflows and actions"
} |
name
Required The name of your action. displays the name in the Actions tab to help visually identify actions in each job.
author
Optional The name of the action's author.
description
Required A short description of the action.
inputs
Optional Input parameters allow you to specify data that the action expects to us... | {
"source": "github-docs/actions/reference/workflows-and-actions/metadata-syntax.md",
"title": "Metadata syntax reference"
} |
Reusable workflows
Reference information for reusable workflows.
Access to reusable workflows
A reusable workflow can be used by another workflow if any of the following is true:
Both workflows are in the same repository.
The called workflow is stored in a public repository on .
You cannot directly use reusable wo... | {
"source": "github-docs/actions/reference/workflows-and-actions/reusing-workflow-configurations.md",
"title": "Reusing workflow configurations"
} |
This article lists the supported variables you can use in workflows, including environment variables, configuration variables, and default variables provided by . Use this reference to look up variable names, naming conventions, limits, and supported contexts when configuring your workflows.
For more information about... | {
"source": "github-docs/actions/reference/workflows-and-actions/variables.md",
"title": "Variables reference"
} |
When canceling a workflow run, you may be running other software that uses resources related to the workflow run. To help you free up resources related to the workflow run, it may help to understand the steps performs to cancel a workflow run.
1. To cancel the workflow run, the server re-evaluates if conditions for al... | {
"source": "github-docs/actions/reference/workflows-and-actions/workflow-cancellation.md",
"title": "Workflow cancellation reference"
} |
About workflow commands
Actions can communicate with the runner machine to set environment variables, output values used by other actions, add debug messages to the output logs, and other tasks.
Most workflow commands use the echo command in a specific format, while others are invoked by writing to a file. For more inf... | {
"source": "github-docs/actions/reference/workflows-and-actions/workflow-commands.md",
"title": "Workflow commands for GitHub Actions"
} |
About YAML syntax for workflows
Workflow files use YAML syntax, and must have either a .yml or .yaml file extension.
You must store workflow files in the .github/workflows directory of your repository.
name
run-name
The name for workflow runs generated from the workflow. displays the workflow run name in the list o... | {
"source": "github-docs/actions/reference/workflows-and-actions/workflow-syntax.md",
"title": "Workflow syntax for GitHub Actions"
} |
This tutorial leads you through how to use the GITHUBTOKEN for authentication in workflows, including examples for passing the token to actions, making API requests, and configuring permissions for secure automation.
For reference information, see AUTOTITLE.
Using the GITHUBTOKEN in a workflow
You can use the GITHUBT... | {
"source": "github-docs/actions/tutorials/authenticate-with-github_token.md",
"title": "Use GITHUB_TOKEN for authentication in workflows"
} |
Introduction
This guide shows you how to build, test, and publish a Go package.
-hosted runners have a tools cache with preinstalled software, which includes the dependencies for Go. For a full list of up-to-date software and the preinstalled versions of Go, see AUTOTITLE.
Prerequisites
You should already be familiar ... | {
"source": "github-docs/actions/tutorials/build-and-test-code/go.md",
"title": "Building and testing Go"
} |
Introduction
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Ant build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that... | {
"source": "github-docs/actions/tutorials/build-and-test-code/java-with-ant.md",
"title": "Building and testing Java with Ant"
} |
Introduction
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Gradle build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure t... | {
"source": "github-docs/actions/tutorials/build-and-test-code/java-with-gradle.md",
"title": "Building and testing Java with Gradle"
} |
Introduction
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Maven software project management tool. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approac... | {
"source": "github-docs/actions/tutorials/build-and-test-code/java-with-maven.md",
"title": "Building and testing Java with Maven"
} |
Introduction
This guide shows you how to build, test, and publish a .NET package.
-hosted runners have a tools cache with preinstalled software, which includes the .NET Core SDK. For a full list of up-to-date software and the preinstalled versions of .NET Core SDK, see software installed on -hosted runners.
Prerequis... | {
"source": "github-docs/actions/tutorials/build-and-test-code/net.md",
"title": "Building and testing .NET"
} |
Introduction
This guide shows you how to create a continuous integration (CI) workflow that builds and tests Node.js code. If your CI tests pass, you may want to deploy your code or publish a package.
Prerequisites
We recommend that you have a basic understanding of Node.js, YAML, workflow configuration options, and h... | {
"source": "github-docs/actions/tutorials/build-and-test-code/nodejs.md",
"title": "Building and testing Node.js"
} |
Introduction
This guide shows you how to use PowerShell for CI. It describes how to use Pester, install dependencies, test your module, and publish to the PowerShell Gallery.
-hosted runners have a tools cache with pre-installed software, which includes PowerShell and Pester.
For a full list of up-to-date software and ... | {
"source": "github-docs/actions/tutorials/build-and-test-code/powershell.md",
"title": "Building and testing PowerShell"
} |
Introduction
This guide shows you how to build, test, and publish a Python package.
-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see AUTOTITLE.... | {
"source": "github-docs/actions/tutorials/build-and-test-code/python.md",
"title": "Building and testing Python"
} |
Introduction
This guide shows you how to create a continuous integration (CI) workflow that builds and tests a Ruby application. If your CI tests pass, you may want to deploy your code or publish a gem.
Prerequisites
We recommend that you have a basic understanding of Ruby, YAML, workflow configuration options, and ho... | {
"source": "github-docs/actions/tutorials/build-and-test-code/ruby.md",
"title": "Building and testing Ruby"
} |
Introduction
This guide shows you how to build, test, and publish a Rust package.
-hosted runners have a tools cache with preinstalled software, which includes the dependencies for Rust. For a full list of up-to-date software and the preinstalled versions of Rust, see AUTOTITLE.
Prerequisites
You should already be fam... | {
"source": "github-docs/actions/tutorials/build-and-test-code/rust.md",
"title": "Building and testing Rust"
} |
Introduction
This guide shows you how to build and test a Swift package.
-hosted runners have a tools cache with preinstalled software, and the Ubuntu and macOS runners include the dependencies for building Swift packages. For a full list of up-to-date software and the preinstalled versions of Swift and Xcode, see AUTO... | {
"source": "github-docs/actions/tutorials/build-and-test-code/swift.md",
"title": "Building and testing Swift"
} |
Introduction
This guide shows you how to create a workflow that performs continuous integration (CI) for your Xamarin project. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always hea... | {
"source": "github-docs/actions/tutorials/build-and-test-code/xamarin-apps.md",
"title": "Building and testing Xamarin applications"
} |
Introduction
In this guide, you'll learn about the basic components needed to create and use a packaged composite action. To focus this guide on the components needed to package the action, the functionality of the action's code is minimal. The action prints "Hello World" and then "Goodbye", or if you provide a custom ... | {
"source": "github-docs/actions/tutorials/create-actions/create-a-composite-action.md",
"title": "Creating a composite action"
} |
Introduction
In this guide, you'll learn about the basic components needed to create and use a packaged JavaScript action. To focus this guide on the components needed to package the action, the functionality of the action's code is minimal. The action prints "Hello World" in the logs or "Hello [who-to-greet]" if you p... | {
"source": "github-docs/actions/tutorials/create-actions/create-a-javascript-action.md",
"title": "Creating a JavaScript action"
} |
Introduction
This guide shows you how to create a basic workflow that is triggered when code is pushed to your repository.
[!IMPORTANT] For more information about best practices for securing your workflows and secure use of features, see AUTOTITLE. | {
"source": "github-docs/actions/tutorials/create-an-example-workflow.md",
"title": "Creating an example workflow"
} |
Introduction
This tutorial demonstrates how to use the to comment on an issue when a specific label is applied. For example, when the help wanted label is added to an issue, you can add a comment to encourage contributors to work on the issue. For more information about , see AUTOTITLE.
In the tutorial, you will first... | {
"source": "github-docs/actions/tutorials/manage-your-work/add-comments-with-labels.md",
"title": "Commenting on an issue when a label is added"
} |
Introduction
This tutorial demonstrates how to use the in a workflow to label newly opened or reopened issues. For example, you can add the triage label every time an issue is opened or reopened. Then, you can see all issues that need to be triaged by filtering for issues with the triage label.
The allows you to easi... | {
"source": "github-docs/actions/tutorials/manage-your-work/add-labels-to-issues.md",
"title": "Adding labels to issues"
} |
Introduction
This tutorial demonstrates how to use the actions/stale action to comment on and close issues that have been inactive for a certain period of time. For example, you can comment if an issue has been inactive for 30 days to prompt participants to take action. Then, if no additional activity occurs after 14 d... | {
"source": "github-docs/actions/tutorials/manage-your-work/close-inactive-issues.md",
"title": "Closing inactive issues"
} |
Introduction
This tutorial demonstrates how to use the to create an issue on a regular basis. For example, you can create an issue each week to use as the agenda for a team meeting. For more information about , see AUTOTITLE.
In the tutorial, you will first make a workflow file that uses the . Then, you will customize... | {
"source": "github-docs/actions/tutorials/manage-your-work/schedule-issue-creation.md",
"title": "Scheduling issue creation"
} |
About migrating from Azure DevOps with GitHub Actions Importer
The instructions below will guide you through configuring your environment to use to migrate Azure DevOps pipelines to .
Prerequisites
An Azure DevOps account or organization with projects and pipelines that you want to convert to workflows.
Access to ... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/automated-migrations/azure-devops-migration.md",
"title": "Migrating from Azure DevOps with GitHub Actions Importer"
} |
About migrating from Bamboo with GitHub Actions Importer
The instructions below will guide you through configuring your environment to use to migrate Bamboo pipelines to .
Prerequisites
A Bamboo account or organization with projects and pipelines that you want to convert to workflows.
Bamboo version of 7.1.1 or gr... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/automated-migrations/bamboo-migration.md",
"title": "Migrating from Bamboo with GitHub Actions Importer"
} |
About migrating from Bitbucket Pipelines with GitHub Actions Importer
The instructions below will guide you through configuring your environment to use to migrate Bitbucket Pipelines to .
Prerequisites
Limitations
There are some limitations when migrating from Bitbucket Pipelines to with .
Images in a private AWS ... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/automated-migrations/bitbucket-pipelines-migration.md",
"title": "Migrating from Bitbucket Pipelines with GitHub Actions Importer"
} |
About migrating from CircleCI with GitHub Actions Importer
The instructions below will guide you through configuring your environment to use to migrate CircleCI pipelines to .
Prerequisites
A CircleCI account or organization with projects and pipelines that you want to convert to workflows.
Access to create a Circ... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/automated-migrations/circleci-migration.md",
"title": "Migrating from CircleCI with GitHub Actions Importer"
} |
About migrating from GitLab with GitHub Actions Importer
The instructions below will guide you through configuring your environment to use to migrate GitLab pipelines to .
Prerequisites
A GitLab account or organization with pipelines and jobs that you want to convert to workflows.
Access to create a GitLab for yo... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/automated-migrations/gitlab-migration.md",
"title": "Migrating from GitLab with GitHub Actions Importer"
} |
About migrating from Jenkins with GitHub Actions Importer
The instructions below will guide you through configuring your environment to use to migrate Jenkins pipelines to .
Prerequisites
A Jenkins account or organization with pipelines and jobs that you want to convert to workflows.
Access to create a Jenkins per... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/automated-migrations/jenkins-migration.md",
"title": "Migrating from Jenkins with GitHub Actions Importer"
} |
About migrating from Travis CI with GitHub Actions Importer
The instructions below will guide you through configuring your environment to use to migrate Travis CI pipelines to .
Prerequisites
A Travis CI account or organization with pipelines and jobs that you want to convert to workflows.
Access to create a Travi... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/automated-migrations/travis-ci-migration.md",
"title": "Migrating from Travis CI with GitHub Actions Importer"
} |
About
You can use to plan and automatically migrate your CI/CD supported pipelines to .
is distributed as a Docker container, and uses a CLI extension to interact with the container.
Any workflow that is converted by the should be inspected for correctness before using it as a production workload. The goal is to a... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/automated-migrations/use-github-actions-importer.md",
"title": "Automating migration with GitHub Actions Importer"
} |
Introduction
Azure Pipelines and both allow you to create workflows that automatically build, test, publish, release, and deploy code. Azure Pipelines and share some similarities in workflow configuration:
Workflow configuration files are written in YAML and are stored in the code's repository.
Workflows include on... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-azure-pipelines.md",
"title": "Migrating from Azure Pipelines to GitHub Actions"
} |
Introduction
CircleCI and both allow you to create workflows that automatically build, test, publish, release, and deploy code. CircleCI and share some similarities in workflow configuration:
Workflow configuration files are written in YAML and stored in the repository.
Workflows include one or more jobs.
Jobs inc... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-circleci.md",
"title": "Migrating from CircleCI to GitHub Actions"
} |
Introduction
GitLab CI/CD and both allow you to create workflows that automatically build, test, publish, release, and deploy code. GitLab CI/CD and share some similarities in workflow configuration:
Workflow configuration files are written in YAML and are stored in the code's repository.
Workflows include one or m... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-gitlab-cicd.md",
"title": "Migrating from GitLab CI/CD to GitHub Actions"
} |
Introduction
Jenkins and both allow you to create workflows that automatically build, test, publish, release, and deploy code. Jenkins and share some similarities in workflow configuration:
Jenkins creates workflows using Declarative Pipelines, which are similar to workflow files.
Jenkins uses stages to run a coll... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-jenkins.md",
"title": "Migrating from Jenkins to GitHub Actions"
} |
Introduction
This guide helps you migrate from Travis CI to . It compares their concepts and syntax, describes the similarities, and demonstrates their different approaches to common tasks.
Before you start
Before starting your migration to , it would be useful to become familiar with how it works:
For a quick exampl... | {
"source": "github-docs/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-travis-ci.md",
"title": "Migrating from Travis CI to GitHub Actions"
} |
You can run workflows on -hosted or self-hosted runners, or use a mixture of runner types.
This tutorial shows you how to assess your current use of runners, then migrate workflows from self-hosted runners to -hosted runners efficiently.
1. Assess your current CI infrastructure
Migrating from self-hosted runners to -h... | {
"source": "github-docs/actions/tutorials/migrate-to-github-runners.md",
"title": "Migrating from self-hosted runners to GitHub-hosted runners"
} |
Introduction
This guide shows you how to create a workflow that performs a Docker build, and then publishes Docker images to Docker Hub or . With a single workflow, you can publish images to a single registry or to multiple registries.
[!NOTE]
If you want to push to another third-party Docker registry, the example in... | {
"source": "github-docs/actions/tutorials/publish-packages/publish-docker-images.md",
"title": "Publishing Docker images"
} |
Introduction
Prerequisites
We recommend that you have a basic understanding of workflow files and configuration options. For more information, see AUTOTITLE.
For more information about creating a CI workflow for your Java project with Gradle, see AUTOTITLE.
You may also find it helpful to have a basic understanding of... | {
"source": "github-docs/actions/tutorials/publish-packages/publish-java-packages-with-gradle.md",
"title": "Publishing Java packages with Gradle"
} |
Introduction
Prerequisites
We recommend that you have a basic understanding of workflow files and configuration options. For more information, see AUTOTITLE.
For more information about creating a CI workflow for your Java project with Maven, see AUTOTITLE.
You may also find it helpful to have a basic understanding of ... | {
"source": "github-docs/actions/tutorials/publish-packages/publish-java-packages-with-maven.md",
"title": "Publishing Java packages with Maven"
} |
Introduction
This guide shows you how to create a workflow that publishes Node.js packages to the and npm registries after continuous integration (CI) tests pass.
Prerequisites
We recommend that you have a basic understanding of workflow configuration options and how to create a workflow file. For more information, s... | {
"source": "github-docs/actions/tutorials/publish-packages/publish-nodejs-packages.md",
"title": "Publishing Node.js packages"
} |
Prerequisites
Before you can complete this tutorial, you need to understand workflow artifacts. See AUTOTITLE.
Uploading build and test artifacts
The output of building and testing your code often produces files you can use to debug test failures and production code that you can deploy. You can configure a workflow to... | {
"source": "github-docs/actions/tutorials/store-and-share-data.md",
"title": "Store and share data with workflow artifacts"
} |
Prerequisites
In order to use ARC, ensure you have the following.
A Kubernetes cluster
For a managed cloud environment, you can use AKS. For more information, see Azure Kubernetes Service in the Azure documentation.
For a local setup, you can use minikube or kind. For more information, see minikube start in the ... | {
"source": "github-docs/actions/tutorials/use-actions-runner-controller/get-started.md",
"title": "Get started with Actions Runner Controller"
} |
Logging
The (ARC) resources, which include the controller, listener, and runners, write logs to standard output (stdout). We recommend you implement a logging solution to collect and store these logs. Having logs available can help you or GitHub support with troubleshooting and debugging. For more information, see Log... | {
"source": "github-docs/actions/tutorials/use-actions-runner-controller/troubleshoot.md",
"title": "Troubleshooting Actions Runner Controller errors"
} |
Introduction
In this guide, you'll learn about the basic components needed to create and use a packaged Docker container action. To focus this guide on the components needed to package the action, the functionality of the action's code is minimal. The action prints "Hello World" in the logs or "Hello [who-to-greet]" if... | {
"source": "github-docs/actions/tutorials/use-containerized-services/create-a-docker-container-action.md",
"title": "Creating a Docker container action"
} |
Dockerfile
# Container image that runs your code
FROM alpine:3.10
# Copies your code file from your action repository to the filesystem path `/` of the container
COPY entrypoint.sh /entrypoint.sh
# Code file to execute when the docker container starts up (`entrypoint.sh`)
ENTRYPOINT ["/entrypoint.sh"]
Creating an acti... | {
"source": "github-docs/actions/tutorials/use-containerized-services/create-a-docker-container-action.md",
"title": "Creating a Docker container action"
} |
Introduction
This guide shows you workflow examples that configure a service container using the Docker Hub postgres image. The workflow runs a script that connects to the PostgreSQL service, creates a table, and then populates it with data. To test that the workflow creates and populates the PostgreSQL table, the scri... | {
"source": "github-docs/actions/tutorials/use-containerized-services/create-postgresql-service-containers.md",
"title": "Creating PostgreSQL service containers"
} |
Introduction
This guide shows you workflow examples that configure a service container using the Docker Hub redis image. The workflow runs a script to create a Redis client and populate the client with data. To test that the workflow creates and populates the Redis client, the script prints the client's data to the con... | {
"source": "github-docs/actions/tutorials/use-containerized-services/create-redis-service-containers.md",
"title": "Creating Redis service containers"
} |
Communicating with Docker service containers
Service containers are Docker containers that provide a simple and portable way for you to host services that you might need to test or operate your application in a workflow. For example, your workflow might need to run integration tests that require access to a database an... | {
"source": "github-docs/actions/tutorials/use-containerized-services/use-docker-service-containers.md",
"title": "Communicating with Docker service containers"
} |
About administrative shell access
If you have SSH access to the administrative shell, you can run 's command line utilities. SSH access is also useful for troubleshooting, running backups, and configuring replication. Administrative SSH access is managed separately from Git SSH access and is accessible only via port 12... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md",
"title": "Accessing the administrative shell (SSH)"
} |
Host HOSTNAME
IdentityFile /path/to/ghe_private_key
User admin
Port 122
Accessing the administrative shell using the local console
In an emergency situation, for example if SSH is unavailable, you can access the administrative shell locally if your hypervisor provides console access. Press Alt + F2 to switch to ... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md",
"title": "Accessing the administrative shell (SSH)"
} |
About the gh es extension for
For more information about the , see AUTOTITLE.
gh es is a extension that allows you to perform administrative tasks on by using the instance's REST API endpoints. For more information about GitHub CLI extensions, see AUTOTITLE.
You can use the gh es extension to manage the root site a... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli.md",
"title": "Administering your instance using the GitHub CLI"
} |
You can execute these commands from anywhere on the VM after signing in as an SSH admin user. For more information, see AUTOTITLE.
All utilities accept -h or --help to display usage information.
General
ghe-announce
This utility sets a banner at the top of every page. You can use it to broadcast a message to your us... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md",
"title": "Command-line utilities"
} |
Flag Description
---- ----------
-v/--verbose Run in verbose mode.
-p/--pretty Display in table format.
ghe-check-disk-usage
This utility checks the disk for large files or files that have been deleted but still have open file handles. This should be run when you're trying to free up space on the root partition.
g... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md",
"title": "Command-line utilities"
} |
Flag Description
---- ----------
--error-checks-only Only run high severity checks that should be treated as blocking errors.
--warning-checks-only Only run low severity checks that can be treated as warnings.
ghe-crypto
This utility is used to verify and list github-ssl crypto settings for TLS and SSH connection... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md",
"title": "Command-line utilities"
} |
All Storage tests passed
### ghe-actions-test-storage-with-oidc
This utility checks that the blob storage provider for {% data variables.product.prodname_actions %} on {% data variables.location.product_location %} is valid when OpenID Connect (OIDC) is used.
> [!NOTE]
> This utility only works with configurations that... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md",
"title": "Command-line utilities"
} |
All Storage tests passed
### ghe-packages-precheck
This utility checks that a blob storage provider for {% data variables.product.prodname_registry %} is valid on {% data variables.location.product_location %}. Use this to verify your storage configuration before enabling {% data variables.product.prodname_registry %}.... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md",
"title": "Command-line utilities"
} |
About the
The allows you to manage the low-level configuration of . For example, you can complete initial setup, manage licensing and low-level settings, configure authentication, schedule maintenance windows, and monitor your instance.
You can always reach the using 's IP address, even when the instance is in maint... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-web-ui/about-the-management-console.md",
"title": "About the Management Console"
} |
Accessing the
The first time that you access the for , you must upload your license file. For more information, see AUTOTITLE.
Accessing the as an unauthenticated user
1. Visit this URL in your browser, replacing hostname with your actual hostname or IP address:
shell
http(s)://HOSTNAME/setup | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-web-ui/accessing-the-management-console.md",
"title": "Accessing the Management Console"
} |
For more information about access, see AUTOTITLE.
You can also use the gh es extension to manage the root site administrator password, which controls access to the Management Console. For more information, see the GH ES CLI usage documentation and AUTOTITLE.
Types of accounts
There are two types of user accounts fo... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-access-to-the-management-console.md",
"title": "Managing access to the Management Console"
} |
About search for
Users can search your instance to find, navigate, and understand issues, pull requests, code, and other content on . Elasticsearch powers the search functionality on your instance. You can view the current status of Elasticsearch, and you can control search and index behavior.
For more information abo... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-search-indices-for-your-instance.md",
"title": "Managing search indices for your instance"
} |
About problems with access
If you experience problems accessing the Management Console, you can try the following troubleshooting steps.
Unlocking the after failed login attempts
The locks after the number of failed login attempts configured by your authentication policies. For more information, see AUTOTITLE.
Unl... | {
"source": "github-docs/admin/administering-your-instance/administering-your-instance-from-the-web-ui/troubleshooting-access-to-the-management-console.md",
"title": "Troubleshooting access to the Management Console"
} |
About maintenance mode
Some types of operations require that you take offline and put it into maintenance mode:
Upgrading to a new version of
Increasing CPU, memory, or storage resources allocated to the virtual machine
Migrating data from one virtual machine to another
Restoring data from a snapshot
Troublesho... | {
"source": "github-docs/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode.md",
"title": "Enabling and scheduling maintenance mode"
} |
See AUTOTITLE.
Releases of
supports at least the four most recent feature releases.
We provide documentation for both supported and unsupported versions of . We do not maintain or update the documentation for unsupported versions.
For information about the latest release, see the website.
Version Candidate Relea... | {
"source": "github-docs/admin/all-releases.md",
"title": "GitHub Enterprise Server releases"
} |
[!NOTE] is currently in and subject to change. The service is available at no additional cost and will remain free.
About the
The is a managed backup solution built directly into . It offers a simplified alternative to the legacy .
With this service, you can:
Configure scheduled backups from the .
View backup st... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/about-the-backup-service-for-github-enterprise-server.md",
"title": "About the backup service for GitHub Enterprise Server"
} |
Configuring backups from a replica node
For high availability, you can designate a replica node as your backup server. To minimize latency, recommends picking a replica node in the same region or datacenter as your primary node.
[!IMPORTANT]
Backups from cache replica nodes or active geo replica nodes are not suppor... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/backup-from-replica-in-high-availability.md",
"title": "Backup from replica in high availability"
} |
Configuring backups from a cluster node
For clustering, you can designate a node as your backup server. To minimize latency, recommends picking a data node (for example, a mysql-server node or a git-server node) instead of a frontend node.
[!IMPORTANT]
Only one node can be specified as a backup-server node.
1. To co... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/backup-in-clustering-mode.md",
"title": "Backup in clustering mode"
} |
You can configure the following options in the "Backup Service" section of the .
Snapshot retention
Number of snapshots: Sets how many backup snapshots to retain (default: 10). Older snapshots are automatically pruned after each successful backup.
[!NOTE]
You can run the ghe-backup-prune-snapshots utility to prune ... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/backup-service-settings-reference.md",
"title": "Backup service settings reference"
} |
[!IMPORTANT] is now the preferred solution for backing up a appliance. is scheduled for removal in version 3.22
About
is a backup system you install on a separate host, which takes backup snapshots of at regular intervals over a secure SSH network connection. You can use a snapshot to restore an existing insta... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance.md",
"title": "Configuring backups on your instance with Backup Utilities"
} |
If you are running 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 simil... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/configuring-remote-archives-for-backups.md",
"title": "Configuring remote archives for backups"
} |
Before configuring the backup service, ensure you have:
A instance running version 3.17 or later.
A dedicated storage volume provisioned and managed for use as the backup target.
Storage requirements
To ensure reliable and performant backups, your storage must meet the following requirements:
Capacity: Allocate at... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/configuring-the-backup-service.md",
"title": "Configuring the backup service"
} |
About backup types
supports two types of backups:
Full backups: Capture a complete snapshot of all data. The first backup is always a full backup.
Incremental backups: Include only changes since the last backup, significantly reducing backup time and storage usage.
The system automatically determines which type to c... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/creating-and-monitoring-backups.md",
"title": "Creating and monitoring backups"
} |
You can restore a instance from a backup using the command line. The backup service supports full instance restoration, including configuration and user data.
[!WARNING] Restoring from a backup will overwrite all existing data on your instance. This operation cannot be undone.
Snapshot version requirements
You can on... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/restoring-from-a-backup.md",
"title": "Restoring from a backup"
} |
[!IMPORTANT] Data stored in your configured external storage for —such as logs, artifacts, and other blobs—is not included in snapshots. You must back up this data separately using your storage provider's tools and best practices.
When restoring an instance with enabled, follow these steps to preserve compatibility w... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/restoring-with-github-actions-enabled.md",
"title": "Restoring with GitHub Actions enabled"
} |
Does backing up or restoring impact performance?
Yes, but minimally—especially for production workloads.
During backup and restore, Git background maintenance and storage jobs are paused for the affected stages (e.g., repositories, storage). This may result in a temporary backlog visible in instance metrics.
For freq... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/understanding-the-backup-service.md",
"title": "Understanding the backup service"
} |
Backup timeline example
M---8:00--16:00---T---8:00--16:00---W... (timeline)
F-----------------F-----------------F... (full backup)
#-----D-----D-----#-----D-----D-----#... (differential backup)
T--T--T--T--T--T--T--T--T--T--T--T--T... (transaction log backup)
To optimize space, hard links point to previously created ba... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/understanding-the-backup-service.md",
"title": "Understanding the backup service"
} |
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, , and other components are stored using hard links to optimize storage and enable efficient point-in-time restore... | {
"source": "github-docs/admin/backing-up-and-restoring-your-instance/understanding-the-snapshot-file-structure.md",
"title": "Understanding the snapshot file structure"
} |
Use organizations for work or governance
There are two main models of using organizations:
Group related work projects: Group repositories for a specific application and related services. Teams that work on that application will then be able to communicate effectively and contribute across the different repositories.
... | {
"source": "github-docs/admin/concepts/enterprise-best-practices/organize-work.md",
"title": "Best practices for organizing work in your enterprise"
} |
You can use innersource practices to drive collaboration and productivity in your enterprise. Innersource makes it easy for all employees to discover and reuse work. This allows development teams to learn from each other's work, share their expertise, and avoid duplicating effort to recreate common services.
Make repo... | {
"source": "github-docs/admin/concepts/enterprise-best-practices/use-innersource.md",
"title": "Using innersource in your enterprise"
} |
Automation on typically involves multiple components working together. The most important native components are:
workflows, which provide a runtime for executing automation logic. Out of the box, they work within a single repository, but they can be extended to automate across or even outside of repositories.
, wh... | {
"source": "github-docs/admin/concepts/enterprise-fundamentals/automations-in-your-enterprise.md",
"title": "Automations in your enterprise"
} |
Before you create your enterprise account, you must choose an enterprise type:
Enterprise with personal accounts
Enterprise with managed users
To decide which is best for your enterprise, ask yourself the following questions.
Do you want to control users' accounts?
may be right for your enterprise if you don't want... | {
"source": "github-docs/admin/concepts/enterprise-fundamentals/choose-an-enterprise-type.md",
"title": "Choosing an enterprise type for GitHub Enterprise Cloud"
} |
An enterprise account is the central point of administration for your business on . 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.
This guide provides a... | {
"source": "github-docs/admin/concepts/enterprise-fundamentals/enterprise-accounts.md",
"title": "Enterprise accounts"
} |
What are roles?
Roles allow you to delegate administrative duties and manage access securely at every level of your enterprise.
A role is a set of permissions that you can assign to individuals or teams. A permission is the ability to perform a specific action, such as changing billing settings.
A user in an enterprise... | {
"source": "github-docs/admin/concepts/enterprise-fundamentals/roles-in-an-enterprise.md",
"title": "Roles in an enterprise"
} |
What are teams?
Teams are groups of users in an enterprise or organization. By creating teams, you can manage users at scale and simplify access, licensing, and communication. For example, you could create an auditor team for users who need access to audit logs, or a team for users who receive licenses.
Enterprise te... | {
"source": "github-docs/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise.md",
"title": "Teams in an enterprise"
} |
What are Enterprise Managed Users in ?
With , you manage the lifecycle and authentication of your users on or from an external identity management system, or IdP:
Your IdP provisions new user accounts on , with access to your enterprise.
Users must authenticate on your IdP to access your enterprise's resources on .... | {
"source": "github-docs/admin/concepts/identity-and-access-management/enterprise-managed-users.md",
"title": "About {% data variables.product.prodname_emus %}"
} |
What is IAM for ?
After learning more about authentication and provisioning for each of these options, to determine which method is best for your enterprise, see AUTOTITLE.
Administrators who configure a instance can use local accounts and built-in authentication on the instance. Alternatively, to centralize identity ... | {
"source": "github-docs/admin/concepts/identity-and-access-management/identity-and-access-management-fundamentals.md",
"title": "Identity and access management fundamentals"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.