2019-04-01 19:03:53 +00:00
# [linuxserver/lazylibrarian](https://github.com/linuxserver/docker-lazylibrarian)
2019-02-05 13:40:33 +00:00
2019-04-01 19:03:53 +00:00
[![ ](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square )](https://discord.gg/YWrKVTn)
[![ ](https://images.microbadger.com/badges/version/linuxserver/lazylibrarian.svg )](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own version badge on microbadger.com")
[![ ](https://images.microbadger.com/badges/image/linuxserver/lazylibrarian.svg )](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own version badge on microbadger.com")
![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/lazylibrarian.svg )
![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/lazylibrarian.svg )
[![Build Status ](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-lazylibrarian/master )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lazylibrarian/job/master/)
[![ ](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lazylibrarian/latest/badge.svg )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lazylibrarian/latest/index.html)
[Lazylibrarian ](https://github.com/DobyTang/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.
2019-02-05 13:40:33 +00:00
2019-02-12 00:30:36 +00:00
## Supported Architectures
2019-04-01 19:03:53 +00:00
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 ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-12 00:30:36 +00:00
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 |
2019-04-01 19:03:53 +00:00
| :----: | --- |
2019-02-12 00:30:36 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 20:20:22 +00:00
| armhf | arm32v7-latest |
2019-02-05 13:40:33 +00:00
2019-04-01 19:03:53 +00:00
2019-02-06 15:11:40 +00:00
## Usage
2019-02-05 13:40:33 +00:00
2019-02-12 00:30:36 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-04-01 19:03:53 +00:00
```
2019-02-05 13:40:33 +00:00
docker create \
--name=lazylibrarian \
2019-03-03 13:11:59 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-12 00:30:36 +00:00
-e TZ=Europe/London \
-p 5299:5299 \
2019-02-05 13:40:33 +00:00
-v < path to data > :/config \
2019-02-12 00:30:36 +00:00
-v < path to downloads > :/downloads \
2019-02-05 13:40:33 +00:00
-v < path to data > :/books \
2019-02-12 00:30:36 +00:00
--restart unless-stopped \
2019-02-05 13:40:33 +00:00
linuxserver/lazylibrarian
```
2019-04-01 19:03:53 +00:00
2019-02-12 00:30:36 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
lazylibrarian:
image: linuxserver/lazylibrarian
container_name: lazylibrarian
environment:
2019-03-03 13:11:59 +00:00
- PUID=1000
- PGID=1000
2019-02-12 00:30:36 +00:00
- TZ=Europe/London
volumes:
- < path to data > :/config
- < path to downloads > :/downloads
- < path to data > :/books
ports:
- 5299:5299
restart: unless-stopped
```
2019-02-06 15:11:40 +00:00
## Parameters
2019-04-01 19:03:53 +00:00
Docker 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.
2019-02-12 00:30:36 +00:00
2019-04-01 19:03:53 +00:00
### Ports (`-p`)
2019-02-12 00:30:36 +00:00
| Parameter | Function |
2019-04-01 19:03:53 +00:00
| :----: | --- |
2019-02-12 00:30:36 +00:00
| `5299` | The port for the LazyLibrarian webinterface |
2019-04-01 19:03:53 +00:00
### Environment Variables (`-e`)
2019-02-05 13:40:33 +00:00
2019-02-12 00:30:36 +00:00
| Env | Function |
2019-04-01 19:03:53 +00:00
| :----: | --- |
2019-03-03 13:11:59 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-12 00:30:36 +00:00
| `TZ=Europe/London` | Specify a timezone to use e.g. Europe/London |
2019-02-05 13:40:33 +00:00
2019-04-01 19:03:53 +00:00
### Volume Mappings (`-v`)
2019-02-05 13:40:33 +00:00
2019-02-12 00:30:36 +00:00
| Volume | Function |
2019-04-01 19:03:53 +00:00
| :----: | --- |
2019-02-12 00:30:36 +00:00
| `/config` | LazyLibrarian config |
| `/downloads` | Download location |
| `/books` | Books location |
2019-02-05 13:40:33 +00:00
2019-04-01 19:03:53 +00:00
2019-02-12 00:30:36 +00:00
## User / Group Identifiers
2019-04-01 19:03:53 +00:00
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` .
2019-02-12 00:30:36 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-03 13:11:59 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-05 13:40:33 +00:00
2019-04-01 19:03:53 +00:00
```
2019-02-12 00:30:36 +00:00
$ id username
2019-03-03 13:11:59 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-05 13:40:33 +00:00
```
2019-02-12 00:30:36 +00:00
## Application Setup
2019-02-05 13:40:33 +00:00
2019-02-12 00:30:36 +00:00
Access the webui at `http://<your-ip>:5299/home` , for more information check out [Lazylibrarian ](https://github.com/DobyTang/LazyLibrarian ).
2019-02-06 15:11:40 +00:00
2019-04-01 19:03:53 +00:00
2019-02-12 00:30:36 +00:00
## Support Info
2019-02-05 13:40:33 +00:00
2019-02-12 00:30:36 +00:00
* 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`
2019-02-05 13:40:33 +00:00
2019-02-06 15:11:40 +00:00
## Versions
2019-03-24 20:20:22 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-03-05 13:33:45 +00:00
* **05.03.19:** - Added apprise python package.
2019-02-24 16:31:43 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-12 00:30:36 +00:00
* **10.12.18:** - Moved to Pipeline Building
* **16.08.18:** - Rebase to alpine 3.8
2019-04-01 19:03:53 +00:00
* **05.01.18:** - Deprecate cpu_core routine lack of scaling
2019-02-12 00:30:36 +00:00
* **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