docs: update README, TODO, and deployment docs
CI / Lint (push) Has been cancelled
CI / Test (push) Has been cancelled
CI / Build (push) Has been cancelled

README: Added hierarchical routing, classifier bucket mapping, two-level
dispatch, model groups table, DeepSeek language note, deploy script, and
updated model names to match current models.dev registry.

TODO: Added 15 completed items covering model groups, routing, dispatch,
and provider fixes from May 7 session.

deployment.md: Added deploy.sh instructions.
This commit is contained in:
2026-05-07 14:07:52 -04:00
parent 28b8271c1d
commit b7df3108fa
3 changed files with 95 additions and 29 deletions
+17
View File
@@ -26,6 +26,22 @@ go build -o gophergate ./cmd/gophergate
./gophergate
```
### Quick Deploy Script
A `deploy.sh` script is provided for production restarts:
```bash
./deploy.sh
```
This script will:
1. Stop any running gophergate process
2. Pull latest changes from git
3. Build the application
4. Start it in the background (logs to `gophergate.log`)
If the build fails, the previous binary is left untouched and the script exits.
## Docker Deployment
The project includes a multi-stage `Dockerfile` for minimal image size.
@@ -50,3 +66,4 @@ docker run -d \
- **SSL/TLS:** It is recommended to run the proxy behind a reverse proxy like Nginx or Caddy for SSL termination.
- **Backups:** Regularly backup the `data/llm_proxy.db` file.
- **Monitoring:** Monitor the `/health` endpoint for system status.
- **Logs:** When started with `deploy.sh` or `nohup`, logs are written to `gophergate.log`.