Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up readme (master) #331

Merged
merged 1 commit into from
Dec 1, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions readme-vars.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
param_usage_include_vols: true
param_volumes:
- { vol_path: "/config", vol_host_path: "/path/to/data", desc: "Where calibre-web stores the internal database and config." }
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Where calibre-web stores the internal database and config." }
- { vol_path: "/books", vol_host_path: "/path/to/calibre/library", desc: "Where your preexisting calibre database is located." }
param_usage_include_ports: true
param_ports:
Expand All @@ -41,11 +41,6 @@ opt_param_usage_include_env: true
opt_param_env_vars:
- { env_var: "DOCKER_MODS", env_value: "linuxserver/mods:universal-calibre", desc: "#optional & **x86-64 only** Adds the ability to perform ebook conversion"}
- { env_var: "OAUTHLIB_RELAX_TOKEN_SCOPE", env_value: "1", desc: "Optionally set this to allow Google OAUTH to work" }
opt_param_usage_include_vols: false
opt_param_usage_include_ports: false
opt_param_device_map: false
opt_cap_add_param: false
optional_block_1: false

# application setup block
app_setup_block_enabled: true
Expand All @@ -58,7 +53,7 @@ app_setup_block: |
*Username:* admin
*Password:* admin123

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

Expand Down