The LinuxServer.io team brings you another container release featuring :-
- regular and timely application updates
- easy user mappings (PGID, PUID)
- 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
- regular security updates
Find us at:
- Blog - all the things you can do with our containers including How-To guides, opinions and much more!
- Discord - realtime support / chat with the community and the team.
- Discourse - post on our community forum.
- Fleet - an online web interface which displays all of our maintained images.
- GitHub - view the source for all of our repositories.
- Open Collective - please consider helping us by either donating or contributing to our budget
Lazylibrarian is a program to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. This container is based on the DobyTang fork.
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 linuxserver/lazylibrarian 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 |
Here are some example snippets to help you get started creating a container.
docker create \
--name=lazylibrarian \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e DOCKER_MODS=linuxserver/calibre-web:calibre `#optional` \
-p 5299:5299 \
-v <path to data>:/config \
-v <path to downloads>:/downloads \
-v <path to data>:/books \
--restart unless-stopped \
linuxserver/lazylibrarian
Compatible with docker-compose v2 schemas.
---
version: "2"
services:
lazylibrarian:
image: linuxserver/lazylibrarian
container_name: lazylibrarian
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- DOCKER_MODS=linuxserver/calibre-web:calibre #optional
volumes:
- <path to data>:/config
- <path to downloads>:/downloads
- <path to data>:/books
ports:
- 5299:5299
restart: unless-stopped
Container 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.
| Parameter | Function |
|---|---|
-p 5299 |
The port for the LazyLibrarian webinterface |
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Europe/London |
Specify a timezone to use e.g. Europe/London |
-e DOCKER_MODS=linuxserver/calibre-web:calibre |
#optional & x86-64 only Adds the ability to enable the Calibredb import program |
-v /config |
LazyLibrarian config |
-v /downloads |
Download location |
-v /books |
Books location |
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.
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:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Access the webui at http://<your-ip>:5299/home, for more information check out Lazylibrarian.
x86-64 only We have implemented the optional ability to pull in the dependencies to enable the Calibredb import program:, this means if you don't require this feature the container isn't uneccessarily bloated but should you require it, it is easily available.
This optional layer will be rebuilt automatically on our CI pipeline upon new Calibre releases so you can stay up to date.
To use this option add the optional environmental variable as detailed above to pull an addition docker layer to enable ebook conversion and then in the LazyLibrarian config page (Processing:Calibredb import program:) set the path to converter tool to /usr/bin/calibredb
- Shell access whilst the container is running:
docker exec -it lazylibrarian /bin/bash - To monitor the logs of the container in realtime:
docker logs -f lazylibrarian - container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lazylibrarian
- image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/lazylibrarian
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
- Update the image:
docker pull linuxserver/lazylibrarian - Stop the running container:
docker stop lazylibrarian - Delete the container:
docker rm lazylibrarian - Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved) - Start the new container:
docker start lazylibrarian - You can also remove the old dangling images:
docker image prune
- Update all images:
docker-compose pull- or update a single image:
docker-compose pull lazylibrarian
- or update a single image:
- Let compose update all containers as necessary:
docker-compose up -d- or update a single container:
docker-compose up -d lazylibrarian
- or update a single container:
- You can also remove the old dangling images:
docker image prune
- Pull the latest image at its tag and replace it with the same env variables in one run:
docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock \ containrrr/watchtower \ --run-once lazylibrarian
Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
- You can also remove the old dangling images:
docker image prune
If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-lazylibrarian.git
cd docker-lazylibrarian
docker build \
--no-cache \
--pull \
-t linuxserver/lazylibrarian:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static:register --reset
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
- 23.10.19: - Add python module Pillow.
- 31.07.19: - Add pyopenssl, remove git dependency during build time.
- 09.07.19: - Rebase to Ubuntu Bionic, enables Calibre docker mod.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 05.03.19: - Added apprise python package.
- 22.02.19: - Rebasing to alpine 3.9.
- 10.12.18: - Moved to Pipeline Building
- 16.08.18: - Rebase to alpine 3.8
- 05.01.18: - Deprecate cpu_core routine lack of scaling
- 12.12.17: - Rebase to alpine 3.7
- 21.07.17: - Internal git pull instead of at runtime
- 25.05.17: - Rebase to alpine 3.6
- 07.02.17: - Rebase to alpine 3.5
- 30.01.17: - Compile libunrar.so to allow reading of .cbr format files
- 12.01.17: - Add ghostscript package, allows magazine covers to be created etc
- 14.10.16: - Add version layer information
- 03.10.16: - Fix non-persistent settings and make log folder
- 28.09.16: - Inital Release