-
-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #148 from hargata/Hargata/documentation
Hargata/documentation
- Loading branch information
Showing
6 changed files
with
201 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Sharing your Vehicles and Collaborating with Other Users | ||
|
|
||
| LubeLogger allows you to collaborate on vehicles so that more than one user can add or edit records on a vehicle. | ||
|
|
||
| To share a vehicle, simply navigate into the Vehicle's Dashboard, and look to the bottom left | ||
|
|
||
|  | ||
|
|
||
| Click on the little blue button with a User Add icon and you will be prompted to enter the user's username | ||
|
|
||
|  | ||
|
|
||
| **Note:** The username is case sensitive and the user must exist in the system. | ||
|
|
||
| Once you have added the user, their username will then show up in the list of Collaborators | ||
|
|
||
|  | ||
|
|
||
| Now the user can view and edit the vehicle as well: | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Configuring LubeLogger | ||
| In order to provide the best possible user experience, we have provided ample amount of flexibility when it comes to user settings. | ||
| Upon initial launch, you are using the Root User by default without any authentication, so you will have access to all of the settings. | ||
|
|
||
|  | ||
|
|
||
| Most of the settings are relatively straightforward and self-explanatory. | ||
|
|
||
| **Note:** If you are a user in the UK and you wish be able to input Fuel Purchases in Liters but display Fuel Mileage as Miles Per UK Gallons, you will need to enable "Use Imperial Calculation" and "Use UK MPG Calculation" | ||
|
|
||
| **Note:** When making changes to Settings as a root user, your settings will be saved and served up as the default server settings for any new users that sign up. | ||
|
|
||
| ## Enable Authentication | ||
| It is highly recommended that you secure your LubeLogger instance by enabling authentication. | ||
| To do so, simply check "Enable Authentication" and you will be prompted to enter a Username and Password | ||
|
|
||
|  | ||
|
|
||
| The credentials that you set up here are the credentials for the Root User, aka the Super Admin, and shouldn't be shared with anyone else. | ||
|
|
||
| Once you have entered the credentials, you will then be redirected to a Login page | ||
|
|
||
|  | ||
|
|
||
| Simply enter the credentials you have just set up and you will be logged right in | ||
|
|
||
|  | ||
|
|
||
| ## Setting Up Multiple Users | ||
| To set up multiple users, all you have to do is click on the dropdown that has your username on it and select "Admin Panel" | ||
|
|
||
|  | ||
|
|
||
| If you have SMTP configured correctly, the "Auto Notify(via Email) switch will be enabled and checked, otherwise it will be disabled/grayed out. | ||
| Without SMTP Configured: | ||
|
|
||
|  | ||
|
|
||
| With SMTP Configured: | ||
|
|
||
|  | ||
|
|
||
| To generate a new user token, simply click on the "Generate User Token" button and you will be prompted with the user's email address | ||
|
|
||
|  | ||
|
|
||
| If you have SMTP Configured, the user will then receive an Email that looks similar to this: | ||
|  | ||
|
|
||
| The user can then proceed to Register for an account at your instance of LubeLogger. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| # 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 | ||
|  | ||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Registration | ||
| Once they user have receive an email containing their LubeLogger token(pictured below), they can then register for an account. | ||
|
|
||
|  | ||
|
|
||
| They can do so by navigating to your LubeLogger instance and clicking on the "Register" link. | ||
|
|
||
|  | ||
|
|
||
| Then they just have to provide the token and their email address along with their set of credentials | ||
|
|
||
|  | ||
|
|
||
| **Note:** The email address and token are CASE SENSITIVE and MUST be identical to the email address that the token is generated for. | ||
|
|
||
|  | ||
|
|
||
| Once the user has registered successfully, they can then log in using their credentials. | ||
|
|
||
| You can also verify that in your panel the token is deleted and the user now shows up under list of users: | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters