import{_ as e,c as s,o as i,ag as n}from"./chunks/framework.S-Qvb3wi.js";const k=JSON.parse('{"title":"What is Gitea Runner","description":"","frontmatter":{"sidebar_position":1,"slug":"/"},"headers":[],"relativePath":"runner/index.md","filePath":"runner/index.md"}'),t={name:"runner/index.md"};function r(l,a,h,p,o,d){return i(),s("div",null,a[0]||(a[0]=[n(`

What is Gitea Runner ​

Act runner is a runner for Gitea based on Gitea fork of act. This documentation is a copy of https://gitea.com/gitea/act_runner/src/branch/main/README.md . And it should be updated once that README changed.

Installation ​

Prerequisites ​

Docker Engine Community version is required for docker mode. To install Docker CE, follow the official install instructions.

Download pre-built binary ​

Visit here and download the right version for your platform.

Build from source ​

bash
make build

Build a docker image ​

bash
make docker

Register ​

bash
./act_runner register

And you will be asked to input:

  1. Gitea instance URL, like http://192.168.8.8:3000/. You should use your gitea instance ROOT_URL as the instance argument and you should not use localhost or 127.0.0.1 as instance IP;
  2. Runner token, you can get it from http://192.168.8.8:3000/-/admin/actions/runners;
  3. Runner name, you can just leave it blank;
  4. Runner labels, you can just leave it blank.

The process looks like:

text
INFO Registering runner, arch=amd64, os=darwin, version=0.1.5.
WARN Runner in user-mode.
INFO Enter the Gitea instance URL (for example, https://gitea.com/):
http://192.168.8.8:3000/
INFO Enter the runner token:
fe884e8027dc292970d4e0303fe82b14xxxxxxxx
INFO Enter the runner name (if set empty, use hostname: Test.local):

INFO Enter the runner labels, leave blank to use the default labels (comma-separated, for example, ubuntu-latest:docker://gitea/runner-images:ubuntu-latest):

INFO Registering runner, name=Test.local, instance=http://192.168.8.8:3000/, labels=[ubuntu-latest:docker://gitea/runner-images:ubuntu-latest ubuntu-22.04:docker://gitea/runner-images:ubuntu-22.04 ubuntu-20.04:docker://gitea/runner-images:ubuntu-20.04].
DEBU Successfully pinged the Gitea instance server
INFO Runner registered successfully.

You can also register with command line arguments.

bash
./act_runner register --instance http://192.168.8.8:3000 --token <my_runner_token> --no-interactive

If the registry succeed, it will run immediately. Next time, you could run the runner directly.

Run ​

bash
./act_runner daemon

Run with docker ​

bash
docker run -e GITEA_INSTANCE_URL=https://your_gitea.com -e GITEA_RUNNER_REGISTRATION_TOKEN=<your_token> -v /var/run/docker.sock:/var/run/docker.sock --name my_runner gitea/act_runner:nightly

Configuration ​

You can also configure the runner with a configuration file. The configuration file is a YAML file, you can generate a sample configuration file with ./act_runner generate-config.

bash
./act_runner generate-config > config.yaml

You can specify the configuration file path with -c/--config argument.

bash
./act_runner -c config.yaml register # register with config file
./act_runner -c config.yaml daemon # run with config file

You can read the latest version of the configuration file online at config.example.yaml.

Example Deployments ​

Check out the examples directory for sample deployment types.

`,32)]))}const u=e(t,[["render",r]]);export{k as __pageData,u as default};