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
cf899e Hargata Softworks 2024-04-19 14:54:45 6
You will then clone the following files onto your computer from the repository
7
- docker-compose.yml(docker-compose-traefik.yml if using Traefik)
0c19e1 Hargata Softworks 2024-01-27 22:56:52 8
9
Once you're happy with the configuration, run the following commands to pull down the image and run container.
10
```
11
docker pull ghcr.io/hargata/lubelogger:latest
7da8aa Hargata Softworks 2024-04-23 22:17:27 12
docker compose up -d
0c19e1 Hargata Softworks 2024-01-27 22:56:52 13
```
14
By default the app will start listening at localhost:8080, this port can be configured in the docker-compose file.
15
92fc09 Hargata Softworks 2024-07-31 18:25:52 16
### Kubernetes Deployment
4cd21d Hargata Softworks 2024-07-31 18:16:33 17
[Helm Chart](https://artifacthub.io/packages/helm/anza-labs/lubelogger) provided by [Anza-Labs](https://github.com/anza-labs)
18
bf3d85 Hargata Softworks 2024-04-07 19:56:23 19
### Docker Manual Build(For Advanced Users)
20
1. Install Docker
87db70 Hargata Softworks 2024-04-07 19:57:02 21
2. Clone the repo
fe852d Hargata Softworks 2025-10-07 18:25:02 22
3. Run docker build -t lubelogger -f Dockerfile .
23
4. CHECK docker-compose.yml and make sure the mounting directories look correct.
24
5. If using traefik, use docker-compose.traefik.yml
25
6. Run docker-compose up
bf3d85 Hargata Softworks 2024-04-07 19:56:23 26
120a93 Hargata Softworks 2024-07-03 15:17:07 27
### Edge-tagged Image
28
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.
29
0c19e1 Hargata Softworks 2024-01-27 22:56:52 30
## Windows Standalone Executable
b3564d Hargata Softworks 2024-02-23 03:09:40 31
Windows Standalone Executables(EXE) are provided, and can be found under assets for the [latest release](https://github.com/hargata/lubelog/releases/latest)
32
ef104e Hargata Softworks 2024-09-28 20:04:54 33
![](/Installation/Getting%20Started/a/image-1727553838581.png)
0c19e1 Hargata Softworks 2024-01-27 22:56:52 34
73b328 Hargata Softworks 2024-01-27 22:59:57 35
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 36
37
When using this approach, the default port the app will be listening on is 5000, so you will navigate to localhost:5000
38
4a27cf Hargata Softworks 2025-04-15 23:13:34 39
### Run Executable in Background
40
ba8e88 Hargata Softworks 2025-04-15 23:14:54 41
The following steps describes how to run LubeLogger as a pseudo-service that is started whenever Windows is booted up.
42
43
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 44
45
1. Launch `Task Scheduler` - should come with every copy of Windows
46
2. Create a Task, note `Hidden` and `Run whether user is logged on or not` in `General` tab
47
48
![](/Installation/Getting%20Started/a/image-1744758727023.png)
49
50
3. In `Triggers` tab, create a new trigger for `At startup`
51
52
![](/Installation/Getting%20Started/a/image-1744758748520.png)
53
54
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`
55
56
![](/Installation/Getting%20Started/a/image-1744758763587.png)
57
58
5. Click `Ok` to create the task, then right click on the task and click `Run`
59
6. LubeLogger should now run in the background
60
61
![](/Installation/Getting%20Started/a/image-1744758777847.png)
62
63
![](/Installation/Getting%20Started/a/image-1744758809425.png)
64
1c503f Hargata Softworks 2025-04-15 23:18:07 65
7. To stop LubeLogger, right click on the Task and select `End`
66
985a94 Hargata Softworks 2024-09-14 21:03:49 67
## Linux Baremetal
ef104e Hargata Softworks 2024-09-28 20:04:54 68
Linux executables are provided and can be found under assets for the [latest release](https://github.com/hargata/lubelog/releases/latest)
69
b11c9f Hargata Softworks 2024-10-04 20:02:24 70
[Youtube Tutorial](https://www.youtube.com/playlist?list=PL2aZOA2wNP8tR21myT_s0T0tneoRi0vdT)
97c2ea Hargata Softworks 2024-10-04 19:57:32 71
ef104e Hargata Softworks 2024-09-28 20:04:54 72
To run the Linux executable, download the zip file named LubeLogger_vNNN_linux_x64.zip, extract it and run the following commands:
73
985a94 Hargata Softworks 2024-09-14 21:03:49 74
```
75
chmod 777 ./CarCareTracker
76
./CarCareTracker
77
```
78
fe852d Hargata Softworks 2025-10-07 18:25:02 79
**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.
3abfdf Hargata Softworks 2024-11-13 14:50:16 80
0c19e1 Hargata Softworks 2024-01-27 22:56:52 81
## Test that It Works
82
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
f41be7 Hargata Softworks 2025-10-07 18:26:07 83
84
Next steps: [[Configuring Server Settings|Installation/Server Settings]]