Settings¶

This page describes the application-internal settings under "Settings" in the Office. User accounts and login have their own page: Users and login. Your personal API token and your own MFA setup are not part of "Settings" - they are reachable from your user menu instead, see My account in the user guide.

The "Settings" menu sits below "Mails" in the sidebar and is only shown to superusers. Staff accounts neither see it nor can they open its pages directly (see Permission model). Sections that are restricted this way are marked superuser only below. "About" is a separate sidebar entry right below it and available to every account.

Initial setup¶

Superuser only. Right after installation, as long as the required fields are missing (see First login), byro asks a superuser for three things:

• Association name,
• sender address for mail byro sends on the association's behalf,
• notification address byro sends administrative notices to.

Only then does byro move on to the registration form setup (see below) and the rest of the Office becomes usable.

General¶

Superuser only. The general settings (settings/) combine several forms on one page: the association configuration itself plus, where installed, PGP (see PGP email encryption) and configuration models plugins contribute through ByroConfiguration (see Custom member data) - each plugin can add its own section to this page this way.

The association configuration itself covers:

• Association name, address, URL,
• Statute of limitations in months (liability_interval): up to what age a member's outstanding fees can still be claimed,
• Accounting start (accounting_start): an optional date fees are billed from retroactively - useful when an organization was migrated to byro later and older, unpaid fees should not become due retroactively,
• Language and currency (code, symbol, symbol before/after the amount, cent display); a new installation starts with EUR and €,
• External base URL (public_base_url): only needed if public member pages should be reachable under a different base URL than the rest of byro; otherwise leave it empty.
• Sender and notification address (the same fields as in the initial setup, changeable here),
• Default sort order and default form of address for members (first or last name part first), with an action to apply them retroactively to every existing member,
• Default mail templates for welcome and leave mail (to the member and to the office) and for record disclosure.

Every saved change is recorded in the audit log with the changed fields (before/after) (see below); forms can exclude individual fields (for example secrets) from this logging.

Registration form¶

Superuser only. Under "Settings → Registration form" you decide which fields are asked for when a new member is created: member and membership fields, every field installed profile plugins contribute (for example byro.plugins.profile), plus the PGP fingerprint entry. For each field you can set:

• its position in the form (empty = not shown, unless it is a required field),
• a default value (for date fields a relative default such as "beginning of the current month", for boolean fields true/false/no default),
• whether it is required. Fields the database would not leave empty anyway (NOT NULL with no default) automatically show up as required and cannot be removed from the form.

With no saved configuration, byro shows a sensible default (member number, name, address, e-mail, fee start, interval, amount).

About byro¶

The sidebar entry "About", directly below "Settings", shows the installed byro version and the loaded plugins with their metadata (name, version, description). It is available to every account with access to the Office, not only to superusers.

Audit log¶

Superuser only. "Settings → Log" shows the most recent audit log entries: who changed what, when (member changes, settings, logins, plugin events, …). Every entry is part of a cryptographically chained hash chain (each entry references the previous one through a hash); entries can neither be deleted nor modified afterwards through the application. The "Log" tab of a single member stays available to staff. /log/info shows the current chain head without requiring a login - an external party can use it to check whether a copy of the chain they hold still matches the current state, without signing in.

For a full, machine-readable export see the export_logchain management command under Management commands.