Search…
Images
Powered By GitBook
linuxserver/clarkson
Clarkson is a web-based dashboard application that gives you a neat and clean interface for logging your fuel fill-ups for all of your vehicles. The application has full multi-user support, as well as multiple vehicles per user. Whenever you fill-up your car or motorcycle, keep the receipt and record the data in Clarkson.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/clarkson should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Application Setup

Clarkson requires v5.7.* of MySQL and please ensure MySQL is running before starting this container.
It is preferred if you create the clarkson schema before initially running the container, then creating a user with granted permissions for the schema. Creating the schema before running the app is important as the "clarkson" user will not have permission to create the schema on your behalf. You can, of course, use the "root" user, which has the ability to create schemas automatically, but this is not recommended.
1
CREATE SCHEMA `clarkson`;
2
CREATE USER 'clarkson_user' IDENTIFIED BY 'supersecretpassword';
3
GRANT ALL ON `clarkson`.* TO 'clarkson_user';
Copied!
Once running, the container will run an initial MySQL migration, which populates the schema with all tables and procedures. The application will start immediately afterwards. You will need to register an initial user, of which will be the admin of the application. All subsequent users will be standard users. You can disable registrations after the fact by recreating the container with the ENABLE_REGISTRATIONS flag set to false. This will not hide the "Register" link, but will disable the functionality.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
clarkson:
5
image: lscr.io/linuxserver/clarkson
6
container_name: clarkson
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- MYSQL_HOST=<mysql_host>
11
- MYSQL_USERNAME=<mysql_username>
12
- MYSQL_PASSWORD=<mysql_password>
13
- ENABLE_REGISTRATIONS=<true/false>
14
- TZ=Europe/London
15
ports:
16
- 3000:3000
17
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=clarkson \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e MYSQL_HOST=<mysql_host> \
6
-e MYSQL_USERNAME=<mysql_username> \
7
-e MYSQL_PASSWORD=<mysql_password> \
8
-e ENABLE_REGISTRATIONS=<true/false> \
9
-e TZ=Europe/London \
10
-p 3000:3000 \
11
--restart unless-stopped \
12
lscr.io/linuxserver/clarkson
Copied!

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter
Function
3000
WebUI

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
MYSQL_HOST=<mysql_host>
Points the backend to the MySQL database. This can be either a docker hostname or an IP.
MYSQL_USERNAME=<mysql_username>
The user with access to the clarkson schema.
MYSQL_PASSWORD=<mysql_password>
The password for the user.
ENABLE_REGISTRATIONS=<true/false>
Defaults to false. If set to true, allows new users to register.
TZ=Europe/London
Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume
Function

Miscellaneous Options

Parameter
Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

    Shell access whilst the container is running:
      docker exec -it clarkson /bin/bash
    To monitor the logs of the container in realtime:
      docker logs -f clarkson
    Container version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' clarkson
    Image version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/clarkson

Versions

    02.06.20: - Rebasing to alpine 3.12.
    19.12.19: - Rebasing to alpine 3.11.
    28.06.19: - Rebasing to alpine 3.10.
    23.03.19: - Switching to new Base images, shift to arm32v7 tag.
    23.03.19: - Updating runtime dependancies for the JRE.
    22.02.19: - Rebasing to alpine 3.9.
    11.02.19: - Add pipeline logic and multi arch.
    22.08.18: - Rebase to alpine linux 3.8.
    19.02.18: - Initial Release.
Last modified 22d ago