Configuration file

Storing configuration in a file is a convenient way to set up new and update existing runners in non-interactive mode. To fetch the data from the config file, add the --config flag to the command. For example:

buddy --yes update —-config="/home/buddy/config.yml"$

What you need to know

  • providing the --config flag requires an existing and parsable YAML file in the provided path
  • all fields are optional and can be skipped or empty
  • all flags overwrite the values from the config file

Supported flags

NameTypeDescription
--drainBooleanDefines whether the runner is set to draining mode.
--standalone-hostStringThe IP address of the main instance. Cannot be empty.
--tokenStringThe authorization token generated by the installation wizard. Can be regenerated with buddy configure
--runner-memoryNumberThe amount of RAM in MB allocated for the runner service.
--tagStringThe tag applied to the runner. If set to empty (tag: ""), the tag is cleared.
--cpusStringThe number of CPUs that can be used by the build actions on the runner. Can be equal to 0 (unlimited) or greater.
--memoryNumberThe amount of RAM in MB that can be used by the build actions on the runner. Can be equal to 0 (unlimited) or greater.
--concurrentStringThe number of concurrent pipeline runners on the runner. Can be equal to 0 (unlimited) or greater.
--internal-hostThe IP address that will be bound by the runner. Default value: empty (binds to all IP's on the server).
--external-hostThe external IP address of the server as seen by the primary server. Default value: the first detected external IP address.
--runner-internal-portNumberThe listening port of the runner. Can be changed if the port is taken. Must be > 0 or will be ignored.
--runner-external-portNumberThe external port of the runner to which Buddy self-hosted is connecting. Can be changed if the ports are mapped. Must be > 0 or will be ignored
--registry-internal-portNumberThe listening port of the registry. Can be changed if the port is taken. Must be > 0 or will be ignored.
--registry-external-portNumberThe external port of the registry to which Buddy self-hosted is connecting. Can be changed if the ports are mapped. Must be > 0 or will be ignored.

Example

standalone-host: "https://192.168.5.114"
name: "Runner-1"
tag: "tag-1"
cpus: 4
memory: 2048
shm: 256
concurrent: 4
token: 1a2b3c4d5e
internal-host: "0.0.0.0"
external-host: "3.3.3.3"
runner-internal-port: 1090
runner-external-port: 1090
registry-internal-port: 1091
registry-external-port: 1091
Last update:
Sep 24, 2024