Home A - Z

An Otter Wiki

Blame

0c19e1 Hargata Softworks 2024-01-27 22:56:52 1
# Getting Started
2
## Docker
3
The Docker Container Repository is the most reliable and up-to-date distribution channel for LubeLogger.
53b5f4 Hargata Softworks 2024-10-14 19:43:53 4
You need to have Docker installed and Virtualization enabled(typically a BIOS setting).
5
6
[Youtube Tutorial](https://www.youtube.com/playlist?list=PL2aZOA2wNP8tn-Py-XTF-B6nfx8l-4SwA)
0c19e1 Hargata Softworks 2024-01-27 22:56:52 7
cf899e Hargata Softworks 2024-04-19 14:54:45 8
You will then clone the following files onto your computer from the repository
9
- docker-compose.yml(docker-compose-traefik.yml if using Traefik)
0c19e1 Hargata Softworks 2024-01-27 22:56:52 10
c30260 Hargata Softworks 2025-08-12 15:53:38 11
Note for Portainer: some users might run into an issue with `build: .` in the docker-compose file, this line can be safely removed if it's causing issues.
065096 Hargata Softworks 2025-08-12 15:53:08 12
93bf14 Hargata Softworks 2024-10-15 17:12:21 13
Create a file named `.env` in the same folder as the docker compose file and use the [LubeLogger Configurator](https://lubelogger.com/configure) to generate the contents for it.
0c19e1 Hargata Softworks 2024-01-27 22:56:52 14
8e39f8 Hargata Softworks 2025-02-15 19:44:02 15
Note that the environment variables `LANG` and `LC_ALL` file is what will configure locale(currency, decimal, and date formats) that LubeLogger will use. Without these environment variables LubeLogger will default to
16
17
```
18
InvariantCulture
19
Currency: ยค 0.00
20
Date: MM/dd/yyyy
21
Decimal: 0.00
22
````
4a033e Hargata Softworks 2025-02-15 19:41:39 23
ff9a45 Hargata Softworks 2024-09-28 20:06:35 24
See [[Environment Variables|Advanced/Environment Variables]] for additional configuration
38a385 Hargata Softworks 2024-04-16 23:30:49 25
0c19e1 Hargata Softworks 2024-01-27 22:56:52 26
Once you're happy with the configuration, run the following commands to pull down the image and run container.
27
```
28
docker pull ghcr.io/hargata/lubelogger:latest
7da8aa Hargata Softworks 2024-04-23 22:17:27 29
docker compose up -d
0c19e1 Hargata Softworks 2024-01-27 22:56:52 30
```
31
By default the app will start listening at localhost:8080, this port can be configured in the docker-compose file.
32
92fc09 Hargata Softworks 2024-07-31 18:25:52 33
### Kubernetes Deployment
4cd21d Hargata Softworks 2024-07-31 18:16:33 34
[Helm Chart](https://artifacthub.io/packages/helm/anza-labs/lubelogger) provided by [Anza-Labs](https://github.com/anza-labs)
35
bf3d85 Hargata Softworks 2024-04-07 19:56:23 36
### Docker Manual Build(For Advanced Users)
37
1. Install Docker
87db70 Hargata Softworks 2024-04-07 19:57:02 38
2. Clone the repo
bf3d85 Hargata Softworks 2024-04-07 19:56:23 39
3. CHECK culture in .env file, default is en_US, also setup SMTP for user management if you want that.
40
4. Run docker build -t lubelogger -f Dockerfile .
41
5. CHECK docker-compose.yml and make sure the mounting directories look correct.
42
6. If using traefik, use docker-compose.traefik.yml
43
7. Run docker-compose up
44
120a93 Hargata Softworks 2024-07-03 15:17:07 45
### Edge-tagged Image
46
The `:edge` tagged Docker image may contain features that are considered experimental/not fully tested but have been merged into the main branch, use at your own risk. If you're building the Docker image manually and are cloning directly from the main branch of the repository, your local copy of the repository will contain those experimental features.
47
0c19e1 Hargata Softworks 2024-01-27 22:56:52 48
## Windows Standalone Executable
b3564d Hargata Softworks 2024-02-23 03:09:40 49
Windows Standalone Executables(EXE) are provided, and can be found under assets for the [latest release](https://github.com/hargata/lubelog/releases/latest)
50
ef104e Hargata Softworks 2024-09-28 20:04:54 51
![](/Installation/Getting%20Started/a/image-1727553838581.png)
0c19e1 Hargata Softworks 2024-01-27 22:56:52 52
73b328 Hargata Softworks 2024-01-27 22:59:57 53
To run the server, you just have to download the zip archive attached to the release, usually named LubeLogger_vNNN_win_x64.zip, extract the archive and double click on CarCareTracker.exe
0c19e1 Hargata Softworks 2024-01-27 22:56:52 54
55
Occassionally you might run into an issue regarding a missing folder, to fix that, just create a "config" folder where CarCareTracker.exe is located.
56
57
If you wish to set up SMTP when using this approach, you will have to configure the environment settings in appsettings.json located in the same folder as CarCareTracker.exe
58
You just have to add the MailConfig section into it, but I provided the full appsettings.json anyways as an example.
59
```
60
{
61
"Logging": {
62
"LogLevel": {
63
"Default": "Information",
64
"Microsoft.AspNetCore": "Warning"
65
}
66
},
67
"AllowedHosts": "*",
68
"UseDarkMode": false,
69
"EnableCsvImports": true,
70
"UseMPG": true,
71
"UseDescending": false,
72
"EnableAuth": false,
73
"HideZero": false,
74
"EnableAutoReminderRefresh": false,
75
"EnableAutoOdometerInsert": false,
76
"UseUKMPG": false,
77
"UseThreeDecimalGasCost": true,
78
"VisibleTabs": [ 0, 1, 4, 2, 3, 6, 5, 8 ],
79
"DefaultTab": 8,
80
"UserNameHash": "",
81
"UserPasswordHash": "",
82
"MailConfig": {
83
"EmailServer": "",
84
"EmailFrom": "",
85
"UseSSL": true,
86
"Port": 587,
87
"Username": "",
88
"Password": ""
89
}
90
}
91
92
```
93
When using this approach, the default port the app will be listening on is 5000, so you will navigate to localhost:5000
94
4a27cf Hargata Softworks 2025-04-15 23:13:34 95
### Run Executable in Background
96
ba8e88 Hargata Softworks 2025-04-15 23:14:54 97
The following steps describes how to run LubeLogger as a pseudo-service that is started whenever Windows is booted up.
98
99
Note that LubeLogger cannot run as a true Windows Service as that will break cross-platform compatibility; however, it can run in the background with similar behaviors to a Windows Service.
4a27cf Hargata Softworks 2025-04-15 23:13:34 100
101
1. Launch `Task Scheduler` - should come with every copy of Windows
102
2. Create a Task, note `Hidden` and `Run whether user is logged on or not` in `General` tab
103
104
![](/Installation/Getting%20Started/a/image-1744758727023.png)
105
106
3. In `Triggers` tab, create a new trigger for `At startup`
107
108
![](/Installation/Getting%20Started/a/image-1744758748520.png)
109
110
4. In `Actions` tab, create an action to launch `path\to\lubelogger\CarCareTracker.exe` and set the `Start in` to the folder the executable is in i.e.: `path\to\lubelogger`
111
112
![](/Installation/Getting%20Started/a/image-1744758763587.png)
113
114
5. Click `Ok` to create the task, then right click on the task and click `Run`
115
6. LubeLogger should now run in the background
116
117
![](/Installation/Getting%20Started/a/image-1744758777847.png)
118
119
![](/Installation/Getting%20Started/a/image-1744758809425.png)
120
1c503f Hargata Softworks 2025-04-15 23:18:07 121
7. To stop LubeLogger, right click on the Task and select `End`
122
985a94 Hargata Softworks 2024-09-14 21:03:49 123
## Linux Baremetal
ef104e Hargata Softworks 2024-09-28 20:04:54 124
Linux executables are provided and can be found under assets for the [latest release](https://github.com/hargata/lubelog/releases/latest)
125
b11c9f Hargata Softworks 2024-10-04 20:02:24 126
[Youtube Tutorial](https://www.youtube.com/playlist?list=PL2aZOA2wNP8tR21myT_s0T0tneoRi0vdT)
97c2ea Hargata Softworks 2024-10-04 19:57:32 127
ef104e Hargata Softworks 2024-09-28 20:04:54 128
To run the Linux executable, download the zip file named LubeLogger_vNNN_linux_x64.zip, extract it and run the following commands:
129
985a94 Hargata Softworks 2024-09-14 21:03:49 130
```
131
chmod 777 ./CarCareTracker
132
./CarCareTracker
133
```
134
d08a0d Hargata Softworks 2025-01-10 15:56:00 135
Depending on your Linux distro, locale may or may not be passed in automatically by the OS, if you receive an Invariant Locale warning, run these commands instead:
136
137
```
138
chmod 777 ./CarCareTracker
139
LANG=en_US
140
./CarCareTracker
141
```
142
4a033e Hargata Softworks 2025-02-15 19:41:39 143
**Note:** `chmod 777` above is only used to rule out permission quirks/issues, please restrict the permissions to the lowest acceptable level once you have verified that LubeLogger can be executed on your machine. `LANG=en_US` is an example to configure LubeLogger to use English(United States) as a locale.
3abfdf Hargata Softworks 2024-11-13 14:50:16 144
0c19e1 Hargata Softworks 2024-01-27 22:56:52 145
## Test that It Works
146
Whichever path you choose, once you get the app up and running, just navigate to the IP address and port the server is listening to and you should be able to see the app