Logging In

If no users exist in the database, SnowMail will create a default user with the username admin and password snowmail. It is recommended to change the password immediately after login.

Creating Accounts

You can create new accounts by going to the accounts page.

Note

Once you create an account, you cannot change its username.

Users with the admin role will have full access to the SnowMail dashboard. Users with the user role will not be able to add/remove forms or manage users and will only be able to view and edit the forms they have been given access to.

SSO

SSO using OpenID Connect can be configured in the .env file. The following options are required:

SSO_ENABLED=true
# If true, the login page will be skipped and local accounts will be disabled
SSO_FORCE_REDIRECT=false
SSO_CLIENT_ID= # client ID
SSO_CLIENT_SECRET= # client secret
SSO_AUTH_URL= # auth URL
SSO_TOKEN_URL= # token URL
SSO_USERINFO_URL= # userinfo URL
SSO_LOGOUT_URL= # logout URL

SnowMail will request the snowmail scope, and you should return the following information in a similarly-named claim:

"snowmail": {
  "role": "USER", // or "ADMIN"
  "forms": [
    // An array of form IDs.
    "6627b0113f4c7e0d773abc2b"
  ]
}

Note

Logging in via SSO will not create a new user account, nor will it match existing accounts. Instead, a null user will be used. Due to this, the My Account link in the navbar will be hidden.

Set the callback URL on your OIDC server to https://{snowmail_url}/login/sso/callback. You should also configure your reverse proxy to send the X-Forwarded-Proto and X-Forwarded-Host headers to SnowMail.