aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoe Mou <dev@mou.fo>2026-08-11 08:27:26 -0400
committerJoe Mou <dev@mou.fo>2026-08-11 08:30:10 -0400
commitde557ad66466261ae578ea9342f32d78a139fbc9 (patch)
tree874e02ce81a135201bb29499124a620376bd55aa /README.md
parentf198a174f204b164752a91aa774b1dee8c80f9e8 (diff)
Deploy only to Cloudflare Workers
The Node server entry, esbuild bundle, and Makefile rsync/systemd deploy are gone; wrangler dev and wrangler deploy are the only paths now, so the dev:cf/deploy:cf scripts take over the plain dev/deploy names. @hono/ node-server and esbuild drop out with src/index.ts, and the README's systemd socket and nginx snippets go with them. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 6 insertions, 35 deletions
diff --git a/README.md b/README.md
index 9ba2213..3bcf017 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
cgithub is a lightweight GitHub alternative frontend. It has no bloated
-JavaScript and doesn't require API keys. To use it, host cgithub on your own
-server then replace `github.com` in your URL with your domain.
+JavaScript and doesn't require API keys. It runs on Cloudflare Workers; to use
+it, deploy your own instance then replace `github.com` in your URL with your
+domain.
## Development
@@ -16,42 +17,12 @@ $ pnpm test
## Deployment
-Assuming you have a server `jupiter`, you might deploy like:
+To deploy to Cloudflare Workers:
```
-$ pnpm run build
-$ rsync -av --del dist jupiter:/opt/cgithub
+$ pnpm run deploy
```
-To configure systemd socket activation use a `cgithub.socket` file:
-```
-[Socket]
-ListenStream=/run/cgithub/socket
-SocketGroup=nginx
-SocketMode=0660
-
-[Install]
-WantedBy=sockets.target
-```
-
-And a service file `cgithub.service`:
-```
-[Unit]
-After=cgithub.socket
-Requires=cgithub.socket
-
-[Service]
-Type=exec
-WorkingDirectory=/opt/cgithub
-ExecStart=/usr/bin/node dist/build/index.js
-DynamicUser=true
-```
-
-An nginx config snippet might be:
-```
-location / {
- proxy_pass http://unix:/run/cgithub/socket;
-}
-```
+The worker name and other settings live in `wrangler.jsonc`.
## Disclosures