-
-
Notifications
You must be signed in to change notification settings - Fork 64
/
readme-vars.yml
128 lines (107 loc) · 9.03 KB
/
readme-vars.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
---
# project information
project_name: calibre
project_url: "https://calibre-ebook.com/"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/calibre-logo.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) 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."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_blurb_optional_extras_enabled: false
# supported architectures
available_architectures:
- { arch: "{{ arch_x86_64 }}", tag: "amd64-<version tag>"}
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-<version tag>"}
# development version
development_versions: true
development_versions_items:
- { tag: "latest", desc: "Latest Calibre releases" }
- { tag: "v4", desc: "Calibre v4 releases (x86_64 only)" }
# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Where calibre should store its database and library." }
param_usage_include_ports: true
param_ports:
- { external_port: "8080", internal_port: "8080", port_desc: "Calibre desktop gui." }
- { external_port: "8181", internal_port: "8181", port_desc: "Calibre desktop gui HTTPS." }
- { external_port: "8081", internal_port: "8081", port_desc: "Calibre webserver gui." }
# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
- { env_var: "PASSWORD", env_value: "", desc: "Optionally set a password for the gui." }
- { env_var: "CLI_ARGS", env_value: "", desc: "Optionally pass cli start arguments to calibre."}
opt_security_opt_param: true
opt_security_opt_param_vars:
- { run_var: "seccomp=unconfined", compose_var: "seccomp:unconfined", desc: "For Docker Engine only, many modern gui apps need this to function as syscalls are unkown to Docker." }
# application setup block
app_setup_block_enabled: true
app_setup_block: |
This image sets up the calibre desktop app and makes its interface available via KasmVNC server in the browser. The interface is available at `http://your-ip:8080` or `https://your-ip:8181`.
By default, there is no password set for the main gui. Optional environment variable `PASSWORD` will allow setting a password for the user `abc`, via http auth.
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.
### Options in all KasmVNC based GUI containers
This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxserver/docker-baseimage-kasmvnc) which means there are additional environment variables and run configurations to enable or disable specific functionality.
#### Optional environment variables
| Variable | Description |
| :----: | --- |
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 8080. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 8181. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for [DRI3 GPU Acceleration](https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html) allows you to specify the device to use IE `/dev/dri/renderD128` |
| LC_ALL | Set the Language for the container to run as IE `fr_FR.UTF-8` `ar_AE.UTF-8` |
| NO_DECOR | If set the application will run without window borders for use as a PWA. |
| NO_FULL | Do not autmatically fullscreen applications when using openbox. |
#### Optional run configurations
| Variable | Description |
| :----: | --- |
| `--privileged` | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE `-v /home/user/docker-data:/var/lib/docker`. |
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated appplications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
### Language Support - Internationalization
The environment variable `LC_ALL` can be used to start this image in a different language than English simply pass for example to launch the Desktop session in French `LC_ALL=fr_FR.UTF-8`. Some languages like Chinese, Japanese, or Korean will be missing fonts needed to render properly known as cjk fonts, but others may exist and not be installed. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup.
To install cjk fonts on startup as an example pass the environment variables:
```
-e DOCKER_MODS=linuxserver/mods:universal-package-install
-e INSTALL_PACKAGES=fonts-noto-cjk
-e LC_ALL=zh_CN.UTF-8
```
The web interface has the option for "IME Input Mode" in Settings which will allow non english characters to be used from a non en_US keyboard on the client. Once enabled it will perform the same as a local Linux installation set to your locale.
### Lossless mode
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information [here](https://www.kasmweb.com/docs/latest/how_to/lossless.html#technical-background). In order to use this mode from a non localhost endpoint the HTTPS port on 8181 needs to be used. If using a reverse proxy to port 8080 specific headers will need to be set as outlined [here](https://github.com/linuxserver/docker-baseimage-kasmvnc#lossless).
# changelog
changelogs:
- { date: "19.08.24:", desc: "Rebase to noble." }
- { date: "10.02.24:", desc: "Update Readme with new env vars and ingest proper PWA icon." }
- { date: "31.01.24:", desc: "Fix fullscreen on start." }
- { date: "17.11.23:", desc: "Install libxcb-cursor0 for v7 support." }
- { date: "18.03.23:", desc: "Rebase to KasmVNC base image." }
- { date: "19.10.22:", desc: "Set the window title to `Calibre`. Remove websocat as it is now handled properly in the baseimage." }
- { date: "18.10.22:", desc: "Deprecate Arch branch." }
- { date: "07.10.22:", desc: "Start calibre window maximized." }
- { date: "16.09.22:", desc: "Rebase to jammy." }
- { date: "24.07.22:", desc: "Add arm64 build for master branch." }
- { date: "11.07.22:", desc: "Update dependencies for Calibre 6." }
- { date: "28.05.22:", desc: "Rebase to focal." }
- { date: "31.03.22:", desc: "Fix umask." }
- { date: "28.02.22:", desc: "Add speech support to bionic image." }
- { date: "05.01.22:", desc: "Add arch branch for arm platforms." }
- { date: "20.04.21:", desc: "Fix the HOME folder." }
- { date: "19.04.21:", desc: "Add libnss3 back in. Make sure Calibre can access environment variables." }
- { date: "18.04.21:", desc: "Start calibre on container start rather than gui connect." }
- { date: "15.04.21:", desc: "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`." }
- { date: "25.09.20:", desc: "Switch to python3, add various new dependencies for calibre 5.0." }
- { date: "10.05.19:", desc: "Add new env var `CLI_ARGS` to pass start arguments to calibre." }
- { date: "18.03.19:", desc: "Let Calibre access environment variables, add optional umask setting." }
- { date: "23.10.19:", desc: "Remove reccomended deps and zenity for character compatibility." }
- { date: "18.10.19:", desc: "Add python-xdg." }
- { date: "08.10.19:", desc: "Add fonts-wqy-microhei ttf-wqy-zenhei fcitx-rime dependency to resolve issue with Chinese encoding." }
- { date: "04.10.19:", desc: "Add libxkbcommon-x11-0 dependency to resolve issue with Calibre 4." }
- { date: "08.08.19:", desc: "Add zenity for international character support in dialog boxes." }
- { date: "12.07.19:", desc: "Download binary from calibre website instead of github." }
- { date: "29.04.19:", desc: "Initial release." }