Specifying The Custom Runner Server Startup Script

You can specify a custom runner server startup script using the --scripts option to specify a path to the folder that contains all your custom runner server scripts.

❗Important:

When using a custom scripts folder with the --scripts option, you must include all required setup and startup scripts including any scripts used by default (setup.sh, startup-x64.sh, startup-arm64.sh) plus your additional custom scripts. The application looks for scripts only in that folder, and missing scripts will cause errors. Copy the default scripts from the repository: scripts/setup.sh scripts/startup-x64.sh scripts/startup-arm64.sh

Setting Up Custom Scripts

For example, create a local folder called scripts:

mkdir scripts

Then, copy all required setup and startup scripts from the repository and customize the startup-x64.sh and startup-arm64.sh scripts as needed.

You can apply your custom scripts using the --scripts option as follows:

github-hetzner-runners --scripts ./scripts

Job Specific Custom Startup Script

The default server startup script is startup-x64.sh for the x64 architecture and startup-arm64.sh for the ARM64 architecture. However, you can use the startup-{name} label to select any custom script inside the scripts directory, where {name} matches the {name}.sh file inside the scripts folder.

✋ Note:	Note the .sh extension is assumed for the script {name}.

For example,

scripts/
scripts/custom.sh

job-name:
   runs-on: [self-hosted, startup-custom]