Files
Archive/documentation/ENVIRONMENT.md

41 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Habland Environment Variables
Reference for `.env` values used by Docker Compose and the admin panel. Copy `.env.example` to `.env` and adjust as needed before running `docker compose up -d` or `./docker-manage.sh`.
## Core Database
- `MYSQL_ROOT_PASSWORD` root password for `unified-db` (MariaDB).
- `DB_HOST` / `DB_PORT` host and port used by services to reach MariaDB (defaults: `unified-db`, `3306`).
## Retro (Arcturus)
- `RETRO_API_URL` base URL the clients use to reach the Arcturus API (default `http://localhost`).
- `RETRO_WS_URL` websocket URL for the Arcturus emulator (default `ws://localhost:30000`).
## AtomCMS
- `ATOMCMS_APP_NAME` display name.
- `ATOMCMS_ENV` runtime environment (`production` by default).
- `ATOMCMS_KEY` Laravel app key (generate if blank).
- `ATOMCMS_DEBUG` enable verbose debug output (`true`/`false`).
- `ATOMCMS_URL` public URL for the CMS.
- `ATOMCMS_DB` / `ATOMCMS_DB_USER` / `ATOMCMS_DB_PASS` database name and credentials (defaults map to MariaDB root).
## Emulator Databases
- `HAVANA_MYSQL_USERNAME` / `HAVANA_MYSQL_PASSWORD` / `HAVANA_MYSQL_DATABASE`
- `KEPLER_MYSQL_USERNAME` / `KEPLER_MYSQL_PASSWORD` / `KEPLER_MYSQL_DATABASE`
- `ROSEAU_MYSQL_USERNAME` / `ROSEAU_MYSQL_PASSWORD` / `ROSEAU_MYSQL_DATABASE`
## Ports (host mappings)
- `DB_PORT`, `REDIS_PORT`, `PHPMYADMIN_PORT`
- `ARCTURUS_GAME_PORT`, `ARCTURUS_RCON_PORT`
- `HAVANA_GAME_PORT`, `HAVANA_MUS_PORT`, `HAVANA_RCON_PORT`
- `KEPLER_GAME_PORT`, `KEPLER_MUS_PORT`
- `ROSEAU_GAME_PORT`, `ROSEAU_RCON_PORT`
- `COOL_UI_PORT`, `NITRO_REACT_PORT`, `HAVANA_WEB_PORT`, `ROSEAU_CLIENT_PORT`
- `ASSET_SERVER_PORT`, `ATOMCMS_HTTP_PORT`, `ATOMCMS_HTTPS_PORT`, `ADMIN_PANEL_PORT`
## Admin Panel Auth
- `ADMIN_USER` / `ADMIN_PASSWORD` credential pair consumed by `admin-panel/src/auth.ts`. Required for logging into the admin panel.
## Notes
- Defaults in `.env.example` target local development. Change values if ports clash or if you deploy to another host.
- The Docker Compose file uses these variables when building images and mapping ports; restart containers after changing them.