Skip to content

Commit b1d1002

Browse files
Bot Updating Templated Files
1 parent 4ec313d commit b1d1002

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ On the initial setup screen, enter `/books` as your calibre library location.
7878
*Username:* admin
7979
*Password:* admin123
8080

81-
If you lock yourself out or forget a password, you will need to specify the app.db similar to this:
81+
If you lock yourself out or forget a password, you will need to specify the app.db similar to this:
8282
`docker exec -it calibre-web python3 /app/calibre-web/cps.py -p /config/app.db -s <user>:<pass>`
8383
If you fail to specify the proper db, it will appear to succeed, but it will not work.
8484

8585
Unrar is included by default and needs to be set in the Calibre-Web admin page (Basic Configuration:External Binaries) with a path of `/usr/bin/unrar`
8686

87-
**x86-64 only** We have implemented the optional ability to pull in the dependencies to enable ebook conversion utilising Calibre, this means if you don't require this feature the container isn't uneccessarily bloated but should you require it, it is easily available.
87+
**64bit only** We have implemented the optional ability to pull in the dependencies to enable ebook conversion utilising Calibre, this means if you don't require this feature the container isn't uneccessarily bloated but should you require it, it is easily available.
8888
This optional layer will be rebuilt automatically on our CI pipeline upon new Calibre releases so you can stay up to date.
89-
To use this option add the optional environmental variable as detailed above to pull an addition docker layer to enable ebook conversion and then in the Calibre-Web admin page (Basic Configuration:External Binaries) set the **Path to Calibre E-Book Converter** to `/usr/bin/ebook-convert` on versions 0.6.21 and lower. For 0.6.22 and higher, set the directory, `/usr/bin/` only.
89+
To use this option add the optional environmental variable as shown in the docker-mods section to pull an addition docker layer to enable ebook conversion and then in the Calibre-Web admin page (Basic Configuration:External Binaries) set the **Path to Calibre E-Book Converter** to `/usr/bin/ebook-convert` on versions 0.6.21 and lower. For 0.6.22 and higher, set the directory, `/usr/bin/` only.
9090

9191
This image contains the [kepubify](https://pgaskin.net/kepubify/) ebook conversion tool (MIT License) to convert epub to kepub. In the Calibre-Web admin page (Basic Configuration:External Binaries) set the **Path to Kepubify E-Book Converter** to `/usr/bin/kepubify`
9292

@@ -109,9 +109,10 @@ services:
109109
- PUID=1000
110110
- PGID=1000
111111
- TZ=Etc/UTC
112-
- DOCKER_MODS=linuxserver/mods:universal-calibre
112+
- DOCKER_MODS=linuxserver/mods:universal-calibre #optional
113+
- OAUTHLIB_RELAX_TOKEN_SCOPE=1 #optional
113114
volumes:
114-
- /path/to/data:/config
115+
- /path/to/calibre-web/data:/config
115116
- /path/to/calibre/library:/books
116117
ports:
117118
- 8083:8083
@@ -126,9 +127,10 @@ docker run -d \
126127
-e PUID=1000 \
127128
-e PGID=1000 \
128129
-e TZ=Etc/UTC \
129-
-e DOCKER_MODS=linuxserver/mods:universal-calibre \
130+
-e DOCKER_MODS=linuxserver/mods:universal-calibre `#optional` \
131+
-e OAUTHLIB_RELAX_TOKEN_SCOPE=1 `#optional` \
130132
-p 8083:8083 \
131-
-v /path/to/data:/config \
133+
-v /path/to/calibre-web/data:/config \
132134
-v /path/to/calibre/library:/books \
133135
--restart unless-stopped \
134136
lscr.io/linuxserver/calibre-web:nightly
@@ -145,8 +147,9 @@ Containers are configured using parameters passed at runtime (such as those abov
145147
| `-e PGID=1000` | for GroupID - see below for explanation |
146148
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
147149
| `-e DOCKER_MODS=linuxserver/mods:universal-calibre` | #optional & **x86-64 only** Adds the ability to perform ebook conversion |
150+
| `-e OAUTHLIB_RELAX_TOKEN_SCOPE=1` | Optionally set this to allow Google OAUTH to work |
148151
| `-v /config` | Where calibre-web stores the internal database and config. |
149-
| `-v /books` | Where your preexisting calibre database is locate. |
152+
| `-v /books` | Where your preexisting calibre database is located. |
150153

151154
## Environment variables from files (Docker secrets)
152155

@@ -315,11 +318,13 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
315318
* **17.10.23:** - Remove some packages that are required by the calibre mod but not the base container.
316319
* **07.10.23:** - Install unrar from [linuxserver repo](https://github.com/linuxserver/docker-unrar). Switch to Python virtual environment.
317320
* **13.04.23:** - Deprecate armhf.
318-
* **29.01.23:** - Add cmake as build dep for Levenshtein.
321+
* **27.03.23:** - Add cmake as build dep for Levenshtein.
319322
* **27.12.22:** - Add ghostscript, libxtst6, libxkbfile-dev.
320323
* **20.12.22:** - Improve init script and prevent harmless error.
321-
* **22.10.22:** - Rebase to jammy. Upgrade to s6v3. Clean up build dependencies.
322-
* **04.11.21:** - Fix pip arguments
324+
* **19.10.22:** - Rebase to jammy. Upgrade to s6v3. Clean up build dependencies.
325+
* **04.11.21:** - Update pip arguments to ignore distro installed packages.
326+
* **24.06.21:** - Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support.
327+
* **17.05.21:** - Add linuxserver wheel index.
323328
* **10.02.21:** - Add libxrandr2
324329
* **25.01.21:** - Add nightly tag
325330
* **19.01.21:** - Add python3-pkg-resources

0 commit comments

Comments
 (0)