Skip to content

Commit 2a0b9b1

Browse files
more explanation in README.md
1 parent 5ca9b4a commit 2a0b9b1

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This repository provides the functionality to deploy the github actions runner o
99
| `hcloud_token` | string | "" | Defines the authentication token with which new machines are registered with the [hetzner cloud](https://www.hetzner.com/cloud). |
1010
| `ssh_private_key` | string | "~/.ssh/id_rsa" | Defines the path to the location of the private key. The private key is used together with the public key to connect to the machine. |
1111
| `ssh_public_key` | string | "~/.ssh/id_rsa.pub" | Defines the path to the location of the public key. The public key is used together with the private key to connect to the machine. |
12-
| `ssh_key_name` | string | `admin_ssh_key` | Defines the name for the ssh key added to the hetzner cloud. |
12+
| `ssh_key_name` | string | `admin_ssh_key` | Defines the name for the ssh key added to the hetzner cloud, as defined in ssh_private_key and ssh_public_key. Must be different from hetzner_additional_public_key_ids. |
1313
| `hetzner_machine_type` | string | "cx11" | Sets the machine type to use. |
1414
| `hetzner_machine_os` | string | "debian-10" | Defines the machine operating system to be installed. |
1515
| `hetzner_additional_public_key_ids` | []string | [] | Adds public keys to the server that are already registered with hetzner |
@@ -51,19 +51,23 @@ ssh_key_name="example-bot-ssh-key"
5151
```ini
5252
hcloud_token="<my-hcloud-token>"
5353

54-
hetzner_machine_type="cx21"
54+
hetzner_machine_type="cpx21"
5555
hetzner_machine_os="debian-10"
56+
# one of the keys in the hcloud project
5657
hetzner_additional_public_key_ids=["username@local-system"]
58+
# not needed for runner
5759
hetzner_machine_additional_packages=""
5860

61+
# comma separated list
5962
github_actions_runner_labels="example"
6063
github_actions_runner_replace_existing=false
6164
github_actions_runner_count=3
6265

63-
github_owner="example-repo-owner"
66+
github_owner="programmfabrik"
6467
github_authentication_user="example-bot"
6568
github_authentication_token="<example-bot personal access token>"
6669

70+
# not part of hetzner_additional_public_key_ids, see explanation above
6771
ssh_key_name="example-bot-ssh-key"
6872

6973
github_runner_type="org"

0 commit comments

Comments
 (0)