kopia lustrzana https://github.com/linuxserver/docker-documentation
197 wiersze
11 KiB
Markdown
197 wiersze
11 KiB
Markdown
---
|
||
title: calibre
|
||
---
|
||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||
<!-- Please read the https://github.com/linuxserver/docker-calibre/blob/master/.github/CONTRIBUTING.md -->
|
||
|
||
# [linuxserver/calibre](https://github.com/linuxserver/docker-calibre)
|
||
|
||
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fcalibre)
|
||
[](https://github.com/linuxserver/docker-calibre)
|
||
[](https://github.com/linuxserver/docker-calibre/releases)
|
||
[](https://github.com/linuxserver/docker-calibre/packages)
|
||
[](https://gitlab.com/linuxserver.io/docker-calibre/container_registry)
|
||
[](https://quay.io/repository/linuxserver.io/calibre)
|
||
[](https://hub.docker.com/r/linuxserver/calibre)
|
||
[](https://hub.docker.com/r/linuxserver/calibre)
|
||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-calibre/job/master/)
|
||
[](https://ci-tests.linuxserver.io/linuxserver/calibre/latest/index.html)
|
||
|
||
[Calibre](https://calibre-ebook.com/) is a powerful and easy to use e-book manager. Users say it’s outstanding and a must-have. It’ll allow you to do nearly everything and it takes things a step beyond normal e-book software. It’s also completely free and open source and great for both casual users and computer experts.
|
||
|
||
## Supported Architectures
|
||
|
||
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:latest` 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 | Available | Tag |
|
||
| :----: | :----: | ---- |
|
||
| x86-64 | ✅ | amd64-\<version tag\> |
|
||
| arm64 | ✅ | arm64v8-\<version tag\> |
|
||
| armhf| ✅ | arm32v7-\<version tag\> |
|
||
|
||
## Version Tags
|
||
|
||
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
|
||
|
||
| Tag | Available | Description |
|
||
| :----: | :----: |--- |
|
||
| latest | ✅ | Default Ubuntu based image |
|
||
| arch | ✅ | Arch based image supporting arm platforms |
|
||
|
||
## 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`.
|
||
|
||
By default, there is no password set for the main gui. Optional environment variable `PASSWORD` will allow setting a password for the user `abc`.
|
||
|
||
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.
|
||
|
||
You can access advanced features of the Guacamole remote desktop using `ctrl`+`alt`+`shift` enabling you to use remote copy/paste and different languages.
|
||
|
||
## 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:
|
||
image: lscr.io/linuxserver/calibre:latest
|
||
container_name: calibre
|
||
environment:
|
||
- PUID=1000
|
||
- PGID=1000
|
||
- TZ=Europe/London
|
||
- PASSWORD= #optional
|
||
- CLI_ARGS= #optional
|
||
volumes:
|
||
- /path/to/data:/config
|
||
ports:
|
||
- 8080:8080
|
||
- 8081:8081
|
||
restart: unless-stopped
|
||
```
|
||
|
||
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
||
|
||
```bash
|
||
docker run -d \
|
||
--name=calibre \
|
||
-e PUID=1000 \
|
||
-e PGID=1000 \
|
||
-e TZ=Europe/London \
|
||
-e PASSWORD= `#optional` \
|
||
-e CLI_ARGS= `#optional` \
|
||
-p 8080:8080 \
|
||
-p 8081:8081 \
|
||
-v /path/to/data:/config \
|
||
--restart unless-stopped \
|
||
lscr.io/linuxserver/calibre:latest
|
||
```
|
||
|
||
## 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 |
|
||
| :----: | --- |
|
||
| `8080` | Calibre desktop gui. |
|
||
| `8081` | Calibre webserver gui. |
|
||
|
||
### 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. |
|
||
| `PASSWORD=` | Optionally set a password for the gui. |
|
||
| `CLI_ARGS=` | Optionally pass cli start arguments to calibre. |
|
||
|
||
### Volume Mappings (`-v`)
|
||
|
||
| Volume | Function |
|
||
| :----: | --- |
|
||
| `/config` | Where calibre should store its database and library. |
|
||
|
||
#### 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 "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 /bin/bash`
|
||
* To monitor the logs of the container in realtime:
|
||
* `docker logs -f calibre`
|
||
* Container version number
|
||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' calibre`
|
||
* Image version number
|
||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/calibre:latest`
|
||
|
||
## Versions
|
||
|
||
* **31.03.22:** - Fix umask.
|
||
* **28.02.22:** - Add speech support to bionic image.
|
||
* **05.01.22:** - Add arch branch for arm platforms.
|
||
* **20.04.21:** - Fix the HOME folder.
|
||
* **19.04.21:** - Add libnss3 back in. Make sure Calibre can access environment variables.
|
||
* **18.04.21:** - Start calibre on container start rather than gui connect.
|
||
* **15.04.21:** - Rebase to rdesktop-web baseimage. Deprecate `GUAC_USER` and `GUAC_PASS` env vars. Existing users can set the new var `PASSWORD` for the user `abc`.
|
||
* **25.09.20:** - Switch to python3, add various new dependencies for calibre 5.0.
|
||
* **10.05.19:** - Add new env var `CLI_ARGS` to pass start arguments to calibre.
|
||
* **18.03.19:** - Let Calibre access environment variables, add optional umask setting.
|
||
* **23.10.19:** - Remove reccomended deps and zenity for character compatibility.
|
||
* **18.10.19:** - Add python-xdg.
|
||
* **08.10.19:** - Add fonts-wqy-microhei ttf-wqy-zenhei fcitx-rime dependency to resolve issue with Chinese encoding.
|
||
* **04.10.19:** - Add libxkbcommon-x11-0 dependency to resolve issue with Calibre 4.
|
||
* **08.08.19:** - Add zenity for international character support in dialog boxes.
|
||
* **12.07.19:** - Download binary from calibre website instead of github.
|
||
* **29.04.19:** - Initial release.
|