Talon/chat_grid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Polish top-level README

Browse Source
This commit is contained in:
Jage9
2026-03-09 00:26:45 -04:00
parent d10f45d4e2
commit 1eb582f730
1 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -30,7 +30,6 @@ Notes:
- Server bind/port defaults are `127.0.0.1:8765` unless changed in config or CLI flags. - Server bind/port defaults are `127.0.0.1:8765` unless changed in config or CLI flags.
- Client dev defaults to Vite local host/port (`localhost:5173`) unless flags override. - Client dev defaults to Vite local host/port (`localhost:5173`) unless flags override.
- Server runtime env lives in `server/.env`; `server/.env.sample` shows the required variables. - Server runtime env lives in `server/.env`; `server/.env.sample` shows the required variables.
- `deploy/scripts/install_server.sh` creates `server/.env` with `CHGRID_AUTH_SECRET` automatically if missing.
Common server overrides: Common server overrides:
- `uv run python main.py --config /path/to/config.toml` - `uv run python main.py --config /path/to/config.toml`
@@ -39,15 +38,15 @@ Common server overrides:
- `uv run python main.py --ssl-cert /path/fullchain.pem --ssl-key /path/privkey.pem` - `uv run python main.py --ssl-cert /path/fullchain.pem --ssl-key /path/privkey.pem`
- `uv run python main.py --bootstrap-admin` (one-time admin creation) - `uv run python main.py --bootstrap-admin` (one-time admin creation)
## Production Deploy (quick path) ## Production Deploy
Use `deploy/README.md`. Use `deploy/README.md` for the full deployment guide.
Summary: Summary:
1. Copy repo to your server. 1. Copy repo to your server.
2. Build client and publish `client/dist/` to your web root/subdirectory. 2. Run `./deploy/scripts/install_server.sh`.
3. Configure server `config.toml` and run it via `systemd`. 3. Publish the client with `./deploy/scripts/up.sh`.
4. Add base-path-scoped websocket/auth proxy routes from `deploy/apache/chgrid-vhost-snippet.conf`. 4. Add websocket/auth proxy routes using `deploy/apache/chgrid-vhost-snippet.conf`.
## Key Paths ## Key Paths