woahbase / alpine-ubooquity

Ubooquity E-book reader service running on Alpine Linux + OpenJDK8.

Alpine-Ubooquity

Container for Alpine Linux + OpenJDK8 + Ubooquity

---

This image containerizes Ubooquity e-book server/viewer, to serve files and read comics/ebooks shared from a device in the network, running under OpenJDK 8.*.*.

Current stable version is 2.1.1.

Based on Alpine Linux from my alpine-openjdk8 image with the s6 init system and GNU LibC overlayed in it.

The image is tagged respectively for the following architectures,

• armhf
• x86_64 (retagged as the latest )

armhf builds have embedded binfmt_misc support and contain the qemu-user-static binary that allows for running it also inside an x64 environment that has it.

---

Get the Image

---

Pull the image for your architecture it's already available from Docker Hub.

# make pull
docker pull woahbase/alpine-ubooquity:x86_64

---

Configuration Defaults

---

• Configuration are read from /config/preferences.json, edit or remount this file to customize settings.

• Default serves books from /books, comics from /comics and files from /files. They should be readable by the process user.

• Default exposes the library port at 2202 and adminport at 2203, however, user management is disabled in the default configurations.

• The MAXMEM variable limits how much memory the JVM can use.

• This image already has a user alpine configured to drop privileges to the passed PUID/PGID which is ideal if its used to run in non-root mode. That way you only need to specify the values at runtime and pass the -u alpine if need be. (run id in your terminal to see your own PUID/PGID values.)

---

Run

---

If you want to run images for other architectures, you will need to have binfmt support configured for your machine. multiarch, has made it easy for us containing that into a docker container.

# make regbinfmt
docker run --rm --privileged multiarch/qemu-user-static:register --reset

Without the above, you can still run the image that is made for your architecture, e.g for an x86_64 machine..

Running make starts the service.

# make
docker run --rm -it \
  --name docker_ubooquity --hostname ubooquity \
  -e PGID=1000 -e PUID=1000 \
  -c 512 -m 1024m -e MAXMEM=1024 \
  -p 2202:2202 -p 2203:2203 \
  -v config:/config \
  -v books:/books \
  -v comics:/comics \
  -v files:/files \
  woahbase/alpine-ubooquity:x86_64

Stop the container with a timeout, (defaults to 2 seconds)

# make stop
docker stop -t 2 docker_ubooquity

Removes the container, (always better to stop it first and -f only when needed most)

# make rm
docker rm -f docker_ubooquity

Restart the container with

# make restart
docker restart docker_ubooquity

---

Shell access

---

Get a shell inside a already running container,

# make shell
docker exec -it docker_ubooquity /bin/bash

set user or login as root,

# make rshell
docker exec -u root -it docker_ubooquity /bin/bash

To check logs of a running container in real time

# make logs
docker logs -f docker_ubooquity

---

Development

---

If you have the repository access, you can clone and build the image yourself for your own system, and can push after.

---

Setup

---

Before you clone the repo, you must have Git, GNU make, and Docker setup on the machine.

git clone https://github.com/woahbase/alpine-ubooquity
cd alpine-ubooquity

You can always skip installing make but you will have to type the whole docker commands then instead of using the sweet make targets.

---

Build

---

You need to have binfmt_misc configured in your system to be able to build images for other architectures.

Otherwise to locally build the image for your system. [ARCH defaults to x86_64, need to be explicit when building for other architectures.]

# make ARCH=x86_64 build
# sets up binfmt if not x86_64
docker build --rm --compress --force-rm \
  --no-cache=true --pull \
  -f ./Dockerfile_x86_64 \
  --build-arg ARCH=x86_64 \
  --build-arg DOCKERSRC=alpine-openjdk8 \
  --build-arg UBVERSION=2.1.0 \
  --build-arg USERNAME=woahbase \
  -t woahbase/alpine-ubooquity:x86_64 \
  .

To check if its working..

# make ARCH=x86_64 test
docker run --rm -it \
  --name docker_ubooquity \
  --hostname ubooquity  \
  -e PGID=1000 -e PUID=1000 \
  -c 512 -m 1024m -e MAXMEM=1024 \
  woahbase/alpine-ubooquity:x86_64 \
  sh -ec 'sleep 15; java -version';

And finally, if you have push access,

# make ARCH=x86_64 push
docker push woahbase/alpine-ubooquity:x86_64

---

Maintenance

---

Sources at Github. Built at Travis-CI.org (armhf / x64 builds). Images at Docker hub. Metadata at Microbadger.

Maintained by WOAHBase.