docker-documentation/images/docker-calibre.md

173 wiersze
8.3 KiB
Markdown
Czysty Zwykły widok Historia

2020-05-02 05:30:07 +00:00
# [linuxserver/calibre](https://github.com/linuxserver/docker-calibre)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-calibre.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-calibre)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-calibre.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-calibre/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-calibre/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-calibre/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/calibre)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/calibre.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/calibre "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/calibre.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/calibre)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/calibre.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/calibre)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-calibre/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-calibre/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/calibre/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/calibre/latest/index.html)
2019-05-20 17:23:21 +00:00
[Calibre](https://calibre-ebook.com/) is a powerful and easy to use e-book manager. Users say its outstanding and a must-have. Itll allow you to do nearly everything and it takes things a step beyond normal e-book software. Its also completely free and open source and great for both casual users and computer experts.
## Supported Architectures
2019-09-02 04:30:18 +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-05-20 17:23:21 +00:00
Simply pulling `linuxserver/calibre` 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 |
2020-05-02 05:30:07 +00:00
| :----: | --- |
2019-05-20 17:23:21 +00:00
| x86-64 | latest |
2020-05-02 05:30:07 +00:00
2019-05-20 17:23:21 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-05-02 05:30:07 +00:00
```
2019-05-20 17:23:21 +00:00
docker create \
--name=calibre \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e GUAC_USER=abc `#optional` \
-e GUAC_PASS=900150983cd24fb0d6963f7d28e17f72 `#optional` \
2020-03-18 22:06:55 +00:00
-e UMASK_SET=022 `#optional` \
2020-05-12 19:21:31 +00:00
-e CLI_ARGS= `#optional` \
2019-05-20 17:23:21 +00:00
-p 8080:8080 \
-p 8081:8081 \
2019-06-20 23:19:05 +00:00
-v /path/to/data:/config \
2019-05-20 17:23:21 +00:00
--restart unless-stopped \
linuxserver/calibre
```
2020-05-02 05:30:07 +00:00
2019-05-20 17:23:21 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-14 09:23:13 +00:00
version: "2.1"
2019-05-20 17:23:21 +00:00
services:
calibre:
image: linuxserver/calibre
container_name: calibre
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- GUAC_USER=abc #optional
- GUAC_PASS=900150983cd24fb0d6963f7d28e17f72 #optional
2020-03-18 22:06:55 +00:00
- UMASK_SET=022 #optional
2020-05-12 19:21:31 +00:00
- CLI_ARGS= #optional
2019-05-20 17:23:21 +00:00
volumes:
2019-06-20 23:19:05 +00:00
- /path/to/data:/config
2019-05-20 17:23:21 +00:00
ports:
- 8080:8080
- 8081:8081
restart: unless-stopped
```
## Parameters
2020-05-02 05:30:07 +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-05-20 17:23:21 +00:00
2020-05-02 05:30:07 +00:00
### Ports (`-p`)
2019-05-20 17:23:21 +00:00
| Parameter | Function |
2020-05-02 05:30:07 +00:00
| :----: | --- |
2019-05-20 17:23:21 +00:00
| `8080` | Calibre desktop gui. |
| `8081` | Calibre webserver gui. |
2020-05-02 05:30:07 +00:00
### Environment Variables (`-e`)
2019-05-20 17:23:21 +00:00
| Env | Function |
2020-05-02 05:30:07 +00:00
| :----: | --- |
2019-05-20 17:23:21 +00:00
| `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. |
| `GUAC_USER=abc` | Username for the calibre desktop gui. |
| `GUAC_PASS=900150983cd24fb0d6963f7d28e17f72` | Password's md5 hash for the calibre desktop gui. |
2020-03-18 22:06:55 +00:00
| `UMASK_SET=022` | for umask setting of Calibre, default if left unset is 022. |
2020-05-12 19:21:31 +00:00
| `CLI_ARGS=` | Optionally pass cli start arguments to calibre. |
2019-05-20 17:23:21 +00:00
2020-05-02 05:30:07 +00:00
### Volume Mappings (`-v`)
2019-05-20 17:23:21 +00:00
| Volume | Function |
2020-05-02 05:30:07 +00:00
| :----: | --- |
2019-05-20 17:23:21 +00:00
| `/config` | Where calibre should store its database and library. |
2020-05-02 05:30:07 +00:00
2019-05-20 17:23:21 +00:00
## User / Group Identifiers
2020-05-02 05:30:07 +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-05-20 17:23:21 +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.
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2020-05-02 05:30:07 +00:00
```
2019-05-20 17:23:21 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Application Setup
This image sets up the calibre desktop app and makes its interface available via Guacamole server in the browser. The interface is available at `http://your-ip:8080`.
2020-05-02 05:30:07 +00:00
By default, there is no username or password set. Custom usernames and passwords can be set via optional docker environment variables. Keep in mind that the `GUACPASS` variable accepts the `md5 hash` of the desired password (the sample above is the hash for `abc`). The md5 hash can be generated by either of the following commands:
2019-05-20 17:23:21 +00:00
2020-05-02 05:30:07 +00:00
```
2019-05-20 17:23:21 +00:00
echo -n password | openssl md5
```
2020-05-02 05:30:07 +00:00
```
2019-05-20 17:23:21 +00:00
printf '%s' password | md5sum
```
Port 8081 is reserved for Calibre's built-in webserver, which can be enabled within the desktop app settings, and the internal port must be set to `8081` although it will then be available at the host mapped port for external access.
2019-06-20 23:19:05 +00:00
You can access advanced features of the Guacamole remote desktop using `ctrl`+`alt`+`shift` enabling you to use remote copy/paste and different languages.
2020-05-02 05:30:07 +00:00
2020-04-14 09:23:13 +00:00
## Docker Mods
2020-05-02 05:30:07 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27calibre%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=calibre "view available mods for this container.")
2020-04-14 09:23:13 +00:00
2020-05-02 05:30:07 +00:00
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.
2020-04-14 09:23:13 +00:00
2019-10-01 09:23:24 +00:00
2019-05-20 17:23:21 +00:00
## Support Info
2019-09-02 04:30:18 +00:00
* Shell access whilst the container is running:
2019-05-20 17:23:21 +00:00
* `docker exec -it calibre /bin/bash`
2019-09-02 04:30:18 +00:00
* To monitor the logs of the container in realtime:
2019-05-20 17:23:21 +00:00
* `docker logs -f calibre`
2019-09-02 04:30:18 +00:00
* Container version number
2019-05-20 17:23:21 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' calibre`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/calibre`
## Versions
2020-05-12 19:21:31 +00:00
* **10.05.19:** - Add new env var `CLI_ARGS` to pass start arguments to calibre.
2020-03-18 22:06:55 +00:00
* **18.03.19:** - Let Calibre access environment variables, add optional umask setting.
2019-10-24 12:27:48 +00:00
* **23.10.19:** - Remove reccomended deps and zenity for character compatibility.
2019-10-18 23:36:48 +00:00
* **18.10.19:** - Add python-xdg.
2019-10-09 03:02:42 +00:00
* **08.10.19:** - Add fonts-wqy-microhei ttf-wqy-zenhei fcitx-rime dependency to resolve issue with Chinese encoding.
2019-10-04 16:27:08 +00:00
* **04.10.19:** - Add libxkbcommon-x11-0 dependency to resolve issue with Calibre 4.
2019-08-08 17:37:36 +00:00
* **08.08.19:** - Add zenity for international character support in dialog boxes.
2019-07-12 07:14:47 +00:00
* **12.07.19:** - Download binary from calibre website instead of github.
2019-05-20 17:23:21 +00:00
* **29.04.19:** - Initial release.