The frontend defaults to English. Users can switch to French with the language switcher; their selection is saved in browser local storage and restored on subsequent visits. Backend error messages remain in English so the frontend can translate them consistently.
Compose reads variables from the root .env file. Start from the checked-in
template:
cp backend/.env.sample.properties .envThe sample file is for local setup only; its placeholder password and JWT value
must be replaced before use outside a private development environment. Compose
requires a non-empty database password and PostgreSQL uses password
authentication. CI validates required values before writing its temporary
.env or starting any service.
| Variable | Required | Description | Local Compose value |
|---|---|---|---|
POSTGRES_DB |
Yes | Database name | uchat_chat_app |
POSTGRES_HOST |
Yes | Database hostname from backend | uchat-postgres |
POSTGRES_PORT |
Yes | Database port from backend | 5432 |
POSTGRES_USER |
Yes | Database user | uchat |
POSTGRES_PASSWORD |
Yes | Database password | Set a local value |
POSTGRES_SSLMODE |
No | PostgreSQL TLS mode | disable (local only) |
JWT_SECRET_TOKEN |
Yes | JWT signing secret | Long random value |
MAIN_APP_PORT |
Yes | Backend listen port | 8050 |
FRONTEND_URL |
Yes | Allowed browser/WebSocket origin | http://localhost:4250 |
BACKEND_URL |
Yes | Backend upstream URL used by the frontend proxy | http://uchat-backend:8050 |
The backend reads these values through Spring placeholders. Missing or invalid
values prevent reliable startup; errors should be fixed rather than bypassed.
If POSTGRES_SSLMODE is omitted, the backend defaults to verify-full;
production deployments must keep that server-authenticated setting (or use a
platform-equivalent TLS setting), and provide the database provider's trusted
CA bundle to the PostgreSQL client.
PostgreSQL creates POSTGRES_DB during the initial Compose database
initialization, before the backend starts. The backend does not create databases
at startup and therefore only needs the application user's normal connection
privileges. If the named volume already exists, changing POSTGRES_DB does not
create a second database; remove the volume with make clean and start Compose
again when a fresh local database is required.
compose.yml defines:
uchat-postgres, with persistent volumeuchat_db_dataand host port5532;uchat-backend, built frombackend/Dockerfile, host port8050;uchat-frontend, built fromfrontend/Dockerfile, host port4250;uchat-e2e, an opt-in Playwright service under thee2eprofile.
The backend receives an additional internal frontend origin,
http://frontend:4200, so browser-origin checks work for Compose networking.
- Never commit
.env, passwords, JWT secrets, or production API keys. - Treat
backend/.env.sample.propertiesvalues as local-only placeholders, not deployment defaults. - Use a unique, high-entropy
JWT_SECRET_TOKENin every environment. - Use HTTPS and a narrowly scoped
FRONTEND_URLin production. - Store deployment secrets in the platform's secret store.
- Do not expose PostgreSQL publicly unless operationally required.
The optional production monitoring variable is:
| Variable | Purpose |
|---|---|
APPSIGNAL_PUSH_API_KEY |
Authenticates AppSignal error/performance reporting |
It is not consumed by the local Compose configuration and must be configured by the deployment integration that sends telemetry.
make upd # Start in background
make ps # Check health/status
make logs # Follow logs
make down # Stop, preserve database volume
make clean # Stop and delete local database/build artifactsThe backend currently uses Spring's in-memory STOMP simple broker. Run one backend instance in production; messages are not synchronized between multiple instances. Before scaling out, add a broker relay or another clustered messaging design and validate cross-instance topic and user-queue delivery.
The backend health endpoint is /actuator/health. The Docker health check uses
http://127.0.0.1:8050/actuator/health; the backend image exposes port 8080 as
metadata but the configured application port remains MAIN_APP_PORT (8050 in
the supplied template).
Production deployment, rollback, secret, observability, backup, and migration requirements are maintained in the production operations guide. The Compose settings in this document are local defaults and must not be copied to production without applying that guide's security boundary.