You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-4Lines changed: 14 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,11 @@ This service is used by [coder/coder](https://github.com/coder/coder) to prompt
20
20
21
21
## Deployment
22
22
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
24
28
25
29
The `./deploy.sh` script can be used to update the service (probably should be automated at some point).
26
30
@@ -34,10 +38,16 @@ GITHUB_TOKEN=
34
38
WEBHOOK_SECRET=
35
39
```
36
40
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`:
40
42
41
43
```sh
42
44
cloudflared tunnel run 7e5e3b0d-4eb3-4aff-9924-e5f6efebcc2d
43
45
```
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`.
0 commit comments