kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
ef7d701aad
commit
c726f85d96
|
|
@ -1,6 +1,14 @@
|
||||||
# linuxserver/calibre
|
# [linuxserver/calibre](https://github.com/linuxserver/docker-calibre)
|
||||||
|
|
||||||
[](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://microbadger.com/images/linuxserver/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://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/calibre/latest/index.html)
|
[](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://microbadger.com/images/linuxserver/calibre "Get your own version badge on microbadger.com")
|
||||||
|
[](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://lsio-ci.ams3.digitaloceanspaces.com/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.
|
[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.
|
||||||
|
|
||||||
|
|
@ -13,16 +21,17 @@ Simply pulling `linuxserver/calibre` should retrieve the correct image for your
|
||||||
The architectures supported by this image are:
|
The architectures supported by this image are:
|
||||||
|
|
||||||
| Architecture | Tag |
|
| Architecture | Tag |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| x86-64 | latest |
|
| x86-64 | latest |
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Here are some example snippets to help you get started creating a container from this image.
|
Here are some example snippets to help you get started creating a container from this image.
|
||||||
|
|
||||||
### docker
|
### docker
|
||||||
|
|
||||||
```text
|
```
|
||||||
docker create \
|
docker create \
|
||||||
--name=calibre \
|
--name=calibre \
|
||||||
-e PUID=1000 \
|
-e PUID=1000 \
|
||||||
|
|
@ -39,6 +48,7 @@ docker create \
|
||||||
linuxserver/calibre
|
linuxserver/calibre
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### docker-compose
|
### docker-compose
|
||||||
|
|
||||||
Compatible with docker-compose v2 schemas.
|
Compatible with docker-compose v2 schemas.
|
||||||
|
|
@ -68,19 +78,20 @@ services:
|
||||||
|
|
||||||
## Parameters
|
## 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 |
|
| Parameter | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `8080` | Calibre desktop gui. |
|
| `8080` | Calibre desktop gui. |
|
||||||
| `8081` | Calibre webserver gui. |
|
| `8081` | Calibre webserver gui. |
|
||||||
|
|
||||||
### Environment Variables \(`-e`\)
|
|
||||||
|
### Environment Variables (`-e`)
|
||||||
|
|
||||||
| Env | Function |
|
| Env | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `PUID=1000` | for UserID - see below for explanation |
|
| `PUID=1000` | for UserID - see below for explanation |
|
||||||
| `PGID=1000` | for GroupID - see below for explanation |
|
| `PGID=1000` | for GroupID - see below for explanation |
|
||||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||||
|
|
@ -89,19 +100,21 @@ Docker images are configured using parameters passed at runtime \(such as those
|
||||||
| `UMASK_SET=022` | for umask setting of Calibre, default if left unset is 022. |
|
| `UMASK_SET=022` | for umask setting of Calibre, default if left unset is 022. |
|
||||||
| `CLI_ARGS=` | Optionally pass cli start arguments to calibre. |
|
| `CLI_ARGS=` | Optionally pass cli start arguments to calibre. |
|
||||||
|
|
||||||
### Volume Mappings \(`-v`\)
|
### Volume Mappings (`-v`)
|
||||||
|
|
||||||
| Volume | Function |
|
| Volume | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `/config` | Where calibre should store its database and library. |
|
| `/config` | Where calibre should store its database and library. |
|
||||||
|
|
||||||
## Environment variables from files \(Docker secrets\)
|
|
||||||
|
|
||||||
|
## Environment variables from files (Docker secrets)
|
||||||
|
|
||||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||||
|
|
||||||
As an example:
|
As an example:
|
||||||
|
|
||||||
```text
|
```
|
||||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -109,17 +122,19 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
||||||
|
|
||||||
## Umask for running applications
|
## 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.
|
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
|
## 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.
|
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:
|
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||||
|
|
||||||
```text
|
```
|
||||||
$ id username
|
$ id username
|
||||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||||
```
|
```
|
||||||
|
|
@ -128,13 +143,13 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
||||||
|
|
||||||
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`.
|
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 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:
|
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:
|
||||||
|
|
||||||
```text
|
```
|
||||||
echo -n password | openssl md5
|
echo -n password | openssl md5
|
||||||
```
|
```
|
||||||
|
|
||||||
```text
|
```
|
||||||
printf '%s' password | md5sum
|
printf '%s' password | md5sum
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -142,11 +157,12 @@ Port 8081 is reserved for Calibre's built-in webserver, which can be enabled wit
|
||||||
|
|
||||||
You can access advanced features of the Guacamole remote desktop using `ctrl`+`alt`+`shift` enabling you to use remote copy/paste and different languages.
|
You can access advanced features of the Guacamole remote desktop using `ctrl`+`alt`+`shift` enabling you to use remote copy/paste and different languages.
|
||||||
|
|
||||||
|
|
||||||
## Docker Mods
|
## Docker Mods
|
||||||
|
[](https://mods.linuxserver.io/?mod=calibre "view available mods for this container.")
|
||||||
|
|
||||||
[](https://mods.linuxserver.io/?mod=calibre)
|
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
|
## Support Info
|
||||||
|
|
||||||
|
|
@ -170,4 +186,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||||
* **08.08.19:** - Add zenity for international character support in dialog boxes.
|
* **08.08.19:** - Add zenity for international character support in dialog boxes.
|
||||||
* **12.07.19:** - Download binary from calibre website instead of github.
|
* **12.07.19:** - Download binary from calibre website instead of github.
|
||||||
* **29.04.19:** - Initial release.
|
* **29.04.19:** - Initial release.
|
||||||
|
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue