kopia lustrzana https://github.com/linuxserver/docker-documentation
227 wiersze
12 KiB
Markdown
227 wiersze
12 KiB
Markdown
---
|
|
title: calibre-web
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read the https://github.com/linuxserver/docker-calibre-web/blob/master/.github/CONTRIBUTING.md -->
|
|
|
|
# [linuxserver/calibre-web](https://github.com/linuxserver/docker-calibre-web)
|
|
|
|
[](https://github.com/linuxserver/docker-calibre-web)
|
|
[](https://github.com/linuxserver/docker-calibre-web/releases)
|
|
[](https://github.com/linuxserver/docker-calibre-web/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-calibre-web/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/calibre-web)
|
|
[](https://hub.docker.com/r/linuxserver/calibre-web)
|
|
[](https://hub.docker.com/r/linuxserver/calibre-web)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-calibre-web/job/master/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/calibre-web/latest/index.html)
|
|
|
|
[Calibre-web](https://github.com/janeczku/calibre-web) is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. It is also possible to integrate google drive and edit metadata and your calibre library through the app itself.
|
|
|
|
This software is a fork of library and licensed under the GPL v3 License.
|
|
|
|
## Supported Architectures
|
|
|
|
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/).
|
|
|
|
Simply pulling `lscr.io/linuxserver/calibre-web` 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 |
|
|
|
|
## Version Tags
|
|
|
|
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
|
|
|
|
| Tag | Description |
|
|
| :----: | --- |
|
|
| latest | Releases of Calibre-Web |
|
|
| nightly | Commits to the master branch of Calibre-Web |
|
|
|
|
## Application Setup
|
|
|
|
Webui can be found at `http://your-ip:8083`
|
|
|
|
On the initial setup screen, enter `/books` as your calibre library location.
|
|
|
|
**Default admin login:**
|
|
*Username:* admin
|
|
*Password:* admin123
|
|
|
|
Unrar is included by default and needs to be set in the Calibre-Web admin page (Basic Configuration:External Binaries) with a path of `/usr/bin/unrar`
|
|
|
|
**x86-64 only** We have implemented the optional ability to pull in the dependencies to enable ebook conversion utilising Calibre, 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 Calibre-Web admin page (Basic Configuration:External Binaries) set the **Path to Calibre E-Book Converter** to `/usr/bin/ebook-convert`
|
|
|
|
This image contains the [kepubify](https://pgaskin.net/kepubify/) ebook conversion tool (MIT License) to convert epub to kepub. In the Calibre-Web admin page (Basic Configuration:External Binaries) set the **Path to Kepubify E-Book Converter** to `/usr/bin/kepubify`
|
|
|
|
To reverse proxy with our Letsencrypt docker container we include a preconfigured reverse proxy config, for other instances of Nginx use the following location block:
|
|
```
|
|
location /calibre-web {
|
|
proxy_pass http://<your-ip>:8083;
|
|
proxy_set_header Host $http_host;
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
proxy_set_header X-Scheme $scheme;
|
|
proxy_set_header X-Script-Name /calibre-web;
|
|
}
|
|
```
|
|
|
|
## 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](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
calibre-web:
|
|
image: lscr.io/linuxserver/calibre-web
|
|
container_name: calibre-web
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=Europe/London
|
|
- DOCKER_MODS=linuxserver/calibre-web:calibre #optional
|
|
- OAUTHLIB_RELAX_TOKEN_SCOPE=1 #optional
|
|
volumes:
|
|
- /path/to/data:/config
|
|
- /path/to/calibre/library:/books
|
|
ports:
|
|
- 8083:8083
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=calibre-web \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=Europe/London \
|
|
-e DOCKER_MODS=linuxserver/calibre-web:calibre `#optional` \
|
|
-e OAUTHLIB_RELAX_TOKEN_SCOPE=1 `#optional` \
|
|
-p 8083:8083 \
|
|
-v /path/to/data:/config \
|
|
-v /path/to/calibre/library:/books \
|
|
--restart unless-stopped \
|
|
lscr.io/linuxserver/calibre-web
|
|
```
|
|
|
|
## 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.
|
|
|
|
### Ports (`-p`)
|
|
|
|
| Parameter | Function |
|
|
| :----: | --- |
|
|
| `8083` | WebUI |
|
|
|
|
### 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 EG Europe/London. |
|
|
| `DOCKER_MODS=linuxserver/calibre-web:calibre` | #optional & **x86-64 only** Adds the ability to perform ebook conversion |
|
|
| `OAUTHLIB_RELAX_TOKEN_SCOPE=1` | Optionally set this to allow Google OAUTH to work |
|
|
|
|
### Volume Mappings (`-v`)
|
|
|
|
| Volume | Function |
|
|
| :----: | --- |
|
|
| `/config` | Where calibre-web stores the internal database and config. |
|
|
| `/books` | Where your preexisting calibre database is located. |
|
|
|
|
#### Miscellaneous Options
|
|
|
|
| Parameter | Function |
|
|
| :-----: | --- |
|
|
|
|
## Environment variables from files (Docker secrets)
|
|
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
|
|
|
As an example:
|
|
|
|
```bash
|
|
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
|
```
|
|
|
|
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` 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](https://en.wikipedia.org/wiki/Umask) 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 user` as below:
|
|
|
|
```bash
|
|
$ id username
|
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
|
```
|
|
|
|
## Docker Mods
|
|
|
|
[](https://mods.linuxserver.io/?mod=calibre-web "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
We publish various [Docker Mods](https://github.com/linuxserver/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 calibre-web /bin/bash`
|
|
* To monitor the logs of the container in realtime:
|
|
* `docker logs -f calibre-web`
|
|
* Container version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' calibre-web`
|
|
* Image version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/calibre-web`
|
|
|
|
## Versions
|
|
|
|
* **04.11.21:** - Update pip arguments to ignore distro installed packages.
|
|
* **24.06.21:** - Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support.
|
|
* **17.05.21:** - Add linuxserver wheel index.
|
|
* **10.02.21:** - Add libxrandr2
|
|
* **25.01.21:** - Add nightly tag
|
|
* **19.01.21:** - Add python3-pkg-resources
|
|
* **13.01.21:** - Rebase to Ubuntu Focal, see [here](https://docs.linuxserver.io/faq#my-host-is-incompatible-with-images-based-on-ubuntu-focal) for troubleshooting armhf.
|
|
* **12.10.20:** - Add libxi6
|
|
* **12.07.20:** - Add kepubify for arm64v8
|
|
* **05.06.20:** - Add kepubify for x86-64 and arm32v7
|
|
* **06.05.20:** - Add libxslt1.1 and update ImageMagick policy
|
|
* **19.01.20:** - Adding LDAP libs.
|
|
* **13.10.19:** - Migrate to Python3.
|
|
* **01.08.19:** - Add libxcomposite1.
|
|
* **13.06.19:** - Add docker mod to enable optional ebook conversion on x86-64. Add unrar.
|
|
* **02.06.19:** - Rebase to Ubuntu Bionic & add Gdrive support.
|
|
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
|
|
* **23.02.19:** - Rebase to alpine 3.9, use repo version of imagemagick.
|
|
* **11.02.19:** - Add pipeline logic and multi arch.
|
|
* **03.01.19:** - Remove guest user from default app.db.
|
|
* **16.08.18:** - Rebase to alpine 3.8.
|
|
* **03.07.18:** - New build pushed, all versions below `67` have [vulnerability](https://github.com/janeczku/calibre-web/issues/534).
|
|
* **05.01.18:** - Deprecate cpu_core routine lack of scaling.
|
|
* **06.12.17:** - Rebase to alpine 3.7.
|
|
* **27.11.17:** - Use cpu core counting routine to speed up build time.
|
|
* **24.07.17:** - Curl version for imagemagick.
|
|
* **17.07.17:** - Initial release.
|