Skip to content
Hargata Softworks edited this page Apr 22, 2024 · 10 revisions

Quick Start Guide

Quick, No Configuration Guide for Spinning Up LubeLogger in Docker

Run the following commands:

docker pull ghcr.io/hargata/lubelogger:latest
curl https://raw.githubusercontent.com/hargata/lubelog/main/.env -o .env
curl https://raw.githubusercontent.com/hargata/lubelog/main/docker-compose.yml -o docker-compose.yml
docker compose up -d

Edge Releases

Occasionally you will find a LubeLogger Docker image tagged edge

Edge-tagged Docker images contains the latest changes merged into main and hence may contain unstable/untested functionalities/bug fixes. Use this at your own discretion.

Once the changes have been tested thoroughly, we will create a release and a new Docker image will be created tagged with the version number. There is no fixed time frame for the QA/Testing phase, so there is a chance that a feature/fix will remain in the edge tagged image for an extended period of time.

Developer Documentation

The following section is specifically for developers: those wishing to build LubeLogger on their own and/or contribute to the project

Tools and Prerequisites

  • .NET 8 SDK
  • .NET IDE (Visual Studio / Rider) - Optional, but highly recommended

Build Instructions(IDE)

  1. Clone the repository
  2. Open up CarCareTracker.sln in your IDE
  3. Build solution in IDE

Build Instructions(Console)

  1. Clone this repository
  2. Run dotnet restore

Build Instructions(Docker)

  1. Clone this repository
  2. Run docker build --build-arg="TARGETARCH=linux/amd64" -t lubelogger -f Dockerfile .