lsioarmhf/clarkson

By lsioarmhf

Updated about 6 years ago

Image
1

6.5K

THIS IMAGE IS DEPRECATED. PLEASE USE THE MULTI-ARCH IMAGES AT linuxserver/clarkson

linuxserver.io

Contact information:-

TypeAddress/Details
DiscordDiscord
ForumLinuserver.io forum
IRCfreenode at #linuxserver.io more information at:- IRC
PodcastCovers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! Linuxserver.io Podcast

The LinuxServer.io team brings you another image release featuring :-

  • regular and timely application updates
  • easy user mappings
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • security updates

lsioarmhf/clarkson

Docker PullsDocker StarsBuild Status

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.

clarkson

Usage

docker create \
  --name=clarkson \
  -e PGID=<gid> -e PUID=<uid>  \
  -e MYSQL_HOST=<mysql_host> \
  -e MYSQL_USERNAME=<mysql_username> \
  -e MYSQL_PASSWORD=<mysql_password> \
  -e ENABLE_REGISTRATIONS=<true|false>
  -p 3000:3000 \
  lsioarmhf/clarkson

Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.

ParameterFunction
-p 3000the port(s)
-e PGIDfor GroupID, see below for explanation
-e PUIDfor UserID, see below for explanation
-e MYSQL_HOSTPoints the backend to the MySQL database. This can be either a docker hostname or an IP
-e MYSQL_USERNAMEThe user with access to the clarkson schema
-e MYSQL_PASSWORDThe password for the user
-e ENABLE_REGISTRATIONSDefaults to false. If set to true, allows new users to register

User / Group Identifiers

Sometimes 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 it will "just work" ™.

In this instance PUID=1001 and PGID=1001, to find yours use id user as below:

  $ id <dockeruser>
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

Setting up the application

IMPORTANT... THIS IS THE ARMHF VERSION

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.

CREATE SCHEMA `clarkson`;
CREATE USER 'clarkson_user' IDENTIFIED BY 'supersecretpassword';
GRANT ALL ON `clarkson`.* TO 'clarkson_user';

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.

Container access and information.

FunctionCommand
Shell access (live container)docker exec -it clarkson /bin/bash
Realtime container logsdocker logs -f clarkson
Container version numberdocker inspect -f '{{ index .Config.Labels "build_version" }}' clarkson
Image version numberdocker inspect -f '{{ index .Config.Labels "build_version" }}' lsioarmhf/clarkson

Versions

DateChanges
22.08.18Rebase to alpine linux 3.8.
19.02.18Initial Release.

Docker Pull Command

docker pull lsioarmhf/clarkson