Files
bircni 8700adc933 feat: config command to edit config files (#1140)
Changing a setting after `generate-config` meant hand-editing YAML, which is awkward in provisioning scripts. `config` now edits an existing file in place:

```bash
./gitea-runner -c config.yaml config set runner.capacity 4
./gitea-runner -c config.yaml config set runner.envs.MY_VAR value
./gitea-runner -c config.yaml config add runner.labels 'ubuntu:docker://node:22'
./gitea-runner -c config.yaml config remove runner.labels 'ubuntu:docker://node:22'
./gitea-runner -c config.yaml config get runner.labels
```

Edits go through the YAML node tree, so comments, key order and the blank lines between top-level sections survive — a test asserts that appending a label to `config.example.yaml` changes nothing but the added line. Keys are resolved by reflecting over the `Config` struct's yaml tags, so an unknown key or a value of the wrong type is rejected before the file is touched. The write is atomic and keeps the file's symlink, owner, mode and line endings.

---------

Co-authored-by: silverwind <2021+silverwind@noreply.gitea.com>
Co-authored-by: silverwind <me@silverwind.io>
Reviewed-on: https://gitea.com/gitea/runner/pulls/1140
Reviewed-by: silverwind <2021+silverwind@noreply.gitea.com>
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: bircni <bircni@icloud.com>
2026-08-05 16:48:25 +00:00
..
2026-07-13 18:41:19 +00:00

Running the runner as a systemd service

gitea-runner.service is an example unit for running the runner as a background service on a systemd host.

Setup

  1. Install the gitea-runner binary (e.g. to /usr/local/bin/gitea-runner).

  2. Create a dedicated user and working directory:

    sudo useradd --system --home-dir /var/lib/gitea-runner --create-home gitea-runner
    
  3. Generate a config and register the runner (as the service user), so the .runner file ends up in the working directory:

    sudo -u gitea-runner gitea-runner config generate > /etc/gitea-runner/config.yaml
    cd /var/lib/gitea-runner
    sudo -u gitea-runner gitea-runner register --config /etc/gitea-runner/config.yaml
    
  4. Install and enable the unit:

    sudo cp gitea-runner.service /etc/systemd/system/gitea-runner.service
    sudo systemctl daemon-reload
    sudo systemctl enable --now gitea-runner
    

Adjust the binary path, config path, working directory and user to match your installation. If jobs use the host's Docker daemon, uncomment the docker.service dependencies in the unit.