Blame

0c19e1 Hargata Softworks 2024-01-27 22:56 1
# Getting Started
2
## Docker
3
The Docker Container Repository is the most reliable and up-to-date distribution channel for LubeLogger.
4
You need to have Docker Windows installed and Virtualization enabled(typically a BIOS setting).
5
cf899e Hargata Softworks 2024-04-19 14:54 6
You will then clone the following files onto your computer from the repository
7
- .env
8
- docker-compose.yml(docker-compose-traefik.yml if using Traefik)
0c19e1 Hargata Softworks 2024-01-27 22:56 9
10
In the .env file you will find the following and here are the explanations for the variables.
11
```
12
LC_ALL=en_US.UTF-8 <- Locale and Language Settings, this will affect how numbers, currencies, and dates are formatted.
13
LANG=en_US.UTF-8 <- Same as above. Note that some languages don't have UTF-8 encodings.
14
MailConfig__EmailServer="" <- Email SMTP settings used only for configuring multiple users(to send their registration token and forgot password tokens)
15
MailConfig__EmailFrom="" <- Same as above.
16
MailConfig__UseSSL="false" <- Same as above.
17
MailConfig__Port=587 <- Same as above.
18
MailConfig__Username="" <- Same as above.
19
MailConfig__Password="" <- Same as above.
20
```
21
38a385 Hargata Softworks 2024-04-16 23:30 22
See [[Environment Variables]] for additional configuration
23
0c19e1 Hargata Softworks 2024-01-27 22:56 24
Once you're happy with the configuration, run the following commands to pull down the image and run container.
25
```
26
docker pull ghcr.io/hargata/lubelogger:latest
7da8aa Hargata Softworks 2024-04-23 22:17 27
docker compose up -d
0c19e1 Hargata Softworks 2024-01-27 22:56 28
```
29
By default the app will start listening at localhost:8080, this port can be configured in the docker-compose file.
30
bf3d85 Hargata Softworks 2024-04-07 19:56 31
### Docker Manual Build(For Advanced Users)
32
1. Install Docker
87db70 Hargata Softworks 2024-04-07 19:57 33
2. Clone the repo
bf3d85 Hargata Softworks 2024-04-07 19:56 34
3. CHECK culture in .env file, default is en_US, also setup SMTP for user management if you want that.
35
4. Run docker build -t lubelogger -f Dockerfile .
36
5. CHECK docker-compose.yml and make sure the mounting directories look correct.
37
6. If using traefik, use docker-compose.traefik.yml
38
7. Run docker-compose up
39
120a93 Hargata Softworks 2024-07-03 15:17 40
### Edge-tagged Image
41
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.
42
0c19e1 Hargata Softworks 2024-01-27 22:56 43
## Windows Standalone Executable
b3564d Hargata Softworks 2024-02-23 03:09 44
Windows Standalone Executables(EXE) are provided, and can be found under assets for the [latest release](https://github.com/hargata/lubelog/releases/latest)
45
46
![](/Getting%20Started/a/image-1708657703682.png)
0c19e1 Hargata Softworks 2024-01-27 22:56 47
73b328 Hargata Softworks 2024-01-27 22:59 48
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 49
50
Occassionally you might run into an issue regarding a missing folder, to fix that, just create a "config" folder where CarCareTracker.exe is located.
51
52
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
53
You just have to add the MailConfig section into it, but I provided the full appsettings.json anyways as an example.
54
```
55
{
56
"Logging": {
57
"LogLevel": {
58
"Default": "Information",
59
"Microsoft.AspNetCore": "Warning"
60
}
61
},
62
"AllowedHosts": "*",
63
"UseDarkMode": false,
64
"EnableCsvImports": true,
65
"UseMPG": true,
66
"UseDescending": false,
67
"EnableAuth": false,
68
"HideZero": false,
69
"EnableAutoReminderRefresh": false,
70
"EnableAutoOdometerInsert": false,
71
"UseUKMPG": false,
72
"UseThreeDecimalGasCost": true,
73
"VisibleTabs": [ 0, 1, 4, 2, 3, 6, 5, 8 ],
74
"DefaultTab": 8,
75
"UserNameHash": "",
76
"UserPasswordHash": "",
77
"MailConfig": {
78
"EmailServer": "",
79
"EmailFrom": "",
80
"UseSSL": true,
81
"Port": 587,
82
"Username": "",
83
"Password": ""
84
}
85
}
86
87
```
88
When using this approach, the default port the app will be listening on is 5000, so you will navigate to localhost:5000
89
90
## Test that It Works
91
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