Skip to content

Remove the runner install template hack from docs #696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gabriel-samfira merged 1 commit into from
Mar 31, 2026
Merged

Remove the runner install template hack from docs #696

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 5 additions & 15 deletions doc/gitea.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ sudo iptables -I DOCKER-USER -j ACCEPT

### Create the docker compose

Create a docker compose file in `$HOME/compose.yaml`. This docker compose will deploy both gitea and GARM. If you already have a Gitea >=1.24.0, you can edit this docker compose to only deploy GARM.
Create a docker compose file in `$HOME/compose.yaml`. This docker compose will deploy both gitea and GARM. If you already have a Gitea >=1.24.0, you can edit this docker compose to only deploy GARM.

```yaml
networks:
Expand Down Expand Up @@ -86,8 +86,7 @@ sudo chown 1000:1000 /etc/gitea /etc/garm
Create the GARM configuration file:

```bash

sudo tee /etc/garm/config.toml <<EOF
sudo tee /etc/garm/config.toml > /dev/null <<'EOF'
[default]
enable_webhook_management = true

Expand Down Expand Up @@ -138,7 +137,7 @@ EOF
Create the LXD provider config file:

```bash
sudo tee /etc/garm/garm-provider-lxd.toml <<EOF
sudo tee /etc/garm/garm-provider-lxd.toml > /dev/null <<'EOF'
# the path to the unix socket that LXD is listening on. This works if garm and LXD
# are on the same system, and this option takes precedence over the "url" option,
# which connects over the network.
Expand Down Expand Up @@ -320,14 +319,6 @@ garm-cli provider list

The one we configured is called `local_lxd`.

Before we add a pool, there is one more important detail to know. Right now, the default runner installation script is tailored for github. But most providers offer a way to override the runner install template via an opaque JSON field called `extra_specs`. We can set this field when creating the pool or update it any time later.

There is a sample extra specs file [in this github gist](https://gist.github.com/gabriel-samfira/d132169ec41d990bbe17e6097af94c4c). We can fetch it and use it when definig the pool:

```bash
curl -L -o $HOME/gitea-pool-specs.json https://gist.githubusercontent.com/gabriel-samfira/d132169ec41d990bbe17e6097af94c4c/raw/67d226d9115eca5e10b69eac5ecb04be91a48991/gitea-extra-specs.json
```

Now, add the pool:

```bash
Expand All @@ -339,8 +330,7 @@ garm-cli pool add \
--flavor default \
--enabled=true \
--min-idle-runners=1 \
--max-runners=5 \
--extra-specs-file=$HOME/gitea-pool-specs.json
--max-runners=5
```

You should now see 1 runner being spun up in LXD. You can check the status of the pool by doing:
Expand All @@ -355,4 +345,4 @@ To get more details about the runner, run:
garm-cli runner show RUNNER_NAME_GOES_HERE
```

That's it! You can now use GARM with Gitea. You can add more pools, more repos, more orgs, more endpoints and more providers.
That's it! You can now use GARM with Gitea. You can add more pools, more repos, more orgs, more endpoints and more providers.
Loading