Files
lubelog/README.md
Florian Schroen 2e301760f4 rename docker-compose files and remove unused network "app"
the default docker compose file should be minimal and easy to read as docker-compose.yml

other docker-compose variants for typical setup should be named as:
 docker-compose.<variant>.yml

this way one could use e.g. `docker compose -f docker-compose.traefik.yml up` to
start the variant for traefik. (mind keeping the file extension)

and fixed a typo the README.md
2024-01-06 19:01:18 +01:00

59 lines
1.1 KiB
Markdown

![image](https://github.com/hargata/lubelog/assets/155338622/545debcd-d80a-44da-b892-4c652ab0384a)
A self-hosted, open-source vehicle service records and maintainence tracker.
## Why
Because nobody should have to deal with a homemade spreadsheet or a shoebox full of receipts when it comes to vehicle maintainence.
## Dependencies
- Bootstrap
- LiteDB
- Bootstrap-DatePicker
- SweetAlert2
- CsvHelper
- Chart.js
## Docker Setup (Recommended)
1. Install Docker
2. Clone this repo
3. Run `docker build -t lubelogger -f Dockerfile .`
4. CHECK docker-compose.yml and make sure the mounting directories look correct.
5. If not using traefik, use docker-compose-notraefik.yml
5. Run `docker-compose up`
## Additional Docker Instructions
### manual
- build
```
docker build -t hargata/lubelog:latest .
```
- run
```
docker run -d hargata/lubelog:latest
```
add `-v` for persistent volumes as needed. Have a look at the docker-compose.yml for examples.
## docker-compose
- build image
```
docker compose build
```
- run
```
docker compose up
# or variant with traefik labels:
docker compose -f docker-compose.traefik.yml up
```