Skip to content

Commit fc570b1

Browse files
committed
feat(cache-server): clearer setup instructions
1 parent 207ae49 commit fc570b1

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

packages/gha-cache-server/getting-started.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,13 @@ helm install <release-name> oci://ghcr.io/falcondev-oss/charts/github-actions-ca
7777

7878
- Example: `http://localhost:3000`
7979

80-
The base URL of your cache server. This needs to be accessible by your runners as it is used for making API requests and downloading cached files.
80+
The base URL of your cache server. This needs to be accessible by your runners as it is used for cache uploads and downloads.
81+
82+
::: warning
83+
84+
Make sure the actions runner can reach the cache server on this url!
85+
86+
:::
8187

8288
#### `STORAGE_DRIVER`
8389

@@ -147,7 +153,7 @@ You can patch the runner binary yourself or use our forked runner image that has
147153

148154
### Forked Runner (recommended)
149155

150-
We provide a forked runner image that has the source code modified to allow setting `ACTIONS_RESULTS_URL` without patching the binary.
156+
We provide a forked runner image that has the source code modified to allow overriding `ACTIONS_RESULTS_URL` by setting `CUSTOM_ACTIONS_RESULTS_URL`.
151157

152158
- Repo: [falcondev-oss/github-actions-runner](https://github.com/falcondev-oss/github-actions-runner)
153159
- Image: `ghcr.io/falcondev-oss/actions-runner:latest`

0 commit comments

Comments
 (0)