Administrator panel
The administrator panel is a web application that allows administrators to configure settings and manage processing rules.
It holds the rules and settings and sends them to the node on every MTA server, so changes you save in the browser reach the milters automatically, usually within a minute. See Deployment layouts for where it runs.
Open http://<mailserver>:9010 in a browser and log in to start.
This section covers the panel itself - signing in, the overview screen, the logs and the server-wide settings. The rules you create in it are documented separately under Rules.
- Log in - opening the panel and the default credentials.
- Dashboard - overview of configured rules, templates, domains and users.
- Servers - the MTA servers the panel sends rules and settings to, and their state.
- Backup & Restore - export the configuration into a zip file and import it back.
- Rules processing - switch rule processing off and on without changing the rules.
- Domains - browse the synced domains, users and groups.
- License - entering a trial or full license key.
Content
Content is what rules insert into messages, and the lists their conditions share.
- Templates - the signature and disclaimer bodies that signature and disclaimer rules insert.
- Attachments - the files that policy and autoresponder rules can attach to a message.
- Address lists - the networks, addresses and domains that the conditions of SMTP rules share.
Logs
- SMTP events - what the SMTP rules refused, on every server.
- Message history - the messages that were processed and the trace of which rules matched.
- Message limits - the counters of the sending limits, and resetting one.
Settings
- Signature position - where signatures are inserted in a message.
- Directory service - sync users, groups and domains from Zimbra LDAP.
- User attributes - which of their own attributes users see and change in the Change User Info zimlet.
- DKIM verification - verify the DKIM signatures of incoming messages before the rules change them.
- Diagnostic logging - capture processing events and set the retention period.
- Server config - the SMTP endpoint used to send autoreplies, forwarded and new messages.
- Access control - manage administrator panel accounts.
Navigation
The side navigation groups the pages. Rules, Content, Logs and Settings open and close; while one is closed, pointing at it shows its pages. A group opens by itself while one of its pages is shown.
| Item | Pages |
|---|---|
| Dashboard | Dashboard |
| Servers | Servers |
| Backup & Restore | Backup & Restore |
| Rules | Rules Processing, SMTP Rules with a page for each stage, Limit Rules, Policy Rules, Signature Rules, Disclaimer Rules, Autoresponder Rules |
| Content | Templates, Attachments, Address Lists |
| Rules Tester | Rules Tester |
| Logs | SMTP Events, Message History, Message Limits |
| Settings | Signature Position, Directory Service, User Attributes, DKIM Verification, Diagnostic Logging, Server Config, Access Control |
| Domains | Domains |
| License | License |
Each rule type and each SMTP rule stage shows a badge with the number of its active rules and of all its rules. Servers, Backup & Restore, Rules Processing and Settings are shown to accounts with the ADMIN role only.
Notifications
The panel tells you how an action went in a bar at the bottom left of the page:
- A dark bar confirms an action that was done, such as Settings saved. It goes away after 5 seconds.
- A red bar reports an error. It stays 10 seconds and can carry an action such as More details..., which opens the full error with a Copy to clipboard button.
Close a bar earlier with its X.
Unexpected errors
When something fails that no page handled, a red bar says Something went wrong (error 3F9A12C4). The details are in the server log. The same id is written to the log of the web admin, with the user and the page, so you can find the details:
sudo grep 3F9A12C4 /opt/msh-zr/var/log/msh-zr-web.log
Two common causes are said in plain words instead:
- Someone else changed this in the meantime. Reload the page and try again. - another administrator saved the same item while you were editing it.
- The database is busy. Try again in a moment.
An address the panel does not know, for example an old bookmark, shows Page not found with a link to the Dashboard.