Skip to content
This repository was archived by the owner on Feb 11, 2025. It is now read-only.

Commit 4d73e26

Browse files
authored
Merge pull request #2 from fullstack-devops/bugfix/some-docu
add env variables docu
2 parents 1d6e2da + 97b31cb commit 4d73e26

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
11
# github-runner-base
2-
Base Image for github runner images in repo @fullstack-devops/github-runner
2+
Base Image for github runner images in repo @fullstack-devops/github-runner. Can also be used as standalone image.
3+
4+
---
5+
6+
## Environmental variables
7+
8+
### Required environmental variables
9+
10+
| Variable | Type | Description |
11+
|-------------------|--------|-------------------------------------------------------------------------------------------------------------------|
12+
| `GH_ORGANIZATION` | string | Points to the GitHub Organisation where the runner should be installed |
13+
| `GH_ACCESS_TOKEN` | string | Developer Token vor the GitHub Organisation<br> This Token can be personal and is onlv needed during installation |
14+
15+
### Optional environmental variables
16+
17+
For the helm values see the [values.yaml](helm/values.yaml), section `envValues`
18+
19+
| Variable | Type | Default | Description |
20+
|--------------|--------|--------------------------|----------------------------------------------------------------------|
21+
| `GH_URL` | string | `https://github.com` | For GitHub Enterprise support |
22+
| `GH_API_URL` | string | `https://api.github.com` | For GitHub Enterprise support eg.: `https://git.example.com/api/v3/` |

0 commit comments

Comments
 (0)