Home A - Z

An Otter Wiki

Blame

96a53d Hargata Softworks 2024-03-05 01:39:54
z
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
z
4
5
> [!NOTE]
40ea21 Hargata Softworks 2025-10-03 22:09:20
x
6
> This is no longer the recommended method for configuring LubeLogger.
7
> See [[Configuring Server Settings|Installation/Server Settings]]
c9d5d5 Hargata Softworks 2024-10-04 02:39:39
d
8
96a53d Hargata Softworks 2024-03-05 01:39:54
z
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
z
26
OpenIDConfig__UsePKCE=true/false(default: false) - whether LubeLogger should use PKCE
166c66 Hargata Softworks 2025-02-14 23:51:14
x
27
OpenIDConfig__DisableRegularLogin=true/false(default: false) - auto re-direct user to OIDC login.
7485c1 Hargata Softworks 2025-04-29 14:50:11
x
28
OpenIDConfig__UserInfoURL=UserInfo URL as alternative option to retrieve user claims(required for certain OpenID Providers)
166c66 Hargata Softworks 2025-02-14 23:51:14
x
29
OpenIDConfig__LogOutURL=Log Out URL for OIDC Provider, required if DisableRegularLogin=true.
96a53d Hargata Softworks 2024-03-05 01:39:54
z
30
EnableAuth=true/false(default: false) - Allows users to configure whether if authentication is enabled via environment variable.
7e351c Hargata Softworks 2025-08-25 19:28:09
x
31
DefaultReminderEmail="" - Default root user email address.
32
EnableRootUserOIDC=true/false(default: false) - Whether root user should authenticate via OIDC.
96a53d Hargata Softworks 2024-03-05 01:39:54
z
33
UserNameHash="" - SHA256 Hash of the root username.
34
UserPasswordHash="" - SHA256 Hash of the root password.
d85f66 Hargata Softworks 2024-09-12 15:30:19
n
35
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
z
36
LUBELOGGER_LOGO_URL="" - Custom Logo URL.
f4c0aa Hargata Softworks 2025-08-14 21:03:56
x
37
LUBELOGGER_LOGO_SMALL_URL="" - Custom Small Logo URL.
0884e9 Hargata Softworks 2024-03-08 00:22:18
z
38
LUBELOGGER_MOTD="" - Message of The Day displayed in Login page if configured.
b2d603 Hargata Softworks 2024-03-16 20:16:48
z
39
LUBELOGGER_WEBHOOK="" - WebHook URL
1132e3 Hargata Softworks 2024-11-04 18:54:00
x
40
LUBELOGGER_CUSTOM_WIDGETS=true/false(default: false) - Allow Custom Widgets to be configured
95eff5 Hargata Softworks 2025-01-10 19:09:32
x
41
LUBELOGGER_INVARIANT_API=true/false(default: false) - whether API response should be invariant
cfdef1 Hargata Softworks 2025-02-03 16:08:29
x
42
LUBELOGGER_OPEN_REGISTRATION=true/false(default: false) - Allow users to generate their own registration token
6df2c4 Hargata Softworks 2025-04-29 14:48:24
x
43
LUBELOGGER_DOMAIN="" - URL to Instance of LubeLogger used to generate email links
96a53d Hargata Softworks 2024-03-05 01:39:54
z
44
```
1d68af Hargata Softworks 2025-12-16 16:42:17
x
45
c4e4d0 Hargata Softworks 2025-12-16 16:43:24
x
46
## Sample Config Files
47
1d68af Hargata Softworks 2025-12-16 16:42:17
x
48
[Sample serverConfig.json](https://github.com/hargata/lubelog_scripts/blob/main/misc/serverConfig.json)
49
50
[Sample userConfig.json](https://github.com/hargata/lubelog_scripts/blob/main/misc/userConfig.json)
c4e4d0 Hargata Softworks 2025-12-16 16:43:24
x
51
60f5e2 Hargata Softworks 2025-12-16 16:44:58
x
52
Tab Id Map:
53
c4e4d0 Hargata Softworks 2025-12-16 16:43:24
x
54
```
94b49c Hargata Softworks 2025-12-16 16:43:47
x
55
ServiceRecord = 0,
56
RepairRecord = 1,
57
GasRecord = 2,
58
TaxRecord = 3,
59
UpgradeRecord = 4,
60
ReminderRecord = 5,
61
NoteRecord = 6,
62
SupplyRecord = 7,
63
Dashboard = 8,
64
PlanRecord = 9,
65
OdometerRecord = 10,
66
VehicleRecord = 11,
67
InspectionRecord = 12
c4e4d0 Hargata Softworks 2025-12-16 16:43:24
x
68
```