Useful Environment Variables

Plume uses environment variable to configure instances. You can use them to configure the database, or the HTTP interface for instance.

Plume relies on some environment variables for some configuration options. You can either set them before starting the app with cargo run or write them in a .env file to have automatically loaded.

Basic

Here are the variables that Plume uses:

Mail

The SMTP server to send mails can be configured with:

For the moment, Plume only sends mail when you need to reset your password (and only from the web interface, plm users reset-password doesn’t send anything). If you don’t plan to use this feature, you can simply remove (or comment) the lines to configure the mail server in your .env.

You can also change the logo you want to use for your instance in this file. Your logo should be in the static directory. To make Plume load it, you can use:

All the specified paths should be relative to the static directory.

Here is an example, that will make your instance use the “paragraphs” logo.

PLUME_LOGO=icons/trwnh/paragraphs/plumeParagraphs.svg
PLUME_LOGO_FAVICON=icons/trwnh/paragraphs/plumeParagraphs32.png
PLUME_LOGO_48=icons/trwnh/paragraphs/plumeParagraphs48.png
PLUME_LOGO_72=icons/trwnh/paragraphs/plumeParagraphs72.png
PLUME_LOGO_96=icons/trwnh/paragraphs/plumeParagraphs96.png
PLUME_LOGO_144=icons/trwnh/paragraphs/plumeParagraphs144.png
PLUME_LOGO_160=icons/trwnh/paragraphs/plumeParagraphs160.png
PLUME_LOGO_192=icons/trwnh/paragraphs/plumeParagraphs192.png
PLUME_LOGO_256=icons/trwnh/paragraphs/plumeParagraphs256.png
PLUME_LOGO_512=icons/trwnh/paragraphs/plumeParagraphs512.png

LDAP

Plume support delegating authentication via LDAP since v0.6.0.

Plume determines what to bind using LDAP_BASE_DN, LDAP_USER_NAME_ATTR and the user name. Assuming what you need Plume to bind is username={user name},ou=users,dc=your-org, the configuration would be the following:

LDAP_BASE_DN=ou=users,dc=your-org
LDAP_USER_NAME_ATTR=username