The admin page

NOTE

The admin page and the viauna command need Viauna 0.3 or newer.

Most settings can be changed while Viauna runs, without a restart: from the admin page, or from the server's console with the viauna command. A change applies at once, in every page people have open (nobody needs to reload).

Some changes apply only to what happens next. Narrowing who can sign in (ALLOWED_DOMAINS, ALLOW_CUSTOM_SERVERS) or lowering MAX_ACCOUNTS applies to the next sign-in and signs nobody out; a new SESSION_DAYS reaches each session the next time it's extended. See when each change takes effect.

A setting given as an environment variable can't be changed either way: the environment wins, and the page shows it as locked. So you can keep everything in your compose file, change things from the page, or mix the two.

Becoming an admin

On a new server nobody is an admin. Make yourself one from the server's console:

docker exec viauna viauna admin add you@example.com

Then sign in with that mailbox and open Admin settings from the account menu (your avatar, top right), or go to /admin. The page acts as the mailbox you opened it from and says which (Signed in as), and changes are recorded under its address. With several mailboxes signed in at once, Admin settings is in the menu only while you're in an admin's, so switch to it first; /admin on its own opens the page as the first admin signed in.

Or list the admins in the environment, which also stops anyone changing the list from the page:

environment:
  ADMIN_ADDRESSES: you@example.com, colleague@example.com

An admin is a mailbox on your own mail server (IMAP_HOST), signed in with its password. A mailbox on a server someone typed in at sign-in never counts, whatever its address, since anyone can run a server that accepts any name. What's checked is the login your mail server accepted, not the address typed in. If an admin's password changes, or the mailbox is removed, their admin rights end within ten minutes.

The admin page

Each setting shows where its value comes from:

• The default, with the environment variable that would set it;
• Changed by an admin or the command line, and when, with a button to put it back;
• Set in the environment: locked, and changed there.

Below the settings, This server shows what the environment fixed at startup, and Recent changes lists the 25 most recent: when, who, and from what to what. Every change is kept; viauna changes shows the last 50.

What the page can change:

Setting	Variable
Admin mailboxes	ADMIN_ADDRESSES	Who can open the admin page. The page won't remove the last admin; the command line can.
Allowed domains	ALLOWED_DOMAINS	Who can sign in.
Other mail servers	ALLOW_CUSTOM_SERVERS	Whether people can enter their own IMAP and SMTP servers.
Contacts, contacts sync	CONTACTS, CONTACTS_SYNC	The address book, and syncing it with CARDDAV_URL, on or off.
Calendar, calendars from the web, secret addresses, notifications with Viauna closed	CALENDAR, CALENDAR_FEEDS, CALENDAR_SECRET_ADDRESSES, BROWSER_NOTIFICATIONS	The calendar; adding calendars by their address, which this server then fetches; secret addresses for other apps to read calendars from; and reminders pushed to browsers; each on or off.
Filters, forwarding in filters, vacation responder	FILTERS, FILTER_FORWARDING, VACATION	Forwarding is off by default. See Filters and vacation.
Sending as other addresses, other providers' mail servers	SEND_AS, SEND_AS_SERVERS	What shows an address in "Send mail as" is someone's: a code, or your mail server's yes; and whether an address can go through its own provider's server. See Sending as other addresses.
Session length, accounts per browser, largest attachment, message cache	SESSION_DAYS, MAX_ACCOUNTS, MAX_UPLOAD_MB, CACHE_MB
Name	APP_NAME
Links	LINKS	Links in the apps menu, each for everyone or for admins only: a label, a web address, and who sees it.
Password changes	PASSWORD_CHANGE	Off, or one of the ways the environment set up. See Password changes.

What the page can never change

Some settings are read only from the environment, at startup:

• where Viauna listens and keeps its data (HOST, PORT, DATA_DIR, DATABASE_URL, SECRET_KEY), and how it sits behind your proxy (PUBLIC_URL, TRUST_PROXY, SECURE_COOKIES);
• your mail server (IMAP_*, SMTP_*, MANAGESIEVE_*): the IMAP server is part of each account's identity, so changing it would make every account a new, empty one;
• LOG_LEVEL;
• anything that could run code, reach your internal network, or send people's passwords somewhere: ALLOW_PRIVATE_SERVERS, where password changes go (PASSWORD_CHANGE_URL, PASSWORD_CHANGE_COMMAND, PASSWORD_CHANGE_WEBHOOK, PASSWORD_CHANGE_LDAP_*), and the contacts server (CARDDAV_URL), which each mailbox signs in to with its password.

That last group is deliberate. Someone who steals an admin's session can change what the page offers, but can't use it to run commands on your server, probe your network or send everyone to a page that collects their passwords.