kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
d7f9280e5c
commit
6c0ea841c2
|
|
@ -1,11 +1,21 @@
|
|||
# linuxserver/calibre-web
|
||||
# [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://microbadger.com/images/linuxserver/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://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/calibre-web/latest/index.html)
|
||||
[](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://microbadger.com/images/linuxserver/calibre-web "Get your own version badge on microbadger.com")
|
||||
[](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://lsio-ci.ams3.digitaloceanspaces.com/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.
|
||||
[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/).
|
||||
|
|
@ -15,18 +25,19 @@ Simply pulling `linuxserver/calibre-web` should retrieve the correct image for y
|
|||
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=calibre-web \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -40,6 +51,7 @@ docker create \
|
|||
linuxserver/calibre-web
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -66,39 +78,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 |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `8083` | WebUI |
|
||||
|
||||
### 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 EG Europe/London. |
|
||||
| `DOCKER_MODS=linuxserver/calibre-web:calibre` | \#optional & **x86-64 only** Adds the ability to perform ebook conversion |
|
||||
| `DOCKER_MODS=linuxserver/calibre-web:calibre` | #optional & **x86-64 only** Adds the ability to perform ebook conversion |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Where calibre-web stores the internal database and config. |
|
||||
| `/books` | Where your calibre database is locate. |
|
||||
|
||||
|
||||
|
||||
|
||||
## 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)
|
||||
```
|
||||
|
|
@ -109,15 +125,19 @@ 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
|
||||
**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`
|
||||
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 converter tool to `/usr/bin/ebook-convert`
|
||||
|
||||
**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 converter tool to `/usr/bin/ebook-convert`
|
||||
|
||||
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:
|
||||
|
||||
```text
|
||||
```
|
||||
location /calibre-web {
|
||||
proxy_pass http://<your-ip>:8083;
|
||||
proxy_set_header Host $http_host;
|
||||
|
|
@ -127,11 +147,12 @@ To reverse proxy with our Letsencrypt docker container we include a preconfigure
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=calibre-web "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=calibre-web)
|
||||
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) can be accessed via the dynamic badge above.
|
||||
|
||||
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\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -157,9 +178,8 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **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.
|
||||
* **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.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue