diff --git a/docs/documentation/auth.html b/docs/documentation/auth.html deleted file mode 100644 index 1925272..0000000 --- a/docs/documentation/auth.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - LubeLogger - - - - -
-
-
-
- -
-
-
- Getting Started - Changing Locale/Culture - Setup Authentication/Multiple Users - Sharing Vehicles - CSV Import/Export - API -
-
-
- Setup Authentication and Multiple Users -
- Root User -

- Authentication is disabled by default in LubeLogger. To enable authentication, navigate to the "Settings" tab and check "Enable Authentication".
- A dialog will pop up prompting you to enter a Username and Password. These are the credentials for the "Root User", i.e.: the SuperUser.
- Once you have set up your credentials, the app will you out to a Login screen, login using the credentials you just created.
- There will now be a dropdown tab to the right of "Settings", click on it and you will see two options: "Admin Panel" and "Logout" -

- Multiple Users -

- Before you get started, it is highly recommended that you set up a SMTP server(though not required) as it will greatly automate the User's Registration Process.
- If you have an SMTP server, you can set it up in LubeLogger using the variables within .env
- To set up new users, you must first have their email address on hand as the registration process is invite-only by design.
- Navigate to the "Admin Panel" and select "Generate New Token". A dialog will prompt you to enter the email address of the user.
- If you have SMTP set up, there will be a switch right next to the button that says "Auto Notify(via Email)", this switch is only enabled with valid SMTP settings.
- Enter the user's email address, and a new token will be generated and emailed to them if SMTP is set up, otherwise you will have to send it to them manually.
- The user can then navigate to your LubeLogger instance, click the "Register" link under the "Login" button and type in their details including the token they received.
- Note: It is important that their email address matches the email address the token is issued to, otherwise they will receive an Invalid Token error.
- Once the user has registered their account, they will then be able to login and start adding their own vehicles
-

-
-
-
- - - \ No newline at end of file diff --git a/docs/documentation/index.html b/docs/documentation/index.html deleted file mode 100644 index 926cb68..0000000 --- a/docs/documentation/index.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - LubeLogger - - - - -
-
-
-
- -
-
-
- Getting Started - Changing Locale/Culture - Setup Authentication/Multiple Users - Sharing Vehicles - CSV Import/Export - API -
-
-
- Getting Started -
- Docker -

- The Docker container is the most reliable way of getting LubeLogger up and running.
- To get started, you must first have Docker Desktop installed, which can be found here.
- Once Docker is installed and Virtualization is enabled on your computer(usually at the BIOS level), navigate to LubeLogger's GitHub Repository
- The two files that you will need to download from the repository are .env and docker-compose.yml
- The .env file contains all of the environment variables LubeLogger uses such as Culture and SMTP setup.
- The docker-compose.yml file contains instructions that tells Docker how to build the container.
-
- To pull(download) the pre-built Docker image and run it, you just have run the following commands:
- - docker pull ghcr.io/hargata/lubelogger:latest
- docker-compose up -

- LubeLogger's server instance will be started on the default http://localhost:8080 and you can navigate to it to continue setting it up. -

- No Virtualization Solutions -

- Starting 1.0.2 all distribution of LubeLogger is done exclusively through Docker images.
- Pre-compiled standalone executables for Windows/Mac/Linux can be be requested, contact us for more information. -

-
-
-
- - - \ No newline at end of file diff --git a/docs/documentation/locale.html b/docs/documentation/locale.html deleted file mode 100644 index 0d978b6..0000000 --- a/docs/documentation/locale.html +++ /dev/null @@ -1,57 +0,0 @@ - - - - - LubeLogger - - - - -
-
-
-
- -
-
-
- Getting Started - Changing Locale/Culture - Setup Authentication/Multiple Users - Sharing Vehicles - CSV Import/Export - API -
-
-
- Changing Locale -
-

- The culture/locale for LubeLogger is configured in the .env file -
- You should see the following when you open up the .env file in Notepad

- - LC_ALL=en_US.UTF-8
- LANG=en_US.UTF-8 -

- All you have to do is change en_US to any culture you'd like such as de_DE
- Re-build the container and LubeLogger should start displaying currencies and date formats in your culture. -

- Important Note -

- If you have already set up LubeLogger in en_US culture and have inputted data in it before switching over a culture that uses "," for decimals
- you will most likely run into issues where existing data in the system gets returned as thousands.
- The culture should stay consistent for as long as you plan to use LubeLogger. -

-
-
-
- - - \ No newline at end of file diff --git a/docs/documentation/lubelogger_logo.png b/docs/documentation/lubelogger_logo.png deleted file mode 100644 index b3713e8..0000000 Binary files a/docs/documentation/lubelogger_logo.png and /dev/null differ diff --git a/docs/documentation/share.html b/docs/documentation/share.html deleted file mode 100644 index 3fa6c75..0000000 --- a/docs/documentation/share.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - LubeLogger - - - - -
-
-
-
- -
-
-
- Getting Started - Changing Locale/Culture - Setup Authentication/Multiple Users - Sharing Vehicles - CSV Import/Export - API -
-
-
- Sharing Vehicles -
- Adding Collaborators to Vehicles -

- By default, users are not able to see other user's vehicles. To share a vehicle with another user, simply click into the vehicle.
- Make sure that you are on the "Dash" or "Dashboard" tab, and look to the bottom left where there is a little panel called "Collaborators".
- To add a collaborator, simply click the "Add" button on the right and type in the username of the user you wish to share this vehicle with.
- If the username is valid the user will be added as a collaborator and they can now view and edit the vehicle.
-

-
-
-
- - - \ No newline at end of file