Updated documentation links and removed static documentation.
This commit is contained in:
DESKTOP-T0O5CDB\DESK-555BD
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -10,7 +10,7 @@ assignees: ''
|
||||
**Checklist**
|
||||
Please make sure you have performed the following steps before opening a new bug ticket, change `[ ]` to `[x]` to mark it as done
|
||||
|
||||
- [ ] I have read and tried the steps outlined in the [Troubleshooting Guide](https://docs.lubelogger.com/Troubleshooting)
|
||||
- [ ] I have read and tried the steps outlined in the [Troubleshooting Guide](https://docs.lubelogger.com/Installation/Troubleshooting)
|
||||
- [ ] I have searched through existing issues.
|
||||
|
||||
**Description**
|
||||
|
||||
@@ -20,7 +20,7 @@ Try it out before you download it! The live demo resets every 20 minutes.
|
||||
## Download
|
||||
LubeLogger is available as both a Docker Image and a Windows Standalone Executable.
|
||||
|
||||
Read this [Getting Started Guide](https://docs.lubelogger.com/Getting%20Started) on how to download either of them
|
||||
Read this [Getting Started Guide](https://docs.lubelogger.com/Installation/Getting%20Started) on how to download either of them
|
||||
|
||||
### Kubernetes Deployment
|
||||
[Helm Chart](https://artifacthub.io/packages/helm/anza-labs/lubelogger) provided by [Anza-Labs](https://github.com/anza-labs)
|
||||
@@ -28,7 +28,7 @@ Read this [Getting Started Guide](https://docs.lubelogger.com/Getting%20Started)
|
||||
### Need Help?
|
||||
[Documentation](https://docs.lubelogger.com/)
|
||||
|
||||
[Troubleshooting Guide](https://docs.lubelogger.com/Troubleshooting)
|
||||
[Troubleshooting Guide](https://docs.lubelogger.com/Installation/Troubleshooting)
|
||||
|
||||
[Search Existing Issues](https://github.com/hargata/lubelog/issues)
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
<hr />
|
||||
<div class="col-12">
|
||||
<div class="d-flex justify-content-center">
|
||||
<p><a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover" href="https://docs.lubelogger.com/Funding" target="_blank">Become a Sponsor</a></p>
|
||||
<p><a class="link-body-emphasis link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover" href="https://docs.lubelogger.com/Misc/Funding" target="_blank">Become a Sponsor</a></p>
|
||||
</div>
|
||||
</div>
|
||||
@if (Model.LifeTime.Any())
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
# API
|
||||
|
||||
LubeLogger provides API endpoints to retrieve and add records, full documentation of these endpoints can be found at `/api`.
|
||||
|
||||
## Authentication
|
||||
If authentication is enabled, it implements Basic Auth based on RFC2617, which stipulates that the "token" is passed in as a Base64-encoded string comprising of a username and password separated by a colon(":"). Because of this, neither the username nor password can contain a colon(":") character.
|
||||
|
||||
### Testing
|
||||
You can utilize any REST API testing tool to test your use-case.
|
||||
|
||||
## Example Use Cases
|
||||
- Send Email Reminders, see [[Reminders|Records/Reminders#reminder-emails]]
|
||||
- Insert Odometer Records, see [[Odometer|Records/Odometer#api-integration]]
|
||||
- Create DB Backups
|
||||
@@ -1,45 +0,0 @@
|
||||
# Authentication
|
||||
|
||||
LubeLogger does not require authentication by default; however, it is highly recommend that you set up authentication if your LubeLogger instance is accessible vvia the Internet or if you wish to invite other users to your instance.
|
||||
|
||||
## Enabling Authentication
|
||||
To enable authentication, all you have to do is navigate to the "Settings" tab and check "Enable Authentication".
|
||||
|
||||
A dialog will then prompt you to enter a username and password. These are the credentials for the Root/Super User.
|
||||
|
||||
Once you have entered the credentials, click the "Setup" button and you will be redirected to a login screen, enter the credentials of the Root/Super User here to login.
|
||||
|
||||
## Creating / Inviting New Users
|
||||
LubeLogger relies on an invitation-only model for creating/registering new users. It is highly recommended that LubeLogger is configured with SMTP in order to make the user registration process as smooth as possible, see [[Getting Started]] for more information regarding SMTP configuration.
|
||||
|
||||
To Create/Invite New Users, you first need to enable authentication and set up the Root User credentials. Once that is done, upon login, you will see that there is now a dropdown to the right of the "Settings" tab that has your root username on it. Click on that dropdown and select "Admin Panel"
|
||||
|
||||
|
||||
You will now be taken to a new page. There are two sections in this page, Tokens and Users.
|
||||
|
||||
|
||||
Tokens are used for invitees to register their user account or existing users to reset their password. These tokens are single use and are validated against the email address they are issued for.
|
||||
|
||||
Users, as the name suggests, is a list of users in the system. You can also mark or unmark existing users as Admins here, see below to understand what permissions Admin users have.
|
||||
|
||||
To invite a user, simply click on the "Generate User Token" button and type in their email address, note that this is case-sensitive.
|
||||
|
||||
|
||||
If SMTP is configured and the Auto Notify(via Email) switch is checked, the user will receive an email that looks like this:
|
||||
|
||||
|
||||
## Root/Super User
|
||||
You might be tempted to use your root credentials as your main credentials, and there is nothing wrong that, but you should know that there are a few caveats associated with the root user.
|
||||
1. Root/Super Users can view and edit all vehicles, this might seem like a great advantage initially, but it can be problematic if there are sufficient users and you have to sift through dozens of vehicles to get to yours.
|
||||
2. Any setting you enable/disable will become the default setting inherited by new users.
|
||||
|
||||
For the reasons above, it is highly recommended that you create a second user for personal use and mark it as an Admin. See below for a breakdown of permissions across user tiers.
|
||||
|
||||
| Permissions | User | Admin | Root/Super User |
|
||||
| ---------------------- | ----------------------------------------- | ----------------------------------------- | ---------------------- |
|
||||
| View/Edit Vehicles | Only vehicles which they are collaborator | Only vehicles which they are collaborator | View/Edit All Vehicles |
|
||||
| Access API | Yes | Yes | Yes |
|
||||
| Personalized Settings | Yes | Yes | No, settings will be set as server default |
|
||||
| Add/Remove Users | No | Yes | Yes |
|
||||
| Make/Restore Backups | No | No | Yes |
|
||||
| Disable Authentication | No | No | Yes |
|
||||
@@ -1,32 +0,0 @@
|
||||
# Dashboard
|
||||
|
||||
The Dashboard is where you get an overview of your vehicle. It is the default tab that the user will see when they click into a vehicle and it is also the only tab that cannot be hidden.
|
||||
|
||||
|
||||
|
||||
The Dashboard includes the following data:
|
||||
- Expenses By Type By Year/All Time(Top-Left)
|
||||
- Total Expenses By Month By Year/All Time(Top-Center)
|
||||
- Reminders by current date or future date(Top-Right)
|
||||
- Collaborators(Bottom-Left), see [[Adding Collaborators|Vehicle Management#adding-a-collaborator]]
|
||||
- Fuel Mileage By Month By Year/All Time(Bottom-Center)
|
||||
- Vehicle Maintenance Report Generator(Bottom-Right)
|
||||
|
||||
## Filtering Data by Year
|
||||
The year dropdown above the pie chart(top-left) allows the user to filter the aggregated data by year. The year selections are populated by retrieving all years between the year of the oldest record and the current year. If the oldest record is less than 5 years old, the selections will still be populated by the last 5 years.
|
||||
|
||||
Note: Changing the selected year will automatically refresh the Expenses by Type Pie Chart, the Total Expenses by Month and the Fuel Mileage By Month Bar Charts.
|
||||
|
||||
|
||||
|
||||
## Vehicle Maintenance Report
|
||||
The Vehicle Maintainence Report Generator is a button that will generate a consolidated report of all work performed on the vehicle. For performance reasons, this report is designed to be printed as soon as it is generated. You can either choose to print it to paper or PDF.
|
||||
|
||||
|
||||
|
||||
## Export Attachments
|
||||
The Export Attachments button provies a convenient feature to export all attachments into a chronologically-ordered zip file. Upon clicking the button, you will be prompted to select which tabs you want attachments to be exported from.
|
||||
|
||||
|
||||
|
||||
Once you have made your selection, a zip file will be created and downloaded onto your computer. This zip file contains all of the attachments and are named in chronological order(i.e.: the oldest attachment will be named 0 and the second oldest attachment 1, 2...)
|
||||
@@ -1,62 +0,0 @@
|
||||
# Fuel Records
|
||||
|
||||
The Fuel tab keeps track of the fuel mileage for your vehicle.
|
||||
|
||||
|
||||
|
||||
LubeLogger supports fuel mileage calculation in the following formats:
|
||||
- American Imperial (MPG)
|
||||
- European/Asian Metric (L/100Km)
|
||||
- British(Purchase Gas in Liters and calculate fuel mileage as Miles per Imperial UK Gallons)
|
||||
- Electric Vehicles (mi./kWh or kWh/100Km)
|
||||
|
||||
## Initial Fuel Up
|
||||
In order to calculate fuel mileage, you must first have an initial fuel entry with the current odometer reading. An odometer reading is needed so that the app can calculate the distance traveled between fuel ups. It is recommended that you fill it up to full for the first entry.
|
||||
|
||||
## Imperfect Fuel Ups
|
||||
For the most accurate results it is recommended that you always fill your vehicle up to full and not miss any fuel ups, but sometimes things happen, which is why we provided the following:
|
||||
|
||||
### Partial Fuel Ups
|
||||
On the occassions that you cannot fill your vehicle up to full, you can defer the fuel mileage calculation by unchecking the "Is Filled To Full" switch. Doing this tells the app to defer fuel mileage calculation until the next Full Fill Up.
|
||||
|
||||
|
||||
|
||||
### Missed Fuel Ups
|
||||
Check this if you have missed a fuel up record prior to adding this fuel record. This effectively resets the fuel mileage calculation and will show up as $0 or "---" in the fuel records. Checking this ensures that the average fuel mileage calculation isn't skewed due to missed fuel ups.
|
||||
|
||||
## Calculation of Average Fuel Mileage
|
||||
Average MPG is calculated by excluding the initial and missed fuel ups, then taking the difference between the min and max odometer reading and dividing it by total amount of gas consumed(if Metric then it is further divided by 1/100). This method will include all of the gas consumed by full and partial fuel ups.
|
||||
|
||||
## Fuel Units
|
||||
The consumption, fuel mileage, and odometer units are determined by two settings: "Use Imperial Calculation" and "Use UK MPG Calculation"
|
||||
|
||||
| Setting | Use UK MPG Calculation Checked | Use UK MPG Calculation Unchecked |
|
||||
| -------- | -------- | -------- |
|
||||
| Use Imperial Calculation Checked | Distance: Miles, Consumption: Liters, Fuel Mileage: Miles per UK Gallons | Distance: Miles, Consumption: Gallons, Fuel Mileage: MPG |
|
||||
| Use Imperial Calculation Unchecked | Distance: Miles, Consumption: Liters, Fuel Mileage: l/100mi. | Distance: Km, Consumption: Liters, Fuel Mileage: l/100km |
|
||||
|
||||
### Alternate Fuel Units
|
||||
If you wish to see alternate units which converts the calculated units within the Gas Tab, you can right click on the table headers for Consumption and Fuel Economy. These settings persists for the user, so the next time you login to LubeLogger it will automatically perform the conversion for you.
|
||||
|
||||
|
||||
|
||||
#### Consumption
|
||||
For consumption, the units are cycled between US gal, Liters, and Imp Gal(UK). Changing the consumption unit will also change the unit cost.
|
||||
|
||||
#### Fuel Economy
|
||||
The units can only toggle between l/100km and km/l, which means that this unit cannot be converted if your fuel economy unit is not l/100km. Changing the fuel economy unit will also update the values in the Average, Min, and Max Fuel Economy labels as well as the Fuel Economy Unit in the Consolidated Report.
|
||||
|
||||
## Importing from CSV/Fuelly/SpiritMonitor.de
|
||||
LubeLogger supports importing CSV exports from other apps, below lists the column names that are acceptable/mapped to our data points:
|
||||
|
||||
| LubeLogger Data Field | Imported CSV |
|
||||
| -------------------------------------- | -------------------------------------------------------------- |
|
||||
| date | date, fuelup_date |
|
||||
| odometer | odometer |
|
||||
| fuelconsumed | gallons, liters, litres, consumption, quantity, fuelconsumed |
|
||||
| cost | cost, total cost, totalcost, total price |
|
||||
| notes | notes, note |
|
||||
| partialfuelup(inverse of isfilltofull) | partial_fuelup |
|
||||
| isfilltofull | isfilltofull, filled up |
|
||||
| missedfuelup | missedfuelup, missed_fuelup |
|
||||
| tags | tags |
|
||||
@@ -1,73 +0,0 @@
|
||||
# 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 download the zip archive attached to the release, usually named LubeLogger_vNNN_win_x64.zip, extract the archive and 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
|
||||
@@ -1,46 +0,0 @@
|
||||
# Set Up HTTPS
|
||||
|
||||
LubeLogger runs on Kestrel, which is a cross-platform standalone web server provided by .NET
|
||||
|
||||
If you're running LubeLogger behind a reverse proxy(i.e. NGINX), then this walkthrough does not apply to you since the SSL certs will be served up by NGINX instead of Kestrel.
|
||||
|
||||
This article covers the step-by-step process to set up HTTPS for a LubeLogger instance.
|
||||
|
||||
## Docker
|
||||
If you're running LubeLogger on a Docker instance, first read [this article by Microsoft](https://learn.microsoft.com/en-us/aspnet/core/security/docker-compose-https?view=aspnetcore-8.0)
|
||||
|
||||
1. Convert the .PEM / .CRT files into .PFX, read [this StackOverflow post](https://stackoverflow.com/questions/808669/convert-a-cert-pem-certificate-to-a-pfx-certificate)
|
||||
2. Open and modify the .env file and add the following lines(note that in this example I used bob as the password for the cert)
|
||||
```
|
||||
ASPNETCORE_Kestrel__Certificates__Default__Password=bob
|
||||
ASPNETCORE_Kestrel__Certificates__Default__Path=/https/<yourPFXCertificateName>.pfx
|
||||
ASPNETCORE_URLS=https://+:443;http://+:80
|
||||
```
|
||||
3. Open and modify docker-compose.yml. You will need to bind a new volume to the Docker container so that Kestrel can access the certificate file.
|
||||
```
|
||||
volumes:
|
||||
- ~/https/:/https:ro
|
||||
```
|
||||
4. Run `docker-compose up -d` to start up the container and `https://localhost` will now have a valid cert.
|
||||
|
||||
## Windows
|
||||
If you're running LubeLogger as the standalone Windows executable, first read [this article by Microsoft](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel/endpoints?view=aspnetcore-8.0#configure-https-in-appsettingsjson)
|
||||
|
||||
1. Convert the .PEM / .CRT files into .PFX, read [this StackOverflow post](https://stackoverflow.com/questions/808669/convert-a-cert-pem-certificate-to-a-pfx-certificate)
|
||||
2. Open and modify appsettings.json located in the same directory as the CarCareTracker executable and add the following lines(note that in this example I used bob as the password for the cert)
|
||||
```
|
||||
"Kestrel": {
|
||||
"Endpoints": {
|
||||
"Http": {
|
||||
"Url": "http://localhost:80"
|
||||
},
|
||||
"HttpsInlineCertFile": {
|
||||
"Url": "https://localhost:443",
|
||||
"Certificate": {
|
||||
"Path": "<path to .pfx file>",
|
||||
"Password": "bob"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
3. Restart the app and `https://localhost` will now have a valid cert.
|
||||
@@ -1,25 +0,0 @@
|
||||
# Notes
|
||||
|
||||
The Notes tab contains important notes about your vehicle.
|
||||
|
||||
## Markdown Parsing
|
||||
Markdown formatting is supported across all Notes fields in the app. The underlying markdown parser is [Drawdown](https://github.com/adamvleggett/drawdown). To toggle between edit and preview mode, simply click on the markdown icon next to the "Notes" label.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
There is also a setting, that when enabled, will automatically load all notes in Markdown form when viewing existing records. The only exception is when an existing record has an empty notes field.
|
||||
|
||||
## Pinned Notes
|
||||
Notes can be pinned by checking the "Pinned" switch when creating or editing a note.
|
||||
|
||||
|
||||
|
||||
Pinned Notes will always show up at the very top of the list.
|
||||
|
||||
|
||||
|
||||
On non-touchscreen devices, pinned notes can be viewed when the user hovers over the vehicle tile in the garage. On mobile, the user have to hold down on the garage tile in order for the pinned notes to show up.
|
||||
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
# Odometer
|
||||
|
||||
The Odometer tab is where you can log your current odometer reading without having to insert any Service/Repair/Upgrade/Fuel records. This odometer readings entered in this tab allows Reminder urgencies to be calculated as accurately as possible since it uses the maximum mileage reported in each of the tabs to determine the last reported mileage.
|
||||
|
||||
The Odometer tab is hidden by default and must be enabled by checking the "Odometer" switch under "Visible Tabs" in the Settings tab.
|
||||
|
||||
## API Integration
|
||||
As with the other tabs, odometer readings can be retrieved via a GET endpoint and inserted via a POST API endpoint.
|
||||
|
||||
Example use cases:
|
||||
- An app to integrate with OBDII and insert odometer reading from the vehicle's computer onto LubeLogger.
|
||||
- An app to keep track of distance traveled via GPS and incrementing the last reported odometer reading.
|
||||
|
||||
These are not functionalities provided out of the box by LubeLogger, and are just examples of the possibilities achievable via the API endpoints.
|
||||
@@ -1,62 +0,0 @@
|
||||
# Planner
|
||||
|
||||
The Planner tab is where you can plan and track progress of future or current plans for your vehicle. The planner tab consists of 4 swimlanes(vertical panels) where plans can be moved to different stages via drag and drop.
|
||||
|
||||
|
||||
|
||||
The records stored in Service/Repair/Upgrade tabs tend to be inserted retroactively(after the work is done), hence the Planner tab was developed to keep track of To-Do's.
|
||||
|
||||
## Adding a new Plan
|
||||
The Planner tab is hidden by default, you must enable it by checking the "Planner" switch under "Visible Tabs" within the Settings tab.
|
||||
|
||||
To add a new plan, simply click on the "Add Plan Record" button and fill in the details of the plan.
|
||||
|
||||
|
||||
|
||||
## Plan Type
|
||||
You are required to select at least one Plan Type - Service, Repair, or Upgrade. When the Plan Record is moved to Done, the Plan Record will be automatically converted into the selected type and it will then show up in its respective tab. The type is indicated by an icon corresponding to their respective tabs.
|
||||
|
||||
## Plan Priority
|
||||
Within the swimlanes, plans are sorted from Critical priority to Low priority. They are also indicated by an icon - Fire for Critical, Waves for Normal, and Snowflake for Low.
|
||||
|
||||
|
||||
|
||||
## Plan Stages
|
||||
**Planned** - This is considered the backlog, where no work has been performed yet. i.e.: Shopping for a lift kit.
|
||||
|
||||
**Doing** - This is when work has been started on the task. i.e.: Installing the lift kit.
|
||||
|
||||
**Testing** - This is where the work is being reviewed / tested. i.e.: Going for a test drive with the lift kit.
|
||||
|
||||
**Done** - This is where the work is marked as completed.
|
||||
|
||||
### Updating Plan Stages
|
||||
There are two ways you can update the stage a plan is currently in: drag and drop or updating it via the dropdown when editing a plan. You can backtrack a plan's stages within Planned, Doing, and Testing. i.e.: You can move the plan back from Testing to Doing if you find out there is more work to be done.
|
||||
|
||||
### Moving to Done
|
||||
when a Plan is being moved to Done, it will prompt you to enter the current odometer reading. This is to ensure that the Service/Repair/Upgrade record that will be created from it contains the most up-to-date odometer reading.
|
||||
|
||||
Once a Plan has been marked as Done, it can never be taken out of it. The only action that can be performed on it is Delete. You can delete Plans in the Done stage by clicking on them.
|
||||
|
||||
## Plan Templates
|
||||
For records that have a fixed interval(i.e. oil changes), it is recommended that you create a Plan Template instead.
|
||||
|
||||
### Creating a Template
|
||||
To create a template, simply fill in the details / select the supplies to requisition for the plan, but instead of clicking the "Add New Plan Record" button, you will click on the dropdown next to it and select "Save As Template"
|
||||
|
||||
|
||||
|
||||
The template will now be created and named after the description of the plan record.
|
||||
|
||||
### Using Templates
|
||||
To create a plan record from a template, click on the "View Templates button" and a dialog will show up with the saved templates for the vehicle
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The shop icon indicates if the template has supplies requisition and the paper clip icon(not shown) indicates if the template has file attachments.
|
||||
|
||||
To use the template, simply click on the "+" button. The app will then perform a check to ensure that there are sufficient quantities of the supplies used by the template. If there are insufficient quantities, an error message will pop up telling you which supply is short.
|
||||
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
# Postgres
|
||||
|
||||
For users that desire additional scalability for their backend, LubeLogger now supports a PostgreSQL backend.
|
||||
|
||||
## Configuration
|
||||
|
||||
To configure LubeLogger to use PostgreSQL, you must first create a database with a schema named "app" in it, in the screenshot below we created a DB named "lubelogger" and then a schema named "app".
|
||||
|
||||
|
||||
|
||||
Once that is done, simply inject the environment variable `POSTGRES_CONNECTION` with your connection string, example:
|
||||
|
||||
```
|
||||
Host=<yourserveraddress:port>;Username=<yourusername>;Password=<yourpassword>;Database=<databasename>;
|
||||
```
|
||||
|
||||
LubeLogger will then automatically create the tables it needs, all records will then be saved and loaded from Postgres tables from now on.
|
||||
|
||||
## Backups
|
||||
|
||||
Once you have switched over to Postgres, LubeLogger's built in and backup function will only back up images, documents, and the server config. You are responsible for maintaining backups of the DB records.
|
||||
|
||||
## Database Migration
|
||||
|
||||
A tool is provided to ease the migration process between LiteDB and Postgres. This tool can be found at the `/migration` endpoint and is only accessible when a Postgres connection is provided.
|
||||
|
||||
|
||||
|
||||
### Importing to Postgres
|
||||
|
||||
To transfer all your existing data from LiteDB to Postgres:
|
||||
1. Create a backup using the "Make Backup" feature in the Settings tab.
|
||||
2. Extract the zip file.
|
||||
3. You should see a folder named "data" in the extracted folder
|
||||
4. Inside the data folder will be a .db file named `cartracker.db`
|
||||
5. Navigate to the Database Migration tool
|
||||
6. Click "Import to Postgres"
|
||||
7. Select the `cartracker.db` file
|
||||
8. Your data will be imported into your Postgres DB, and you may double check that the DB has been imported successfully using a Postgres DB Administration Tool.
|
||||
|
||||
### Exporting from Postgres
|
||||
|
||||
In the event that you need to transfer all your data back onto a LiteDB database file from Postgres, you may do so using the Database Migration tool:
|
||||
1. Navigate to the Database Migration Tool
|
||||
2. Click "Export from Postgres"
|
||||
3. Extract the downloaded zip file and you should find `cartracker.db` in it.
|
||||
4. Create a backup using the "Make Backup" feature in the Settings tab.
|
||||
5. Extract the zip file.
|
||||
6. You should see a folder named "data" in the extracted folder, if not, create it.
|
||||
7. Place `cartracker.db` inside the "data" folder
|
||||
8. Re-zip the extracted folder
|
||||
9. Restore the backup using the "Restore Backup" feature in the Settings tab.
|
||||
10. Make sure you remove the PostgreSQL connection from the environment variables so that all future changes will be saved in LiteDB.
|
||||
@@ -1,49 +0,0 @@
|
||||
# Reminders
|
||||
|
||||
Reminders are future tasks where the urgency are based on how close the user is to the due date or odometer reading.
|
||||
|
||||
|
||||
|
||||
## Adding Reminders
|
||||
Reminders can either be added directly on the Reminders tab by clicking the "Add Reminder" button or via adding a new [[Service/Repair/Upgrade Record|Records/Service Records#adding-reminders]].
|
||||
|
||||
## Reminder Metrics
|
||||
Similar to the maintenance schedule outlined in your vehicle's user manual, the urgency of a Reminder can be set either via a due date, a future odometer reading, or whichever comes first.
|
||||
|
||||
|
||||
|
||||
## Reminder Urgency
|
||||
Depending on the metric selected, reminder urgency is calculated either via the server's current date, the max odometer reading across the Odometer/Service/Repair/Upgrade/Fuel tabs, or whichever comes first.
|
||||
|
||||
| Urgency | Due Date | Future Odometer Reading |
|
||||
| ---------- | ------------- | ----------------------- |
|
||||
| Not Urgent | > 30 days out | > 100 miles out |
|
||||
| Urgent | < 30 days out | < 100 miles out |
|
||||
| Very Urgent | < 7 days out | < 50 miles out |
|
||||
| Past Due | > 0 days past | > 0 miles past |
|
||||
|
||||
## Recurring Reminders
|
||||
Reminders can be set to become recurring so that you don't have to create a new reminder for recurring maintenance such as oil changes. When you have completed the task set by the reminder, you can either have it automatically refresh when it lapses or by manually refreshing it. Refreshing a reminder effectively pushes out the due date or the odometer reading based on the recurring interval, i.e.: if a Reminder is due at 10000 miles and the interval is set at every 5000 miles, refreshing the Reminder will push the future odometer reading out to 15000 miles.
|
||||
|
||||
### Automatically Refresh Past Due Reminders
|
||||
There is a setting within the Settings tab that allows users to automatically refresh past due reminders. Note that with this setting enabled, any reminder that becomes Past Due will be automatically refreshed, this requires a lot of diligence from the user to heed their reminders and stay on top of it.
|
||||
|
||||
|
||||
|
||||
### Manually Refresh Reminders
|
||||
When a recurring reminder falls into Very Urgent or Past Due status, there will be a button on the Reminders page that will allow the user to manually refresh the reminder.
|
||||
|
||||
|
||||
|
||||
This reminder is set to be recurring every 1 year, so when the "Done" button is clicked, it will push the due date of this reminder to 1/31/2025.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Reminder Emails
|
||||
If SMTP is configured within LubeLogger, the Root User can set up a cron / scheduled task that runs at an interval to send out emails to collaborators of vehicles with reminders. The API endpoint allows the user to specify what level of urgencies should the user be notified of.
|
||||
|
||||
Sample bash script: https://github.com/hargata/lubelog_scripts/blob/main/bash/sendreminders.sh
|
||||
|
||||
The sample provided above will send email reminders out for reminders of all urgencies.
|
||||
@@ -1,19 +0,0 @@
|
||||
# Replacing The LubeLogger Logo
|
||||
|
||||
You can overwrite the LubeLogger Logo that is displayed in the Login and Home/Garage page.
|
||||
|
||||
To do so, simply inject an environment variable with the key `LUBELOGGER_LOGO_URL` into your lubelogger instance either via the .env file or the appsettings.json file.
|
||||
|
||||
## .env
|
||||
```
|
||||
LUBELOGGER_LOGO_URL=<URL to your Logo>
|
||||
```
|
||||
|
||||
## appsettings.json
|
||||
```
|
||||
LUBELOGGER_LOGO_URL:<URL to your Logo>
|
||||
```
|
||||
|
||||
## Non-replaceable Locations
|
||||
- Logo in the About section in the Settings tab
|
||||
- Logo that shows up in the top left of the Vehicle Maintenance History Report
|
||||
@@ -1,36 +0,0 @@
|
||||
# Service/Repair/Upgrade Records
|
||||
These three are perhaps the most important tabs in LubeLogger. They are functionally identically to one another, except for the type of records stored in them.
|
||||
|
||||
Service Records: These are planned/scheduled maintenance performed on the vehicle, usually on a fixed interval. Examples include oil changes, brakes, tires, spark plugs, air filter.
|
||||
|
||||
Repair Records: These are unplanned/unscheduled work performed on the vehicle whether due to an accident, a component breaking unexpectedly, or a broken component with no fixed maintenance interval. Examples include replacing the alternators, starters, radiators, power steering pump, bumpers.
|
||||
|
||||
Upgrade Records: These are work performed on the vehicle that enhances the functionality or aesthetics of the vehicle. Examples include: roof racks, lift kits, aftermarket wheels, stereos.
|
||||
|
||||
To add a new record, simply navigate to the tab and click the "Add New Service/Repair/Upgrade Record" button and you will be prompted to input the details of the record.
|
||||
|
||||
|
||||
|
||||
## Moving Records
|
||||
To move existing records between the three tabs, simply click on the dropdown button to the right of the Delete button and select the tab to move the record to.
|
||||
|
||||
|
||||
|
||||
## Supplies Requisition
|
||||
If you have supplies set up, you can click the "Choose Supplies" link under the Cost field, and a dialog will prompt you to select the supplies and quantity of each supplies you wish to requisition for this record.
|
||||
|
||||
|
||||
|
||||
Once you have selected the supplies, the Cost field will automatically update to reflect the costs of the supplies you have selected based on the quantity of each supply. Note that at this point, before the record is created, the supply is not requisitioned yet and you can still edit the selected supplies/quantities.
|
||||
|
||||
Once the record has been created, the supplies will be requisitioned and the quantity / cost of the supplies will be deducted according to the usage. This cannot be reversed(i.e.: you cannot restore the quantities by editing an existing service/repair/upgrade record), you have to go to the Supplies tab to correct the quantity/cost of the supply.
|
||||
|
||||
### Supplies Unit Cost Calculation
|
||||
LubeLogger is not an inventory management system. Unit costs are calculated as an average of total spent / quantity, which means that everytime you replenish your supplies, it will average out the cost even if the latest batch of supplies you purchased is significantly costlier than the last batch. There is no LIFO/FIFO/FAFO inventory valuation methods.
|
||||
|
||||
For more information on Supplies, see [[Supplies|Records/Supplies]]
|
||||
|
||||
## Adding Reminders
|
||||
You are given the option to set a reminder upon creating a record. This is helpful for recurring services such as Oil Changes. To do so, simply check the "Add Reminder" switch before clicking the "Add New Service Record" button. A new dialog will show up after the record has been created and all the fields will be pre-populated.
|
||||
|
||||
For more information on Reminders, see [[Reminders|Records/Reminders]]
|
||||
@@ -1,27 +0,0 @@
|
||||
# Supplies
|
||||
|
||||
The Supplies tab is where you can keep track of supplies or parts purchased for your vehicle, either as spare parts or for future use.
|
||||
|
||||
|
||||
|
||||
The Supplies tab is hidden by default and requires the user to enable it via the Settings tab under the "Visible Tabs" section.
|
||||
|
||||
|
||||
|
||||
To add a new Supply Record, simply click the "Add New Supply Record" button and you will be prompted for the details of the Supply.
|
||||
|
||||
|
||||
|
||||
Supplies that are in the system that have a quantity greater than zero are available for [[Requisitioning|Records/Service Records#supplies-requisition]]
|
||||
|
||||
## Shop Supplies
|
||||
|
||||
Shop supplies are for supplies that are at a garage level and is available for requisitioning across all vehicles. This is useful for supplies that are shared across multiple vehicles such as motor oil, washer fluid, tires, etc.
|
||||
|
||||
|
||||
|
||||
This tab is disabled by default, but can be enabled by the Root User in the Settings tab.
|
||||
|
||||
|
||||
|
||||
Note that shop supplies are available for all users and all vehicles, do not enable this if you don't wish to share supplies with other users. When enabled, any user can add / edit / delete any shop supplies.
|
||||
@@ -1,22 +0,0 @@
|
||||
# Taxes
|
||||
The Taxes tab keeps track of fees and expenses that are incurred by your vehicle that are unrelated to odometer readings.
|
||||
|
||||
|
||||
|
||||
Examples of records that can be recorded in the Taxes tab include:
|
||||
- Registration Fee/Road Tax
|
||||
- Insurance
|
||||
- Fines/Citations
|
||||
- Roadside Assistance
|
||||
- Car Washes
|
||||
- and more!
|
||||
|
||||
## Recurring Taxes
|
||||
Taxes can be set to be recurring so that a new record is created at every interval. The newly-created tax record is duplicated from the last recurrence.
|
||||
|
||||
|
||||
|
||||
The way this functionality works is that when the user clicks into a vehicle detail, a check is performed if there are any recurring tax records that are past due. If there are, those tax records are then duplicated with the due date pushed out by the set interval. The newly duplicated will be set to recur at the set interval while the tax record that was past due will have recurrance disabled.
|
||||
|
||||
### Notes on Recurring Taxes
|
||||
Since recurring taxes are duplicated from the previous occurrence, it is not recommended for fees with differing values be set up as recurring, i.e.: Registration Fees do not stay constant year to year in most if not all parts of the United States, even if most people renew their vehicle's registration at the same time every year.
|
||||
@@ -1,35 +0,0 @@
|
||||
# Translations
|
||||
|
||||
LubeLogger supports UI Translations for ~95% of UI elements.
|
||||
|
||||
The following are not covered by translations:
|
||||
- Toasts(messages that pop up on the top right)
|
||||
- Sweetalert prompts(confirm delete dialogs, etc)
|
||||
- About section
|
||||
|
||||
## Where to get translations
|
||||
Translations can be found at [this repository](https://github.com/hargata/lubelog_translations/)
|
||||
|
||||
1. To upload a translation file, login as the root user.
|
||||
2. Navigate to "Settings"
|
||||
3. Click "Upload" under the "Manage Languages" section
|
||||
|
||||
|
||||
4. Select the language file you wish to upload
|
||||
5. The page should refresh
|
||||
6. Select the language file from the dropdown to set it as your default language.
|
||||
|
||||
## Creating your own translation
|
||||
1. Download the [latest en_US.json](https://github.com/hargata/lubelog/blob/main/wwwroot/defaults/en_US.json) file from the GitHub Repository for LubeLogger.
|
||||
2. Rename this file, en_US is a reserved name.
|
||||
3. Use a JSON pretty-printer to make it human-readable
|
||||
|
||||
|
||||
3. The objects to the left of the ":" are the translation keys, DO NOT modify these.
|
||||
4. The objects to the right of the ":" are the translation values(shown in green), these are what you want to translate.
|
||||
5. To test out your translation, simply upload it to your LubeLogger instance and test it out.
|
||||
|
||||
## Contribute
|
||||
Follow the instructions outlined in the [official repository](https://github.com/hargata/lubelog_translations/)
|
||||
|
||||
Translation efforts are coordinated via [this thread](https://github.com/hargata/lubelog/discussions/240)
|
||||
@@ -1,56 +0,0 @@
|
||||
# Troubleshooting
|
||||
Common issues and steps you can take to fix them.
|
||||
|
||||
## General Issues
|
||||
|
||||
### Button doesn't work / feature stopped working.
|
||||
Your browser might have cached an older version of a JavaScript(JS) file which is no longer compatible with the current version of LubeLogger. Clear your browser's cache and retry.
|
||||
|
||||
### Can't Send Email via SMTP
|
||||
Note that for most email providers, you can no longer use your account password to authenticate and must instead generate an app password for LubeLogger to be able to authenticate on your behalf to your email provider's SMTP server.
|
||||
|
||||
If you've downloaded the .env file from the GitHub repo, there is an issue with how the file gets formatted when it is downloaded, you will have to copy the contents and re-create one manually on your machine.
|
||||
|
||||
### Console shows Authentication Errors
|
||||
Those are purely informational, add a line in your environment variables to prevent information logs from showing up in the console.
|
||||
|
||||
## Locale Issues
|
||||
|
||||
### Can't input values in "," format / shows up as 0.
|
||||
Ensure that your locale environment variables are configured correctly, note that if running via docker, both environment variables LANG and LC_ALL have to be identical.
|
||||
|
||||
### Can't change locale.
|
||||
Environment variables are injected on deployment. You will need to re-deploy.
|
||||
|
||||
## Server Issues
|
||||
|
||||
### NGINX / Cloudflare
|
||||
LubeLogger is a web app that runs on Kestrel, it literally doesn't matter if it's deployed behind a reverse proxy or Cloudflare tunnel. As long as the app can receive traffic on the port it's configured on, it will run.
|
||||
|
||||
Here's a sample Nginx reverse proxy configuration courtesy of [thehijacker](https://github.com/thehijacker)
|
||||
```
|
||||
server
|
||||
{
|
||||
listen 443 ssl http2;
|
||||
server_name lubelogger.domain.com;
|
||||
|
||||
ssl_certificate /etc/nginx/ssl/acme/domain.com/fullchain.pem;
|
||||
ssl_certificate_key /etc/nginx/ssl/acme/domain.com/key.pem;
|
||||
ssl_dhparam /etc/nginx/ssl/acme/domain.com/dhparams.pem;
|
||||
ssl_trusted_certificate /etc/nginx/ssl/acme/domain.com/fullchain.pem;
|
||||
|
||||
location /
|
||||
{
|
||||
proxy_pass http://192.168.28.53:8289;
|
||||
client_max_body_size 50000M;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
proxy_redirect off;
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -1,50 +0,0 @@
|
||||
# Vehicle Management
|
||||
|
||||
## Adding a Vehicle
|
||||
To add a vehicle, simply click on the green "+" button in the "Garage" tab. A dialog will then prompt you for the following details of the vehicle you wish to add: Year, Make, Model, License Plate, and optionally, a picture of the vehicle. If it's an Electric Vehicle, you should check the "Electric Vehicle" switch. This ensures that "fuel" economy is measured in kWh instead of gallons or liters.
|
||||
|
||||
|
||||
|
||||
Once you're done, click "Add New Vehicle" and the vehicle will now be visible in the Garage Tab.
|
||||
|
||||
|
||||
|
||||
### Sorting Vehicles
|
||||
To sort vehicles by Year, simply right click on the Garage tab while the tab is selected.
|
||||
|
||||
On mobile, make sure the Garage tab is selected and long hold on the garage menu button.
|
||||
|
||||
## Editing a Vehicle
|
||||
To edit an existing vehicle, go into the vehicle details by clicking on the vehicle tile in the Garage. If you're on a computer/tablet, there will be a yellow button on the top right of the screen, click it to edit details regarding the vehicle.
|
||||
|
||||
|
||||
|
||||
On mobile devices, the "Edit Vehicle" button is available within the menu
|
||||
|
||||
|
||||
|
||||
## Deleting a Vehicle.
|
||||
To delete an existing vehicle, click on the "Manage Vehicle" dropdown and select "Delete Vehicle". You will then be prompted for confirmation before the vehicle is deleted. Once the vehicle is deleted, you will be redirected back to the Garage.
|
||||
|
||||
|
||||
|
||||
On mobile devices, the "Delete Vehicle" button is available within the menu, located at the very bottom.
|
||||
|
||||
|
||||
|
||||
## Adding a Collaborator
|
||||
If more than one individual logs records to your vehicle(e.g.: spouse, employee, etc) and they have their own user account with LubeLogger, you can add them as a collaborator.
|
||||
|
||||
To add new collaborator, simply navigate to the Dashboard tab in the vehicle details view and look to the bottom right:
|
||||
|
||||
|
||||
|
||||
Click on the blue Add User icon on the top left of the Collaborators panel and you will be prompted to type in their username, note that a user with that username must exist in the system or you will get an error.
|
||||
|
||||
|
||||
|
||||
Once you have added them as a collaborator, their name will now show up in the Collaborators list, and you will also be given the option to remove them.
|
||||
|
||||
|
||||
|
||||
Once this is done, you should have the new collaborator refresh their browser and they should be able to see the vehicle in their Garage.
|
||||
@@ -163,7 +163,7 @@
|
||||
</div>
|
||||
<div class="col-12 d-flex justify-content-center">
|
||||
<p class="lead">
|
||||
Read this <a class='link-light link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover' href='https://docs.lubelogger.com/Getting%20Started'>Getting Started Guide</a> on how to download either of them
|
||||
Read this <a class='link-light link-offset-2 link-underline-opacity-25 link-underline-opacity-100-hover' href='https://docs.lubelogger.com/Installation/Getting%20Started'>Getting Started Guide</a> on how to download either of them
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user