Skip to content

Commit 1ab6508

Browse files
committed
docs: Fix some install documentation issues
1 parent 1c5f14b commit 1ab6508

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ Use the token shown to you in the "New instance runner" wizard:
6161

6262
```bash
6363
# The endpoint of your GitLab instance
64-
export GITLAB_URL = "https://<your-gitlab-instance>"
64+
export GITLAB_URL="https://<your-gitlab-instance>"
6565

6666
# The runner token shown in the wizard
67-
export RUNNER_TOKEN = "glpat-..."
67+
export RUNNER_TOKEN="glpat-..."
6868

6969
sudo gitlab-runner register \
7070
--non-interactive \
@@ -83,11 +83,10 @@ Create a backup of current config, then download the config template and fill it
8383
cp /etc/gitlab-runner/config.toml /etc/gitlab-runner/config.toml.bak
8484

8585
# Download template
86-
curl -sL https://raw.githubusercontent.com/cloudscale-ch/fleeting-plugin-cloudscale/refs/heads/main/config/config.toml.template \
87-
> /etc/gitlab/runner-config.toml
86+
sudo curl -sL https://raw.githubusercontent.com/cloudscale-ch/fleeting-plugin-cloudscale/refs/heads/main/config/config.toml.template -o /etc/gitlab-runner/config.toml
8887

8988
# Edit config
90-
vim /etc/gitlab-runner-config.toml
89+
vim /etc/gitlab-runner/config.toml
9190
```
9291

9392
You should at least change the following values:
@@ -106,6 +105,9 @@ Having configured your runner thusly, install `fleeting-plugin-cloudscale` as de
106105
sudo gitlab-runner fleeting install
107106
```
108107

108+
> [!IMPORTANT]
109+
> Note the sudo - fleeting will fail to install the plugin without it.
110+
109111
Your runner should pick up config changes automatically. It may have to create its first autoscaled instance, before it is shown as online on your GitLab instance, but after that it should work without intervention.
110112

111113
The log may be helpful, if you run into trouble:

0 commit comments

Comments
 (0)