diff --git a/README.md b/README.md index 168e3f56245ea2488397c2f34f0ebe94e86c8856..3521b29ebae1c7b40cbd27d43c03edd82bb3fa3a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ -# cx-custom-gitlab-runner +# Runner setup +First, the runner has to be set up as a custom runner and registered with the corresponding GitLab instance following the standard procedure. +The config (example in `runner_config`) needs to be adjusted to point with their `config_exec` and `run_exec` entries to the respective scripts in the runner_scripts folder. +Scripts need to be selected depending on runner privileges: `root` (allows change of users) or `user` (can only execute jobs as this user). +Note, that paths in those scripts might need to be adjusted. + +# Cx with `.gitlab-ci.yml` + +First, the username to authenticate with has to be set using the `AUTH_USER` variable. +Second, a key pair has to be generated, of which the private key is added as a CI variable `AUTH_KEY` in reposity settings > CI/CD. +The public one has to be added to `~/gitlab-runner/authorized_keys`, where `~` signifies the `AUTH_USER`'s home. + +An example `.gitlab-ci.yml` file can be found in the root of this repository.