mirror of
https://github.com/TheRealOwenRees/chess-endgame-trainer.git
synced 2026-11-18 11:42:07 +00:00
* Update README.md * Add structured JSON production logging (#105) * Log requests and background failures (#107) * Document production logging and the VPS runbook
46 lines
1.7 KiB
Markdown
46 lines
1.7 KiB
Markdown
# Chesstrainer
|
|
|
|
To start your Phoenix server:
|
|
|
|
* Run `docker compose up -d` to run the development database
|
|
* Run `mix setup` to install and setup dependencies
|
|
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
|
|
|
|
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
|
|
|
|
Ready to run in production? Please [check our deployment guides](https://phoenix.hexdocs.pm/deployment.html).
|
|
|
|
## Local tablebases (optional)
|
|
|
|
Positions with five or fewer pieces are answered locally from Syzygy tablebases
|
|
when `TABLEBASE_PATH` points at a directory of `.rtbw`/`.rtbz` files; otherwise
|
|
lookups fall back to Lichess.
|
|
|
|
```sh
|
|
mix tablebase.fetch --path /path/to/syzygy/3-4-5 # once per host (~939 MB)
|
|
export TABLEBASE_PATH=/path/to/syzygy/3-4-5 # set per environment
|
|
```
|
|
|
|
On the production VPS the directory is `/opt/chesstrainer/tablebases`, owned by
|
|
the `chesstrainer` user. Set `TABLEBASE_PATH` in `/etc/chesstrainer/env` and
|
|
restart the service; the value is read at boot.
|
|
|
|
See [docs/tablebases.md](docs/tablebases.md) for the full reference — dev vs
|
|
VPS paths, `mix tablebase.check`, and boot logging.
|
|
|
|
## Logging
|
|
|
|
Production logs are one JSON object per line so they can be filtered with
|
|
`journalctl` and `jq`; development and test keep the readable formatter. See
|
|
[docs/logging.md](docs/logging.md) for the line shape, redaction rules and the
|
|
background-work audit, and [`deploy/README.md`](deploy/README.md) for the VPS
|
|
runbook.
|
|
|
|
## Learn more
|
|
|
|
* Official website: https://www.phoenixframework.org/
|
|
* Guides: https://phoenix.hexdocs.pm/overview.html
|
|
* Docs: https://phoenix.hexdocs.pm
|
|
* Forum: https://elixirforum.com/c/phoenix-forum
|
|
* Source: https://github.com/phoenixframework/phoenix
|