Document environment variables

2024-02-28 13:34:03 -05:00
parent 412f09f942
commit 0d5bd3e0d1
1 changed files with 9 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,12 @@
 # semaphore-runner

 Runner for semaphore runner with custom environment dependencies
+
+## Configuration
+
+```shell
+SEMAPHORE_RUNNER_REGISTRATION_TOKEN=  # (required) registration token to authenticate to the server
+SEMAPHORE_RUNNER_API_URL=  # (required) URL of the Semaphore server API
+SEMAPHORE_RUNNER_CONFIG_FILE=  # runner state file
+SEMAPHORE_RUNNER_MAX_PARALLEL_TASKS=  # Maximum parallel tasks the runner can run at once
+```