actions/runner
1
0
Fork 0
mirror of https://github.com/actions/runner.git synced 2025-12-10 12:36:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e95d0d6ad46e454749cc5d69a7072df34a8e12f
runner/docs/automate.md
Ferenc Hammerl d4cdb633db Run config remove as user instead of root (#1127) 
* Run config remove as user instead of root

* Explain why the runner can't be a service on a container

* Fix typo
2021-06-04 11:30:03 -04:00

2.0 KiB
Raw Blame History

Automate Configuring Self-Hosted Runners

Export PAT

Before running any of these sample scripts, create a GitHub PAT and export it before running the script

export RUNNER_CFG_PAT=yourPAT

Create running as a service

Scenario: Run on a machine or VM (not container) which automates:

  • Resolving latest released runner
  • Download and extract latest
  • Acquire a registration token
  • Configure the runner
  • Run as a systemd (linux) or Launchd (osx) service

👉 Sample script here 👈

Run as a one-liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level)

curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/create-latest-svc.sh | bash -s yourorg/yourrepo

Why can't I use a container?

The runner is installed as a service using systemd and systemctl. Docker does not support systemd for service configuration on a container.

Uninstall running as service

Scenario: Run on a machine or VM (not container) which automates:

  • Stops and uninstalls the systemd (linux) or Launchd (osx) service
  • Acquires a removal token
  • Removes the runner

👉 Sample script here 👈

Repo level one liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level)

curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/remove-svc.sh | bash -s yourorg/yourrepo

Delete an offline runner

Scenario: Deletes a registered runner that is offline:

  • Ensures the runner is offline
  • Resolves id from name
  • Deletes the runner

👉 Sample script here 👈

Repo level one-liner. NOTE: replace with yourorg/yourrepo (repo level) or just yourorg (org level) and replace runnername

curl -s https://raw.githubusercontent.com/actions/runner/main/scripts/delete.sh | bash -s yourorg/yourrepo runnername