Giorgio Gilestro
a50c5091c4
Compose merges list-typed fields like \`ports\` by concatenation, so the previous prod overlay couldn't clear the base file's host port binding; the VPS app ended up listening on both port 80 (intranet) AND host port 8800 simultaneously. Restructured to the conventional dev/prod split: - docker-compose.yml: no host port — prod-ready by default - docker-compose.override.yml: dev-only host port binding (auto-loaded by \`docker compose up\` locally, skipped when prod uses explicit -f) - docker-compose.prod.yml: command-port 80 + intranet network only Production invocation: docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
59 lines
2.4 KiB
Markdown
59 lines
2.4 KiB
Markdown
# Read the Markets
|
|
|
|
Containerised macro-strategy dashboard — hourly market data, RSS news, Trading 212 portfolio, and an AI-generated strategic log written by **Cassandra**, the in-product seer. Read-only by design.
|
|
|
|
Production:
|
|
- Landing: <https://read.markets>
|
|
- App: <https://app.read.markets>
|
|
|
|
The Python package is still named `cassandra` and several internal identifiers (cookie names, advisory-lock keys, `CASSANDRA_TOKEN` env var, CSS filename) keep the legacy name on purpose — renaming them would invalidate live sessions / locks / configs for no user benefit. See `app/branding.py` for the brand single-source-of-truth.
|
|
|
|
## Quick start (local dev)
|
|
|
|
```bash
|
|
cp .env.example .env # fill in API keys; set CASSANDRA_TOKEN if exposing
|
|
docker compose up --build # db + app + scheduler + daily backup sidecar
|
|
open http://localhost:8000/ # or whichever CASSANDRA_PORT you set
|
|
```
|
|
|
|
`docker-compose.override.yml` is auto-loaded and adds the host port
|
|
binding so the app is reachable on `localhost`.
|
|
|
|
## Production (VPS, NPM-fronted)
|
|
|
|
Always invoke with **explicit -f flags** — that way the dev override is
|
|
skipped and the prod overlay (no host port, joins the external
|
|
`intranet` Docker network, uvicorn on port 80) is applied:
|
|
|
|
```bash
|
|
docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d --build
|
|
```
|
|
|
|
Point Nginx Proxy Manager at upstream `readmarkets-app-1:80`.
|
|
|
|
## Architecture
|
|
|
|
- **app** (FastAPI + Jinja2 + HTMX) — web dashboard on port 8000
|
|
- **scheduler** (APScheduler) — hourly ingestion jobs (market, news, portfolio, AI log)
|
|
- **db** (MariaDB 11) — quotes, headlines, portfolio snapshots, strategic logs, job runs
|
|
- **backup** (sidecar) — daily mariadb-dump to `./backup/`
|
|
|
|
See `/home/gg/.claude/plans/ok-i-think-this-tidy-lake.md` for the design plan.
|
|
|
|
## Config
|
|
|
|
| File | Purpose |
|
|
|---|---|
|
|
| `config/default.toml` | Universal data tables: indicator groups, RSS feeds, keyword presets |
|
|
| `config/portfolio.toml` | User-specific portfolios (overrides `default.toml`) |
|
|
| `.env` | Secrets and runtime knobs — mounted read-only into containers |
|
|
|
|
## Endpoints
|
|
|
|
- `GET /` — dashboard
|
|
- `GET /portfolio/{name}` — portfolio detail
|
|
- `GET /news` — news feed
|
|
- `GET /log` — strategic-log archive
|
|
- `GET /api/health` — job status (last success / failure per job)
|
|
|
|
All authenticated routes require `Authorization: Bearer $CASSANDRA_TOKEN` if the env is set; if unset, the app is open (LAN-only mode).
|