Skip to main content

Configure Email Verification

BookLogr supports email-based verification of new accounts. When a user signs up, they will receive a verification code via email if this feature is enabled. The user then needs to use this code to verify their account before being able to login.

note

This feature is disabled by default.

To enable email verification, set the following environment variables in the booklogr-api container:

VariableDescriptionRequiredDefault
AUTH_REQUIRE_VERIFICATIONEnable verification of new accountsYesFalse
MAIL_SERVERSMTP server addressYes
MAIL_USERNAMEUsername for SMTP authenticationYes
MAIL_PASSWORDPassword for SMTP authenticationYes
MAIL_SENDERDefault sender email addressYes
MAIL_PORTSMTP server portNo587
MAIL_USE_TLSUse TLS encryptionNoTrue
tip

See Environment variables for more information.

Example .env configuration

AUTH_REQUIRE_VERIFICATION=True
MAIL_SERVER=smtp.example.com
MAIL_USERNAME=my_smtp_username
MAIL_PASSWORD=my_smtp_password
MAIL_SENDER=noreply@example.com
MAIL_PORT=587
MAIL_USE_TLS=True