Files
chess-endgame-trainer/README.md
T
owenrees 202b9b1f6a Add structured production logging (#105, #107) (#141)
* Update README.md

* Add structured JSON production logging (#105)

* Log requests and background failures (#107)

* Document production logging and the VPS runbook
2026-11-10 22:00:05 +01:00

1.7 KiB

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 from your browser.

Ready to run in production? Please check our deployment guides.

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.

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 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 for the line shape, redaction rules and the background-work audit, and deploy/README.md for the VPS runbook.

Learn more