Appearance
Settings (.env)
The settings are in /opt/mintrix/.env; the comments there explain each one. After a change, apply it with:
sh
sudo mintrix-update --version <running version>Keep .env private
It holds the encryption key and database passwords. Back it up with your database: a backup is only usable with the same APP_KEY.
Version and images
| Setting | Meaning |
|---|---|
MINTRIX_VERSION | Version to run; set by the installer and mintrix-update |
MINTRIX_APP_IMAGE, MINTRIX_WEB_IMAGE | The Mintrix images, by digest; set with the version |
Licence
| Setting | Meaning |
|---|---|
MINTRIX_DOMAIN | The domain the licence is for, where users open Mintrix (not an IP address). To move to another domain, move the licence in your client area, then run sudo mintrix-update --license <key> --domain <new domain> |
The licence key is not in .env: it is used once, to activate the server. See Licence and devices.
Application
| Setting | Meaning |
|---|---|
APP_URL | Address users open Mintrix at (used in emails and links); set from the domain |
APP_KEY | Encryption key for sessions, two-factor secrets and stored settings. Generated once: never change or lose it |
Database
| Setting | Meaning |
|---|---|
DB_DATABASE, DB_USERNAME | Database name and user (mintrix) |
DB_PASSWORD, DB_ROOT_PASSWORD | Fixed when the database is first created; changing them later does not change the existing database |
Ports
Apply in /opt/mintrix with sudo docker compose up -d.
| Setting | Default | Meaning |
|---|---|---|
MINTRIX_HTTP_PORT | 80 | HTTP port |
MINTRIX_HTTPS_PORT | 443 | HTTPS port |
MINTRIX_HTTP_BIND, MINTRIX_HTTPS_BIND | empty | Where each port is reachable from: empty for every address (IPv4 and IPv6), 127.0.0.1 for this machine only, or one of the server's addresses |
MINTRIX_HTTPS_REDIRECT | off | on redirects plain HTTP to HTTPS. Leave off behind Cloudflare: it does that itself |
MINTRIX_TRUSTED_PROXIES | empty | cloudflare, your proxy's addresses (e.g. 10.0.0.5,192.168.1.0/24), or empty for no proxy |
See Domain and HTTPS.
Ministra
For the Ministra installed beside Mintrix (see Ministra with Mintrix).
| Setting | Default | Meaning |
|---|---|---|
COMPOSE_PROFILES | ministra | Empty for Mintrix only (--without-ministra) |
MINISTRA_IMAGE, MINISTRA_VERSION | The Ministra release that runs: set by the installer and by Ministra's updates (Settings > Ministra > Update). Mintrix updates keep them | |
MINISTRA_DB_PASSWORD, MINISTRA_DB_ROOT_PASSWORD | Ministra's database, made by the installer | |
MINISTRA_API_LOGIN, MINISTRA_API_PASSWORD | mintrix | Ministra's REST API login, which Mintrix uses |
MINISTRA_INBOUND_KEY | The key Ministra sends its change notifications to Mintrix with | |
MINISTRA_SERVER_URL | http://ministra:88 | Ministra's address for Mintrix, on the first start only; then Settings > Ministra |
MINISTRA_HTTP_PORT, MINISTRA_HTTP_BIND | 8088, empty | Ministra's own admin panel; 127.0.0.1 keeps it to this server |
MINTRIX_PORTAL_UPSTREAM | empty | The box portal: empty uses the Ministra of Settings > Ministra; off for none; or another address for box traffic |
Email
For password resets and notifications, from your mail provider.
| Setting | Default | Meaning |
|---|---|---|
MAIL_MAILER | smtp | |
MAIL_HOST, MAIL_PORT | 587 | SMTP server |
MAIL_USERNAME, MAIL_PASSWORD | SMTP login | |
MAIL_SCHEME | empty | Empty for STARTTLS on 587; smtps for port 465 |
MAIL_FROM_ADDRESS, MAIL_FROM_NAME | Mintrix | Sender |
Access
| Setting | Meaning |
|---|---|
IP_WHITELIST | Comma-separated IP addresses or ranges (e.g. 203.0.113.7, 10.0.0.0/8) administrators may use Mintrix from: signing in and every action after it. Empty allows all |
COMPOSE_PROJECT_NAME | Only for a second installation on the same machine: keeps its containers and database separate (it also needs other ports) |