Initial commit
This commit is contained in:
134
config.example.json
Normal file
134
config.example.json
Normal file
@@ -0,0 +1,134 @@
|
||||
{
|
||||
"_about": "OPDS server backed by FreshRSS. Copy to config.json and edit. Any key starting with an underscore is a comment: it is ignored, never interpolated, and never reported as unknown. Strings may use ${ENV_VAR}, ${ENV_VAR:-default} or ${file:/run/secrets/name}, so secrets do not have to live in this file.",
|
||||
|
||||
"server": {
|
||||
"_host": "0.0.0.0 is required *inside a container*, because the published port only reaches the process through the container's own interface. It is not the 'exposed on every host interface' case: exposure is decided by the port mapping in docker-compose.yaml, which publishes on 127.0.0.1 by default. Running this directly on a host should keep the 127.0.0.1 default instead.",
|
||||
"host": "0.0.0.0",
|
||||
"_port": "0 asks the operating system for a free port, which is handy for a local run or a test; leave it at 8080 for a normal deployment.",
|
||||
"port": 8080,
|
||||
"log_level": "info",
|
||||
|
||||
"_public_base_url": "Absolute base URL for catalog links, e.g. https://opds.example.com. Leave unset to build links from the request Host header. Set it when the service is reachable at more than one name, or when you want the catalog URLs pinned against a spoofed Host header.",
|
||||
"public_base_url": null,
|
||||
|
||||
"_trust_proxy_headers": "Honour X-Forwarded-Proto/Host/Prefix. Enable only behind a reverse proxy you control: without one, a client can set those headers itself.",
|
||||
"trust_proxy_headers": false,
|
||||
|
||||
"_allowed_hosts": "Optional Host allowlist. When set, a request with any other Host is refused with 400. Useful when the service is directly reachable.",
|
||||
"allowed_hosts": [],
|
||||
|
||||
"_tls": "Optional in-process TLS. Usually the reverse proxy terminates TLS instead, but this lets the container be secure on its own. Basic auth is unencrypted, so one of the two is required.",
|
||||
"tls": {
|
||||
"cert_file": null,
|
||||
"key_file": null
|
||||
}
|
||||
},
|
||||
|
||||
"freshrss": {
|
||||
"_url": "Your FreshRSS address. The /api/greader.php suffix is optional here; it is appended when missing, and any path prefix is kept.",
|
||||
"url": "https://rss.example.com",
|
||||
"username": "tyler",
|
||||
|
||||
"_api_password": "Settings -> Account -> API in FreshRSS. This is the API password, which is separate from your login password. Prefer ${file:...} or ${ENV_VAR} over writing it here.",
|
||||
"api_password": "${FRESHRSS_API_PASSWORD}",
|
||||
|
||||
"verify_tls": true,
|
||||
"_ca_file": "Optional CA bundle, for a FreshRSS instance behind a private certificate authority.",
|
||||
"ca_file": null,
|
||||
|
||||
"timeout_seconds": 15,
|
||||
"retries": 2,
|
||||
|
||||
"_mark_read": "Mark the article read in FreshRSS once its EPUB has been fully delivered to the reader.",
|
||||
"mark_read": true,
|
||||
|
||||
"items_per_page": 30,
|
||||
"max_items_per_request": 200,
|
||||
|
||||
"_read_window_items": "How far back the Read section looks. Unread filtering happens upstream, but read items are filtered here, so this bounds the history that section can show.",
|
||||
"read_window_items": 200,
|
||||
|
||||
"_max_content_bytes": "Cap on one article body before it is parsed, so a single enormous feed item cannot dominate memory.",
|
||||
"max_content_bytes": 1048576
|
||||
},
|
||||
|
||||
"catalog": {
|
||||
"title": "FreshRSS OPDS",
|
||||
"author": "Tyler",
|
||||
"language": "en",
|
||||
"_publisher": "Optional dc:publisher for every generated book.",
|
||||
"publisher": null,
|
||||
|
||||
"_show_unread_counts": "Append unread counts to category and feed rows. Costs one extra upstream call per catalog refresh, and degrades quietly if unsupported.",
|
||||
"show_unread_counts": true,
|
||||
|
||||
"_show_read_section": "Expose a Read tree next to the Unread queue, for browsing history without mixing it into the queue.",
|
||||
"show_read_section": true,
|
||||
|
||||
"_show_starred": "Expose starred items as their own shelf.",
|
||||
"show_starred": true,
|
||||
|
||||
"_hide_empty_categories": "Hide categories that contain no feeds (or no unread items, when unread counts are on).",
|
||||
"hide_empty_categories": false,
|
||||
|
||||
"_exclude_categories": "Category labels to leave out of the catalog entirely.",
|
||||
"exclude_categories": [],
|
||||
|
||||
"_exclude_feeds": "Feed titles to leave out of the catalog entirely.",
|
||||
"exclude_feeds": []
|
||||
},
|
||||
|
||||
"epub": {
|
||||
"_include_images": "Download article images and embed them in the book, so it reads correctly offline. Image URLs come from feed content, so they are fetched through an SSRF guard: private, loopback and link-local addresses are refused.",
|
||||
"include_images": true,
|
||||
|
||||
"_allowed_image_hosts": "When non-empty, only images from these hosts may be embedded (no scheme, exact host or subdomain suffix). Use for a locked-down deployment.",
|
||||
"allowed_image_hosts": [],
|
||||
|
||||
"_blocked_image_hosts": "Hosts to refuse even when inlining is on, e.g. a tracking pixel domain.",
|
||||
"blocked_image_hosts": [],
|
||||
|
||||
"max_images_per_article": 20,
|
||||
"max_image_bytes": 2097152,
|
||||
"max_total_image_bytes": 16777216,
|
||||
"image_timeout_seconds": 10,
|
||||
|
||||
"_cover_image": "Use the first suitably large image as the book cover, so a reader's library view shows something other than a blank tile.",
|
||||
"cover_image": true,
|
||||
|
||||
"_include_source_link": "Add a link back to the original article, plus a dc:source entry.",
|
||||
"include_source_link": true,
|
||||
|
||||
"_stylesheet": "Optional path to a CSS file to use instead of the built-in stylesheet.",
|
||||
"stylesheet": null,
|
||||
|
||||
"_max_epub_bytes": "Refuse to build a book larger than this, so one pathological article cannot exhaust memory.",
|
||||
"max_epub_bytes": 33554432
|
||||
},
|
||||
|
||||
"auth": {
|
||||
"_realm": "The realm shown in the reader's password prompt.",
|
||||
"realm": "OPDS",
|
||||
|
||||
"_users": "HTTP Basic credentials. This catalog serves your entire reading queue, so it will not start without at least one user. Use password_sha256 (make hash-password) rather than password: the served catalogue is public once TLS is in front of it, but the config file is not.",
|
||||
"users": [
|
||||
{
|
||||
"username": "tyler",
|
||||
"_password_sha256": "Generate with: make hash-password",
|
||||
"password_sha256": "${OPDS_PASSWORD_SHA256}"
|
||||
}
|
||||
],
|
||||
|
||||
"_max_failures_per_minute": "Failed attempts from one address before it is throttled. Basic auth is brute-forceable, so this is on by default.",
|
||||
"max_failures_per_minute": 10,
|
||||
"throttle_seconds": 60
|
||||
},
|
||||
|
||||
"cache": {
|
||||
"_about": "Lifetimes for the in-memory cache. Nothing is written to disk. Lower values make the catalog more responsive to upstream changes; higher values reduce FreshRSS traffic while a reader browses.",
|
||||
"subscriptions_ttl_seconds": 300,
|
||||
"stream_ttl_seconds": 60,
|
||||
"item_ttl_seconds": 900,
|
||||
"max_entries": 512
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user