Skip to content

Commit 47e5e86

Browse files
committed
Improve the README for self-hosting
1 parent 2738766 commit 47e5e86

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@ This service is used by [coder/coder](https://github.com/coder/coder) to prompt
2020

2121
## Deployment
2222

23-
starquery is deployed on a tiny VM in Google Cloud. It is exposed via a Cloudflare Tunnel and accessible at: `starquery.coder.com`.
23+
starquery is hosted at [starquery.coder.com](https://starquery.coder.com). Not all repositories are tracked by default (that'd be a lot to handle!). Feel free to repositories [here](https://github.com/coder/starquery/blob/main/cmd/starquery/main.go#L52).
24+
25+
To run starquery, `GITHUB_TOKEN` and `REDIS_URL` are required. `WEBHOOK_SECRET` must be set if accepting Webhooks from GitHub's API.
26+
27+
### Hosted
2428

2529
The `./deploy.sh` script can be used to update the service (probably should be automated at some point).
2630

@@ -34,10 +38,16 @@ GITHUB_TOKEN=
3438
WEBHOOK_SECRET=
3539
```
3640

37-
### Cloudflare Tunnel
38-
39-
See [the config file](./cloudflared.yaml). `cloudflared` is ran in `screen -S cloudflared`:
41+
To set up the Cloudflare Tunnel, see [the config file](./cloudflared.yaml). `cloudflared` is ran in `screen -S cloudflared`:
4042

4143
```sh
4244
cloudflared tunnel run 7e5e3b0d-4eb3-4aff-9924-e5f6efebcc2d
4345
```
46+
47+
To set up a GitHub webhook:
48+
49+
1. Head to the "New Webhook" page (e.g. https://github.com/coder/starquery/settings/hooks/new).
50+
2. Set the payload URL to `https://starquery.coder.com/webhook`.
51+
3. Click "Let me select individual events.", uncheck "Push", check "Stars".
52+
53+
Delivery should succeed for the initial ping!

0 commit comments

Comments
 (0)