Scott.Idem/OSIT-AE-Docker-Env
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README and CHEATSHEET to reflect final correct architecture

Browse Source 
- Traffic diagram corrected: both app and api route through ae_web_dev
- Removed outdated 'two options' scaling section for ae_app
- Added port reference table to CHEATSHEET
- Scaling section simplified: change replicas, done, home nginx never changes
- localhost link corrected from 3001 to 8888 (LAN HTTP via ae_web_dev)
This commit is contained in:
Scott Idem
2026-03-10 18:24:31 -04:00
parent 57ec65144d
commit 1aa4186f4a
2 changed files with 43 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
CHEATSHEET.md
View File

@@ -1,54 +1,41 @@
# Aether Docker Cheat Sheet 🚀
## 🚀 Deployment & Updates
- **Full Rebuild (Fast):** `docker compose up -d --build`
- **Rebuild SvelteKit UI:** `docker compose up -d --build ae_app`
- **Restart API (Pick up Python changes):** `docker compose restart ae_api`
- **Switch Build Mode:** Edit `.env` -> `AE_APP_BUILD_MODE=prod` -> `docker compose up -d --build ae_app`
- **Full Rebuild:** `docker compose up -d --build`
- **Rebuild SvelteKit only:** `docker compose up -d --build ae_app`
- **Restart API (pick up Python changes):** `docker compose restart ae_api`
- **Switch Build Mode:** Edit `.env` → `AE_APP_BUILD_MODE=prod` → `docker compose up -d --build ae_app`
- **Shut everything down:** `npm run compose:down` (from `aether_app_sveltekit/`)
## 🛠️ Management Links
- **SvelteKit Frontend:** [http://localhost:3001](http://localhost:3001)
- **FastAPI Documentation:** [https://dev-api.oneskyit.com/docs](https://dev-api.oneskyit.com/docs)
- **Database (phpMyAdmin):** [http://localhost:8081](http://localhost:8081)
- **SvelteKit Frontend:** [http://localhost:8888](http://localhost:8888) (LAN HTTP via ae_web_dev)
- **FastAPI Docs:** [https://dev-api.oneskyit.com/docs](https://dev-api.oneskyit.com/docs)
- **Database (phpMyAdmin):** [http://localhost:8081](http://localhost:8081) (requires `--profile database`)
- **Logs (Dozzle):** [http://localhost:8881](http://localhost:8881)
## 💾 Database Operations
- **Manual Backup:** `./backup_db.sh` (Hot backup, live container)
- **Manual Restore:** `./restore_db.sh [path_to_file.gz]` (Automated password/grant reset)
- **Conference Export:** `./export_db.sh` (Saves to `backups/conference_export/`)
- **Automated Import:** Drop file in `backups/import/` -> Run `./check_and_import.sh`.
## 🔌 Port Reference
| Port | Variable | Purpose |
|------|-----------------------|--------------------------------------------------|
| 3001 | `AE_APP_GATEWAY_PORT` | App gateway — home nginx → ae_app replicas |
| 5060 | `AE_API_GATEWAY_PORT` | API gateway — home nginx → ae_api replicas |
| 8888 | `OSIT_WEB_HTTP_PORT` | LAN HTTP direct access (no home server needed) |
| 8081 | `AE_PMA_PORT` | phpMyAdmin (database profile only) |
| 8881 | — | Dozzle log viewer |
| 3306 | `AE_DB_EXTERNAL_PORT` | MariaDB direct (database profile only) |
## 📈 Scaling
Both services scale via Docker DNS round-robin inside `ae_web_dev`.
Home server nginx **never needs to change** — it always points to the same port.
### ae_api — scales via Docker DNS (no host ports needed)
`ae_api` has no host ports. External traffic enters via `ae_web_dev` (port 5060/443),
which round-robins across all `ae_api` replicas using Docker's internal DNS.
- Edit `.env` → `AE_APP_REPLICAS=X` or `AE_API_REPLICAS=X`
- Run `docker compose up -d` (or `up -d ae_app` for app-only)
1. Edit `.env` → `AE_API_REPLICAS=X`
2. Run `docker compose up -d`
No home-server nginx changes needed.
### ae_app — two scaling options
**Option A (recommended): Route through ae_web_dev (same as ae_api)**
- Home server nginx points `dev-*.oneskyit.com` at `workstation:443`
- ae_web_dev round-robins to `ae_app` replicas via Docker DNS
- No host ports needed on ae_app, no home nginx changes when scaling
- Same topology as ae_api
**Option B (current): Direct host port binding**
- Home server nginx points at `workstation:3001`, `3002`, etc.
- `AE_APP_NODE_PORT_RANGE=3001-3006` in `.env`; Docker assigns one port per replica
- Must uncomment matching entries in home server nginx upstream when adding replicas
- Maximum 6 replicas without changing the range
To scale with Option B:
1. Edit `.env` → `AE_APP_REPLICAS=X` (max 6 with current range)
2. Run `docker compose up -d ae_app`
3. Uncomment matching port entries in home server nginx upstream
4. Reload home server nginx
## 💾 Database Operations
- **Manual Backup:** `./backup_db.sh` (hot backup, live container)
- **Manual Restore:** `./restore_db.sh [path_to_file.gz]`
- **Conference Export:** `./export_db.sh` (saves to `backups/conference_export/`)
- **Automated Import:** Drop file in `backups/import/` → run `./check_and_import.sh`
## 🧹 Maintenance
- **Internal Logs:** Docker handles rotation automatically (10MB limit).
- **External Proxy:** Point your home server to `[Workstation_IP]:5060`.
- **Dozzle:** Live log viewer at port 8881 — no auth currently (LAN only).