initial commit
This commit is contained in:
@@ -0,0 +1,36 @@
|
||||
# Calibre-Web
|
||||
|
||||
Deploy Calibre-Web ebook server using Docker Compose.
|
||||
|
||||
## Description
|
||||
|
||||
Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks from a Calibre database.
|
||||
|
||||
## Variables
|
||||
|
||||
### Required
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
| `calibre_web_library_path` | Path to existing Calibre library directory |
|
||||
|
||||
### Optional
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `calibre_web_http_port` | `8083` | Web interface port |
|
||||
| `calibre_web_config_path` | `{{ app_dir }}/config` | Configuration storage |
|
||||
| `calibre_web_container_version` | `latest` | Calibre-Web Docker image tag |
|
||||
| `calibre_web_uid` | `{{ app_uid }}` | User ID for file permissions |
|
||||
| `calibre_web_gid` | `{{ app_gid }}` | Group ID for file permissions |
|
||||
| `calibre_web_timezone` | `{{ app_timezone }}` | Container timezone |
|
||||
| `calibre_web_docker_mods` | `linuxserver/mods:universal-calibre` | Adds ebook conversion capability (x86-64 only) |
|
||||
| `calibre_web_oauth_relax` | `1` | Allows Google OAuth to work. Set to `0` to disable |
|
||||
|
||||
## Example
|
||||
|
||||
```yaml
|
||||
- role: patrickj.docker_apps.calibre-web
|
||||
vars:
|
||||
calibre_web_library_path: /storage/ebooks/calibre-library
|
||||
```
|
||||
Reference in New Issue
Block a user