diff --git a/README.md b/README.md index 8b6d991..b3511f9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # gitea-act-runner -Gitea action runner. \ No newline at end of file +Gitea action runner. + +## Usage + +1. Clone the repository to your host location or copy the `compose.yaml` file. +2. Copy the `example.env` to `.env` +3. Update the environment variables in the newly created `.env` file. +4. Copy and update the `config/config.yaml` file. + +## Notes + +If deploying with `komodo` then the `config` directory does not seem to get copied into the correct +path where the stack is ran. + +What I do is: + +1. Deploy the stack +2. SSH to the server that you're running on +3. `cd /etc/komodo/stacks//config` +4. run `wget https://git.housh.dev/homelab/gitea-act-runner/raw/branch/main/config/config.yaml` +5. Redeploy or restart the stack.