Blame
96a53d | Hargata Softworks | 2024-03-05 01:39:54 | 1 | # Environment Variables |
2 | ||||
3 | These are all of the environment variables you can pass into LubeLogger and what they do | |||
c2ecea | Hargata Softworks | 2024-10-04 02:39:11 | 4 | |
5 | > [!NOTE] | |||
2b5ba2 | Hargata Softworks | 2024-10-04 02:39:26 | 6 | > Save time and effort using the [LubeLogger Configurator](https://lubelogger.com/configure) |
862e77 | Hargata Softworks | 2024-10-04 02:40:11 | 7 | > to generate your .env file |
c9d5d5 | Hargata Softworks | 2024-10-04 02:39:39 | 8 | |
96a53d | Hargata Softworks | 2024-03-05 01:39:54 | 9 | ``` |
10 | LC_ALL=en_US.UTF-8 <- Locale and Language Settings, this will affect how numbers, currencies, and dates are formatted. | |||
11 | LANG=en_US.UTF-8 <- Same as above. Note that some languages don't have UTF-8 encodings. | |||
12 | MailConfig__EmailServer="" <- Email SMTP settings used only for configuring multiple users(to send their registration token and forgot password tokens) | |||
13 | MailConfig__EmailFrom="" <- Same as above. | |||
14 | MailConfig__Port=587 <- Same as above. | |||
15 | MailConfig__Username="" <- Same as above. | |||
16 | MailConfig__Password="" <- Same as above. | |||
17 | POSTGRES_CONNECTION="" <- Postgres Connection String | |||
18 | OpenIDConfig__Name=Name of the OpenID Connect Provider | |||
19 | OpenIDConfig__ClientId=Client Id to Authenticate with the Provider | |||
20 | OpenIDConfig__ClientSecret=Client Secret to Authenticate with the Provider | |||
21 | OpenIDConfig__AuthURL=Authorization URL to the Provider's Login Page | |||
22 | OpenIDConfig__TokenURL=URL to retrieve user JWT from the Provider | |||
23 | OpenIDConfig__RedirectURL=https://<yourlubeloggerdomain.com>/Login/RemoteAuth(must be HTTPS) | |||
24 | OpenIDConfig__Scope=The scope for retrieving the user's email claim(usually it's just 'email') | |||
25 | OpenIDConfig__ValidateState=true/false(default: false) - whether LubeLogger should validate state. | |||
84bbf8 | Hargata Softworks | 2024-08-21 20:31:51 | 26 | OpenIDConfig__UsePKCE=true/false(default: false) - whether LubeLogger should use PKCE |
96a53d | Hargata Softworks | 2024-03-05 01:39:54 | 27 | EnableAuth=true/false(default: false) - Allows users to configure whether if authentication is enabled via environment variable. |
28 | UserNameHash="" - SHA256 Hash of the root username. | |||
29 | UserPasswordHash="" - SHA256 Hash of the root password. | |||
d85f66 | Hargata Softworks | 2024-09-12 15:30:19 | 30 | LUBELOGGER_ALLOWED_FILE_EXTENSIONS="" - Allowed file extensions for document uploads, use '*' to allow all file types. |
96a53d | Hargata Softworks | 2024-03-05 01:39:54 | 31 | LUBELOGGER_LOGO_URL="" - Custom Logo URL. |
0884e9 | Hargata Softworks | 2024-03-08 00:22:18 | 32 | LUBELOGGER_MOTD="" - Message of The Day displayed in Login page if configured. |
b2d603 | Hargata Softworks | 2024-03-16 20:16:48 | 33 | LUBELOGGER_WEBHOOK="" - WebHook URL |
1132e3 | Hargata Softworks | 2024-11-04 18:54:00 | 34 | LUBELOGGER_CUSTOM_WIDGETS=true/false(default: false) - Allow Custom Widgets to be configured |
96a53d | Hargata Softworks | 2024-03-05 01:39:54 | 35 | ``` |