Commands

install.sh

curl -fsSL https://get.newiq.pl/mintrix | sudo sh -s -- [options]

Option	Meaning
--version VERSION	Install this version instead of the script's own
--dir DIR	Installation folder (default /opt/mintrix)
--license KEY	Licence key, from your client area: activates this server. Needed the first time, or to activate again
--domain DOMAIN	Domain the licence is for, where users open Mintrix (not an IP)
--port PORT	HTTP port (default 80)
--https-port PORT	HTTPS port (default 443, or 8443 when 443 is taken)
--cloudflare	Cloudflare is in front: Mintrix sees each visitor's own IP address
--without-ministra	Mintrix only, for a Ministra that runs elsewhere; kept for later runs. --with-ministra adds the Ministra again
--ministra-port PORT	Port of Ministra's admin panel (default 8088)
--http	Users open http://DOMAIN (default https://)
--yes	Ask nothing; use the options and defaults

The licence key is used once, to activate this server for the domain; it is not kept. Later runs and updates use the activation (runtime/licence.json).

mintrix-update

The same options as the installer:

sudo mintrix-update                                       # newest release
sudo mintrix-update --version 1.2.3                       # a given version, also to go back
sudo mintrix-update --port 8080 --https-port 8443         # change ports
sudo mintrix-update --license <key> --domain <domain>     # activate again, or move to another domain

Administrator accounts

cd /opt/mintrix
sudo docker compose exec app php artisan mintrix:create-admin          # another administrator
sudo docker compose exec app php artisan mintrix:2fa-reset <email>     # reset two-factor authentication

Licence

cd /opt/mintrix
sudo docker compose exec -u www-data app php artisan mintrix:status            # the licence and lease
sudo docker compose exec -u www-data app php artisan mintrix:status --force    # renew now, e.g. after a plan change

As www-data, the app's user, so Mintrix can still read the licence file the command writes.

See Licence and devices.

Backups

cd /opt/mintrix
sudo docker compose exec app php artisan mintrix:backup     # make a backup now
sudo docker compose exec app php artisan mintrix:restore    # restore one (a copy of the current database is made first)

See Backups.

Status and logs

cd /opt/mintrix
sudo docker compose ps               # are all services running?
sudo docker compose logs -f app      # application
sudo docker compose logs nginx       # web server and certificate warnings