Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configure the verifier app

This guide shows how to configure the verifier app after it runs. It covers the display settings, the allowed credential types, the session, the user database, and the user accounts.

Goal

Configure the verifier app for a deployment: set the display name and logo, restrict the credential types, keep sessions across restarts, choose the user database, and manage the accounts.

Prerequisites

Configure the display

Set the display keys in the [verifier_ui] section of the server configuration file:

[verifier_ui]
enabled = true
app_name = "City of Example Age Check"
logo_url = "https://example.com/logo.svg"
ui_dist_path = "../crates/ewqwe-credential-verifier-ui/ui/dist"
  • app_name sets the text in the header.
  • logo_url accepts an HTTPS URL or a data: URL.
  • qr_code_callback_url sets the base URL for the wallet callback. When the value is absent, the app uses the public_root_url of the server, or derives the base URL from the incoming request.

An administrator can also change the display name and the logo on the Settings page. A value in the configuration file sets the start value; a value on the Settings page overrides it and is stored in the user database.

Restrict the credential types

The allowed_credential_types key limits the types that any user can request:

[verifier_ui]
allowed_credential_types = ["proof-of-age", "mdl"]

The accepted values are proof-of-age, mdl, national-id, and france-identite-numerique. An empty list allows every type. A per-user list narrows the server setting for one user; it never widens it.

To restrict one user, open the Users page as an administrator, edit the user, and select the allowed types.

Keep sessions across restarts

The app signs the session cookie with session_secret. When the value is absent, the server generates a random key at startup, and every restart ends all sessions. To keep sessions, generate a secret and set it:

openssl rand -hex 64
[verifier_ui]
session_secret = "<the generated value>"

The value must contain at least 8 characters. The server derives the cookie signing key from the value, so the same value keeps the sessions valid across restarts.

Choose the user database

The app stores the user accounts in the backend named by the [verifier_ui.db] table.

[verifier_ui.db]
backend = "sqlite_file"
path = "/var/lib/ewqwe/verifier_ui.db"
BackendPersistenceExtra keysUse
sqlite_memorynonenoneDevelopment and testing.
sqlite_filefilepathA single instance with persistence.

The path value resolves relative to the directory that holds the configuration file. The default backend is sqlite_memory.

Manage users and roles

Open the Users page as an administrator to create, update, and delete accounts. Each account has one role:

RolePermissions
adminUser management, settings, journal, and QR codes.
verifierQR code generation and status polling.

The first account that the bootstrap route creates is an administrator with is_superadmin = true. A superadmin cannot be deleted through the interface. A password must contain at least 12 characters.

Troubleshooting

SymptomCauseAction
The config key has no effectThe app reads the value at startup.Restart the server after a change to the configuration file.
Every /api/v1 route returns 404The app is disabled.Keep the [verifier_ui] section with enabled = true.
Accounts disappear after a restartThe database is sqlite_memory.Configure sqlite_file.
Sessions end after a restartsession_secret is not set.Set a stable session_secret value.
A user cannot request a typeThe type is not allowed for that user.Widen the per-user list or the allowed_credential_types list.