docker-documentation/images/docker-gazee.md

4.5 KiB
Executable File

linuxserver.io

The LinuxServer.io team brings you another container release featuring easy user mapping and community support. Find us for support at:

  • forum.linuxserver.io
  • IRC on freenode at #linuxserver.io
  • Podcast covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!

linuxserver/gazee

Docker PullsDocker StarsBuild Status

A WebApp Comic Reader for your favorite digital comics. Reach and read your comic library from any web connected device with a modern web browser.

gazee

Usage

docker create \
  --name=gazee \
  -v <path to data>:/config \
  -v <path to comics>:/comics \
  -v <path to mylar data>:/mylar \
  -v <path to SSL certs>:/certs \
  -e PGID=<gid> -e PUID=<uid>  \
  -p 4242:4242 \
  linuxserver/gazee

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.

  • -p 4242 - the port(s)
  • -v /config - Where Gazee should store config files.
  • -v /comics - Path to comics folder.
  • -v /mylar - Path to Mylar DB
  • -v /certs - Where SSL certs should be stored.
  • -e PGID for GroupID - see below for explanation
  • -e PUID for UserID - see below for explanation

It is based on alpine linux with s6 overlay, for shell access whilst the container is running do docker exec -it gazee /bin/bash.

User / Group Identifiers

Sometimes when using data 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 the data volume directory on the host is 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

Webui can be found at your-ip:4242

Default username and password for the web interface:

  • Username: admin
  • Password: gazee

Click the gear icon to go to the settings page.

Change the default admin password or add a new admin and remove the admin user altogether.

Comic path should be set to /comics

Optional Mylar DB path should be set to /mylar

Optional path for certificates and keys should be set to /certs

After you update the settings, Gazee will restart and begin an intial scan of your comic library.

Happy Reading!

Info

  • Shell access whilst the container is running: docker exec -it gazee /bin/bash

  • To monitor the logs of the container in realtime: docker logs -f gazee

  • container version number

docker inspect -f '{{ index .Config.Labels "build_version" }}' gazee

  • image version number

docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/gazee

Versions

  • 17.08.18: Rebase to alpine 3.8.
  • 30.12.17: Ensure version 11 of cherrypy.
  • 07.12.17: Initial Release.