188 lines
8.5 KiB
Markdown
188 lines
8.5 KiB
Markdown
[](https://linuxserver.io)
|
|
|
|
The [LinuxServer.io](https://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:
|
|
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
|
|
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
|
|
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
|
|
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
|
|
|
|
# PSA: Changes are happening
|
|
|
|
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
|
|
|
|
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
|
|
|
|
# [linuxserver/calibre-web](https://github.com/linuxserver/docker-calibre-web)
|
|
[](https://discord.gg/YWrKVTn)
|
|
[](https://microbadger.com/images/linuxserver/calibre-web "Get your own version badge on microbadger.com")
|
|
[](https://microbadger.com/images/linuxserver/calibre-web "Get your own version badge on microbadger.com")
|
|
|
|
|
|
[](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.
|
|
|
|
This software is a fork of library and licensed under the GPL v3 License.
|
|
|
|
|
|
[](https://github.com/janeczku/calibre-web)
|
|
|
|
## 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).
|
|
|
|
Simply pulling `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 | arm32v6-latest |
|
|
|
|
|
|
## Usage
|
|
|
|
Here are some example snippets to help you get started creating a container.
|
|
|
|
### docker
|
|
|
|
```
|
|
docker create \
|
|
--name=calibre-web \
|
|
-e PUID=1001 \
|
|
-e PGID=1001 \
|
|
-e TZ=Europe/London \
|
|
-p 8083:8083 \
|
|
-v <path to data>:/config \
|
|
-v <path to calibre library>:/books \
|
|
--restart unless-stopped \
|
|
linuxserver/calibre-web
|
|
```
|
|
|
|
|
|
### docker-compose
|
|
|
|
Compatible with docker-compose v2 schemas.
|
|
|
|
```
|
|
---
|
|
version: "2"
|
|
services:
|
|
calibre-web:
|
|
image: linuxserver/calibre-web
|
|
container_name: calibre-web
|
|
environment:
|
|
- PUID=1001
|
|
- PGID=1001
|
|
- TZ=Europe/London
|
|
volumes:
|
|
- <path to data>:/config
|
|
- <path to calibre library>:/books
|
|
ports:
|
|
- 8083:8083
|
|
mem_limit: 4096m
|
|
restart: unless-stopped
|
|
```
|
|
|
|
## Parameters
|
|
|
|
Container 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.
|
|
|
|
| Parameter | Function |
|
|
| :----: | --- |
|
|
| `-p 8083` | WebUI |
|
|
| `-e PUID=1001` | for UserID - see below for explanation |
|
|
| `-e PGID=1001` | for GroupID - see below for explanation |
|
|
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
|
| `-v /config` | Where calibre-web stores the internal database and config. |
|
|
| `-v /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`.
|
|
|
|
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=1001` and `PGID=1001`, to find yours use `id user` as below:
|
|
|
|
```
|
|
$ id username
|
|
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
|
```
|
|
|
|
|
|
|
|
## 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
|
|
|
|
To reverse proxy with our Letsencrypt docker container 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;
|
|
}
|
|
```
|
|
|
|
|
|
|
|
## 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" }}' linuxserver/calibre-web`
|
|
|
|
## 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 (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
|
|
|
|
Below are the instructions for updating containers:
|
|
|
|
### Via Docker Run/Create
|
|
* Update the image: `docker pull linuxserver/calibre-web`
|
|
* Stop the running container: `docker stop calibre-web`
|
|
* Delete the container: `docker rm calibre-web`
|
|
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
|
* Start the new container: `docker start calibre-web`
|
|
* You can also remove the old dangling images: `docker image prune`
|
|
|
|
### Via Docker Compose
|
|
* Update the image: `docker-compose pull linuxserver/calibre-web`
|
|
* Let compose update containers as necessary: `docker-compose up -d`
|
|
* You can also remove the old dangling images: `docker image prune`
|
|
|
|
## Versions
|
|
|
|
* **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.
|