diff options
| author | Joe Mou <dev@mou.fo> | 2026-08-11 08:27:26 -0400 |
|---|---|---|
| committer | Joe Mou <dev@mou.fo> | 2026-08-11 08:30:10 -0400 |
| commit | 2b4a69720b53480d82cf296ac5dbe4614d9470b9 (patch) | |
| tree | f1a617c74017951df5c4f5dba7a5e068f813f6a1 /cgithub/README.md | |
| parent | 5526d976f645def4caae9fbd2c1d75349029764e (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 'cgithub/README.md')
| -rw-r--r-- | cgithub/README.md | 41 |
1 files changed, 6 insertions, 35 deletions
diff --git a/cgithub/README.md b/cgithub/README.md index 9ba2213..3bcf017 100644 --- a/cgithub/README.md +++ b/cgithub/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 |