Settings¶

Under Settings, system-wide configurations are managed: license, TLS, branding, updates, and backups.

License¶

Field	Description
License Key	Input field for updating/replacing the key
Status	`valid`, `expired`, `grace period`
Type	License tier (e.g. Standard, Professional, Enterprise)
Expiry Date	Validity date
Features	Enabled optional features
Limits	Maximum domains, users, mailboxes, etc.
Active Mailboxes	Cluster-wide count of active mailboxes (always visible)
Mailbox Limit	Progress indicator relative to `max_mailboxes` (only shown when a limit is set)

License verification

The license is validated online when needed. The local cache (/var/lib/nmg/license_cache.json) allows 24 hours of operation without connectivity. After that, the 30-day trial file acts as a fallback.

Mailbox limit exceeded

If max_mailboxes is exceeded, an overage banner appears across the entire management UI. After a 30-day grace period, creating new mailboxes and domains is blocked (write-block) until the overage is resolved or the licence is upgraded.

TLS¶

Configuration of the TLS certificate for the web UI and SMTP service.

Option	Description
Let's Encrypt	Automatic certificate management (port 80 must be reachable)
Custom Certificate	Manual path specification for `.crt` and `.key`

Certificates are automatically renewed 30 days before expiry.

Branding (Quarantine Portal)¶

Customise the end-user quarantine portal:

Field	Description
Logo	Upload a custom logo (PNG/SVG)
Company Name	Displayed in the portal header
Primary Colour	Hex colour for buttons and accents
Support Link	URL for a help/support link in the portal

Updates¶

Automatic Update¶

When enabled, nmg checks for new packages in the APT repository daily and installs them automatically.

Manual Update (Single Node)¶

Click Update Now to trigger an immediate update. The node is briefly unreachable during package installation (~30 seconds) and restarts automatically afterwards.

Rolling Cluster Update¶

For cluster setups: a rolling update upgrades nodes sequentially so that at least one node is always active.

Click Start Rolling Update
Progress is shown in real time:
pending → waiting
upgrading → update running
waiting_for_restart → restart pending
done → complete
error → failed (view details)
After the last remote node, the local node also restarts

Browser reload after update

After the local node restarts, the browser reloads automatically. If the restart takes longer than expected: press Ctrl+Shift+R (hard reload) manually.

Backup & Restore¶

Creating a Backup¶

A configuration backup includes all nmg settings (domains, mail config, filters, users, API keys). It does not include the mail queue, quarantine, or logs.

Settings → Backup → "Download Backup"

The backup file is an encrypted .tar.gz containing all relevant configuration data.

Restoring a Backup¶

Settings → Backup → "Restore Backup" → select file

Restore overwrites all configurations

A restore replaces all existing settings. This cannot be undone. Create a current backup first.

Initial Setup¶

If the setup wizard needs to be run again (e.g. after a license change), it can be reset under Settings → Initial Setup.

Package Versions¶

Under Package Versions, the installed versions of all nmg system components are shown (nmg-api, nmg-scheduler, nmg-sandbox, etc.) as well as whether a system restart is pending.