aldhinn/gh-self repository overview

⁠

gh-self

/

gh-self is a set of open source docker images for running GitHub Actions workflows.

⁠🚀 Usage

This image provides a self-hosted runner for GitHub Actions. When setting up and running the container, you need to map local files containing your GitHub repository URL and runner registration token to the appropriate secrets within the container.

⁠📝 Preparations

Before using this self-hosted runner, make sure you have:

1. A GitHub repository for which you will be running workflows.

2. A GitHub runner registration token (provided when setting up a new self-hosted runner for your repository).

   You can get this token by following these steps:

   • Go to Settings > Actions > Runners in your GitHub repository.
   • Click New self-hosted runner and under the instructions to Configure, you will see the token value written in such manner.

   ./config.sh --url https://github.com/your-org/your-repo --token <TOKEN_VALUE>
   

   Copy
   • Keep this token value safe, as it will be needed to authenticate the runner.

⁠⚙️ Steps to Run the Self-Hosted Runner

1. Prepare the required files:

   • Create a file GITHUB_REPO_FILE containing the URL to your GitHub repository (e.g., https://github.com/your-org/your-repo).
   • Create a file TOKEN_VALUE_FILE containing the GitHub runner registration token stored earlier⁠.

2. Run the Docker container:

   When running the Docker container, make sure to map the local files (GITHUB_REPO_FILE and TOKEN_VALUE_FILE) to the correct paths inside the container where GitHub Actions will look for them. Use the following command:

   docker run -d --name github-actions-self-hosed-runner \
     -v /local/path/to/GITHUB_REPO_FILE:/run/secrets/GITHUB_REPO_FILE \
     -v /local/path/to/TOKEN_VALUE_FILE:/run/secrets/TOKEN_VALUE_FILE \
     aldhinn/gh-self:amd64-debian
   

   Copy

   (The example above used the tag amd64-debian but choose the ones you'd like from here⁠.)

   Optionally, you can also specify the name of the runner by storing it to /run/secrets/GITHUB_RUNNER_NAME_FILE:

   docker run -d --name github-actions-self-hosed-runner \
     -v /local/path/to/GITHUB_REPO_FILE:/run/secrets/GITHUB_REPO_FILE \
     -v /local/path/to/TOKEN_VALUE_FILE:/run/secrets/TOKEN_VALUE_FILE \
     -v /local/path/to/GITHUB_RUNNER_NAME_FILE:/run/secrets/GITHUB_RUNNER_NAME_FILE \
     aldhinn/gh-self:amd64-debian
   

   Copy