selfapi-v2 / docs /README.md
akashyadav758
Add HOWTOUSE.md and docs/ for fast, error-free new setup
8ea09fa
|
Raw
History Blame Contribute Delete
1.23 kB

docs/ — what's new & how to set it up fast

Reference for everything added on top of the base Chrome Space, so a fresh deploy (HF or Docker) goes quick and error-free. Read in order:

File Covers
architecture.md One container: Chrome + extensions + monitor/gateway + 3 servers. Ports.
persistence.md Staying logged in: Neon Postgres (HF) vs Docker volume (self-host).
api-gateway.md The single gateway, /gpt /gemini /flow routing, API_KEY auth.
deployment.md Deploy steps, required secrets, HF tokens, Docker build stages.
troubleshooting.md Every error we hit and its fix. Check here first.

For calling the API see ../HOWTOUSE.md. For a quick start see ../SETUP.md.

Required secrets (set these or things silently break)

Secret Where Without it
DATABASE_URL HF only (Neon Postgres) Logins lost on every restart
API_KEY HF + Docker .env All /gpt /gemini /flow return 503

Local credential notes live in gitignored files: hf-token, neon-db, api-key.