Commit 0c19e1
2024-01-27 22:56:52 Hargata Softworks: Getting Started| /dev/null .. getting started.md | |
| @@ 0,0 1,73 @@ | |
| + | # Getting Started |
| + | ## Docker |
| + | The Docker Container Repository is the most reliable and up-to-date distribution channel for LubeLogger. |
| + | You need to have Docker Windows installed and Virtualization enabled(typically a BIOS setting). |
| + | |
| + | You will then clone the following files onto your computer from the repository _.env_ and _docker-compose.yml_ or _docker-compose-traefik.yml_ if you're using Traefik. |
| + | |
| + | In the .env file you will find the following and here are the explanations for the variables. |
| + | ``` |
| + | LC_ALL=en_US.UTF-8 <- Locale and Language Settings, this will affect how numbers, currencies, and dates are formatted. |
| + | LANG=en_US.UTF-8 <- Same as above. Note that some languages don't have UTF-8 encodings. |
| + | MailConfig__EmailServer="" <- Email SMTP settings used only for configuring multiple users(to send their registration token and forgot password tokens) |
| + | MailConfig__EmailFrom="" <- Same as above. |
| + | MailConfig__UseSSL="false" <- Same as above. |
| + | MailConfig__Port=587 <- Same as above. |
| + | MailConfig__Username="" <- Same as above. |
| + | MailConfig__Password="" <- Same as above. |
| + | ``` |
| + | |
| + | Once you're happy with the configuration, run the following commands to pull down the image and run container. |
| + | ``` |
| + | docker pull ghcr.io/hargata/lubelogger:latest |
| + | docker-compose up |
| + | ``` |
| + | By default the app will start listening at localhost:8080, this port can be configured in the docker-compose file. |
| + | |
| + | ## Windows Standalone Executable |
| + | Windows Standalone executables are provided on a request basis, and will usually be included with every other release. |
| + | |
| + | To run the server, you just have to double click on CarCareTracker.exe |
| + | |
| + | Occassionally you might run into an issue regarding a missing folder, to fix that, just create a "config" folder where CarCareTracker.exe is located. |
| + | |
| + | 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 |
| + | You just have to add the MailConfig section into it, but I provided the full appsettings.json anyways as an example. |
| + | ``` |
| + | { |
| + | "Logging": { |
| + | "LogLevel": { |
| + | "Default": "Information", |
| + | "Microsoft.AspNetCore": "Warning" |
| + | } |
| + | }, |
| + | "AllowedHosts": "*", |
| + | "UseDarkMode": false, |
| + | "EnableCsvImports": true, |
| + | "UseMPG": true, |
| + | "UseDescending": false, |
| + | "EnableAuth": false, |
| + | "HideZero": false, |
| + | "EnableAutoReminderRefresh": false, |
| + | "EnableAutoOdometerInsert": false, |
| + | "UseUKMPG": false, |
| + | "UseThreeDecimalGasCost": true, |
| + | "VisibleTabs": [ 0, 1, 4, 2, 3, 6, 5, 8 ], |
| + | "DefaultTab": 8, |
| + | "UserNameHash": "", |
| + | "UserPasswordHash": "", |
| + | "MailConfig": { |
| + | "EmailServer": "", |
| + | "EmailFrom": "", |
| + | "UseSSL": true, |
| + | "Port": 587, |
| + | "Username": "", |
| + | "Password": "" |
| + | } |
| + | } |
| + | |
| + | ``` |
| + | When using this approach, the default port the app will be listening on is 5000, so you will navigate to localhost:5000 |
| + | |
| + | ## Test that It Works |
| + | 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 |