diff --git a/gitea/act-runner.md b/gitea/act-runner.md index 6b17d68..8d086ab 100644 --- a/gitea/act-runner.md +++ b/gitea/act-runner.md @@ -3,11 +3,11 @@ ### Releases Gitea publishes binary releases of [gitea/act_runner](https://gitea.com/gitea/act_runner/releases) for many platform and architectures, which can be used to deploy new action runners simply. -The following example uses `gitea/act_runner` 0.2.6 on macOS Ventura 13.3 x64. +The following example uses `gitea/act_runner` 0.2.6 to deploy a runner on macOS Ventura 13.3 x64. ### Registration Token -> Note: Runners can be registered globally for an entire Gitea instance, for a specific organization, or for a single repo. This example assumes registering the runner globally. +> Note: Runners can be registered globally for an entire Gitea instance, for a specific organization, or for a single repo. This example registers globally. Before executing the runner, first obtain a registration token by visiting http://gitea.local:3000/admin/actions/runners, clicking the 'Create new Runner' button, and copying the displayed registration token, for example, `FTyMBkcK9ErmD0wm8LfBzfXOUUlQA7dBJF6BB64Z`. @@ -17,10 +17,10 @@ registration token, for example, `FTyMBkcK9ErmD0wm8LfBzfXOUUlQA7dBJF6BB64Z`. After you have obtained a registration token, download the `gitea/act_runner` release matching your platform and architecture and run it as follows: ``` -# Download latest gitea/act_runner release. +# Download latest gitea/act_runner release for your platform. $ wget https://gitea.com/gitea/act_runner/releases/download/latest/act_runner-0.2.6-darwin-amd64 && chmod a+x act_runner-0.2.6-darwin-amd64 -# Register the runner with the Gitea instance. +# Register the runner with the Gitea instance using the token obtained above. $ ./act_runner-0.2.6-darwin-amd64 register \ --instance http://gitea.local:3000 \ --labels 'darwin-latest-amd64:host,darwin-13-amd64:host' \ @@ -35,9 +35,8 @@ $ ./act_runner-0.2.6-darwin-amd64 daemon ### Labels The most important detail in this example is the label. For the Ubuntu runner which is deployed automatically with this project, the label `ubuntu-latest:docker://cerc/act-runner-task-executor:local` is -used, which instructs `gitea/act_runner` that tasks should be executed inside an instance of the `cerc/act-runner-task-executor:local` Docker container. In this example, the label is `darwin-latest-amd64:host`. -This means that tasks will be executed directly on the host. Since there are additional security implications when executing tasks on the host, only trusted repositories with strict access controls -should be allowed to schedule CI jobs on the runner. +used, which instructs `gitea/act_runner` that a task which `runs-on: ubuntu-latest` should be executed inside an instance of the `cerc/act-runner-task-executor:local` Docker container. In this example, the label is `darwin-latest-amd64:host`. This means that a task which `runs-on: darwin-latest-amd64` will be executed natively on the host machine. Since there are additional security implications when executing tasks +on the host, only trusted repositories with strict access controls should be allowed to schedule CI jobs on the runner. ### Example Workflow