Update docs, configs, and scripts

Co-Authored-By: Oz <oz-agent@warp.dev>
This commit is contained in:
Raghav
2026-04-19 09:42:52 +05:30
parent 12b66edd22
commit 319881a09f
11 changed files with 157 additions and 62 deletions

View File

@ -57,16 +57,17 @@ Detailed architecture: `docs/ARCHITECTURE.md`.
cd gemma3-vllm-stack
```
2. Create configuration files:
2. Create the main configuration file:
```bash
cp .env.example .env
cp backend/config/model.env.example backend/config/model.env
cp frontend/config/frontend.env.example frontend/config/frontend.env
```
3. Edit `.env` and set at least:
- `HF_TOKEN`
- `VLLM_API_KEY` (recommended even on LAN)
- `GEMMA_MODEL_ID`
`backend/config/model.env` and `frontend/config/frontend.env` are auto-synced from `.env` by `scripts/install.sh` and `scripts/restart.sh`.
4. Install/start stack:
```bash
@ -124,3 +125,7 @@ Adjust using `.env`:
## Notes for `chat.bhatfamily.in`
This repository intentionally does not terminate TLS. Bindings are plain HTTP on host ports and are designed for external reverse proxy + TLS handling (nginx/Caddy/Cloudflare Tunnel).
Current homelab edge mapping (verified 2026-04-19):
- `https://chat.bhatfamily.in` is served on `443/tcp` by the shared Caddy edge.
- Direct host ports `3000/tcp` (UI) and `8000/tcp` (API) are currently publicly reachable; restrict firewall/NAT exposure if direct internet access is not intended.