kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Templated Files
LinuxServer-CI
rodzic
c5d54e2ce9
commit
e25fd7e835
|
|
@ -1,8 +1,15 @@
|
|||
# linuxserver/lazylibrarian
|
||||
# [linuxserver/lazylibrarian](https://github.com/linuxserver/docker-lazylibrarian)
|
||||
|
||||
[](https://github.com/linuxserver/docker-lazylibrarian/releases) [](https://microbadger.com/images/linuxserver/lazylibrarian) [](https://microbadger.com/images/linuxserver/lazylibrarian) [](https://hub.docker.com/r/linuxserver/lazylibrarian) [](https://hub.docker.com/r/linuxserver/lazylibrarian) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lazylibrarian/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lazylibrarian/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-lazylibrarian/releases)
|
||||
[](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/lazylibrarian)
|
||||
[](https://hub.docker.com/r/linuxserver/lazylibrarian)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lazylibrarian/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lazylibrarian/latest/index.html)
|
||||
|
||||
[Lazylibrarian](https://lazylibrarian.gitlab.io/) 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.
|
||||
|
||||
[Lazylibrarian](https://lazylibrarian.gitlab.io/) 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
|
||||
|
||||
|
|
@ -13,18 +20,19 @@ Simply pulling `linuxserver/lazylibrarian` should retrieve the correct image for
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=lazylibrarian \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -39,6 +47,7 @@ docker create \
|
|||
linuxserver/lazylibrarian
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -66,40 +75,43 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `5299` | The port for the LazyLibrarian webinterface |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use e.g. Europe/London |
|
||||
| `DOCKER_MODS=linuxserver/calibre-web:calibre` | \#optional & **x86-64 only** Adds the ability to enable the Calibredb import program |
|
||||
| `DOCKER_MODS=linuxserver/calibre-web:calibre` | #optional & **x86-64 only** Adds the ability to enable the Calibredb import program |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | LazyLibrarian config |
|
||||
| `/downloads` | Download location |
|
||||
| `/books` | Books location |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -108,7 +120,11 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
Access the webui at `http://<your-ip>:5299/home`, for more information check out [Lazylibrarian](https://lazylibrarian.gitlab.io/).
|
||||
|
||||
**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`
|
||||
**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`
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -131,7 +147,7 @@ Access the webui at `http://<your-ip>:5299/home`, for more information check out
|
|||
* **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
|
||||
* **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
|
||||
|
|
@ -141,4 +157,3 @@ Access the webui at `http://<your-ip>:5299/home`, for more information check out
|
|||
* **14.10.16:** - Add version layer information
|
||||
* **03.10.16:** - Fix non-persistent settings and make log folder
|
||||
* **28.09.16:** - Inital Release
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue