linuxserver/lazylibrarian repository overview

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.
• GitHub⁠ - view the source for all of our repositories.
• Open Collective⁠ - please consider helping us by either donating or contributing to our budget

⁠linuxserver/lazylibrarian⁠

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.

⁠Supported Architectures

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/lazylibrarian:latest 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:

⁠Application Setup

Access the webui at http://<your-ip>:5299/home, for more information check out Lazylibrarian⁠.

We have set /books as optional path, this is because it is the easiest way to get started.

⁠Calibredb import

64bit 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 unnecessarily 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 in the docker-mods section 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

⁠ffmpeg

By adding linuxserver/mods:lazylibrarian-ffmpeg to your DOCKER_MODS environment variable you can install ffmpeg into your container on startup. This allows you to use the audiobook conversion features of LazyLibrarian. You can enable it in the Web UI under Settings > Processing > External Programs by setting the ffmpeg path to ffmpeg.

⁠Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

⁠docker-compose (recommended, click here for more info⁠)

---
services:
  lazylibrarian:
    image: lscr.io/linuxserver/lazylibrarian:latest
    container_name: lazylibrarian
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - DOCKER_MODS=linuxserver/mods:universal-calibre|linuxserver/mods:lazylibrarian-ffmpeg #optional
    volumes:
      - /path/to/lazylibrarian/data:/config
      - /path/to/downloads/:/downloads
      - /path/to/data/:/books #optional
    ports:
      - 5299:5299
    restart: unless-stopped

⁠docker cli (click here for more info⁠)

docker run -d \
  --name=lazylibrarian \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e DOCKER_MODS=linuxserver/mods:universal-calibre|linuxserver/mods:lazylibrarian-ffmpeg `#optional` \
  -p 5299:5299 \
  -v /path/to/lazylibrarian/data:/config \
  -v /path/to/downloads/:/downloads \
  -v /path/to/data/:/books `#optional` \
  --restart unless-stopped \
  lscr.io/linuxserver/lazylibrarian:latest

⁠Parameters

Containers 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.

⁠Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

⁠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 lazylibrarian /bin/bash
  

  Copy

• To monitor the logs of the container in realtime:

  docker logs -f lazylibrarian
  

  Copy

• Container version number:

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

  Copy

• Image version number:

  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lazylibrarian:latest
  

  Copy

⁠Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), 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:

⁠Via Docker Compose

• Update images:

  • All images:

    docker-compose pull
    

    Copy

  • Single image:

    docker-compose pull lazylibrarian
    

    Copy

• Update containers:

  • All containers:

    docker-compose up -d
    

    Copy

  • Single container:

    docker-compose up -d lazylibrarian
    

    Copy

• You can also remove the old dangling images:

  docker image prune
  

  Copy

⁠Via Docker Run

• Update the image:

  docker pull lscr.io/linuxserver/lazylibrarian:latest
  

  Copy

• Stop the running container:

  docker stop lazylibrarian
  

  Copy

• Delete the container:

  docker rm lazylibrarian
  

  Copy

• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

• You can also remove the old dangling images:

  docker image prune
  

  Copy

⁠Image Update Notifications - Diun (Docker Image Update Notifier)

⁠Building locally

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 lscr.io/linuxserver/lazylibrarian:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

⁠Versions

• 14.08.24: - Rebase to Ubuntu Noble.
• 07.10.23: - Install unrar from linuxserver repo⁠. Switch to Python virtual environment. Add Levenshtein.
• 10.08.23: - Bump unrar to 6.2.10.
• 01.07.23: - Deprecate armhf. As announced here⁠
• 07.12.22: - Rebase to Ubuntu Jammy, migrate to s6v3. Use pyproject.toml for deps. Build unrar from source.
• 27.09.22: - Switch to Levenshtein, add cmake as build dep on armhf.
• 07.05.22: - Rebase to Ubuntu Focal.
• 22.05.21: - Make the paths clearer to the user, remove optional volume.
• 17.05.21: - Add linuxserver wheel index.
• 23.10.19: - Changed gitlab download link.
• 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