chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
docs: 17-item follow-up — env-var audit, schemas, migration steps, worked examples
Follow-up pass to commits 49e5b10 + 698442f. Three parallel subagent passes.
Config-Setup.md:
- Full env-var audit (30 vars from qbit_manage.py get_arg() calls);
qbt: section now has a complete env-var table
- upload_speed_on_limit_reached behavior note (default 0 means "stop upload")
- stalled_tag pairing note with tag_stalled_torrents toggle
- rem_unregistered_filter_completed cross-seed interplay paragraph
- Cleanup + recyclebin worked example with YAML + walkthrough
- Cross-seed safety extension covering rem_unregistered + tag_nohardlinks paths
- Header continuity ("Last validated against v4.7.1")
Commands.md:
- --log-file environment-variable override note (QBT_LOGFILE)
- Header continuity
Standalone-Scripts.md:
- Added previously-undocumented internal CI helpers:
scripts/pre-commit/increase_version.sh,
scripts/pre-commit/update-readme-version.sh,
scripts/pre-commit/update_develop_version.sh
- Header continuity
Docker-Installation.md:
- Full worked example: end-to-end compose (volumes, env, PUID/PGID, TZ),
bring-up commands, health check, nginx + Caddy reverse-proxy snippets,
common gotchas table
- Header continuity
Web-API.md:
- Auth-required column added to endpoint summary table; per-endpoint
annotation distinguishes always-public (/api/health, /api/version,
/api/get_base_url per modules/auth.py:416-424) from authenticated
- Expanded request/response schemas for the most-used endpoints
(configs CRUD + validate, scheduler/schedule, logs, health, version)
- Updated stale Docker Hub image bobokun/qbit_manage:latest
-> ghcr.io/stuffanthings/qbit_manage:latest in the legacy example
- Dropped deprecated compose version: "3" key
- Header continuity
v4-Migration-Guide.md:
- Expanded "Post-v4.0 notable additions" from bullets to full migration
steps for upload_speed_on_limit_reached, min/max_torrent_size,
reset_upload_speed_on_unmet_minimums, rem_unregistered_grace_minutes,
rem_unregistered_max_torrents (what-it-does, old behavior,
migration YAML, when-to-use per key)
- Header continuity
Code-side (separate PR #1204):
- Removed stale Python >=3.8.1 runtime guard in qbit_manage.py:38;
bumped to >=3.10 to match pyproject.toml.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
docs: address discussion-audit doc gaps + Web-API auth-note correction
Discussion-surfaced doc gaps (not covered by the prior 13-fix audit):
Config-Setup.md:
- qbt: section — clarified that QBT_HOST env-var override is supported
but user/pass must be set in YAML (per get_arg in qbit_manage.py)
[discussion #402]
- share_limits cleanup field — added note on cleanup + recyclebin
interaction (data sent to recyclebin if enabled, hard-deleted otherwise)
[discussion #360]
- share_limits cleanup field — added cross-seed safety note (sibling
same-save-path torrents keep their data on disk; only the cleaned-up
torrent is removed from qBit)
[discussion #347]
- directory: section — clarified root_dir is singular; multi-root setups
need separate qbit_manage instances
[discussion #125]
Web-API.md:
- Auth note correction (post-audit follow-up): /api/health, /api/version,
/api/get_base_url are unconditionally bypassed by AuthenticationMiddleware
even when auth is enabled, per modules/auth.py:416-424 skip_auth_paths.
Previous blanket "all endpoints require auth when enabled" was over-claiming.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
docs: align wiki with v4.7.1 master release (13 fixes)
Per 2026-05-21 docs audit. All changes verified against
git show origin/master:<source> in StuffAnThings/qbit_manage.
WRONG (4):
- Commands.md: --log-file default activity.log -> qbit_manage.log
(matches argparse default at qbit_manage.py:138)
- Docker-Installation.md: replaced the misleading "Web API and Web UI
are enabled by default in this Docker setup" claim with the actual
code behavior (disabled by default in Docker; example sets
QBT_WEB_SERVER=true explicitly)
- Installation.md: Python 3.9 -> Python 3.10 minimum (matches
pyproject.toml requires-python >=3.10; noted runtime guard at
qbit_manage.py:38 is stale)
- Config-Setup.md: upload_speed_on_limit_reached default -1 -> 0
(matches modules/config.py:695)
MISSING-FROM-DOCS (3 = 4 sub-items):
- Config-Setup.md settings table: added stalled_tag row
(str, default stalledDL; modules/config.py:304)
- Config-Setup.md settings table: added rem_unregistered_filter_completed
row (bool, default false; modules/config.py:327-329)
- Commands.md: added --version/-v flag row (qbit_manage.py:259) and
QBT_CONFIG env var row (qbit_manage.py:287)
- Web-API.md: expanded from 1 endpoint to full surface; documented
GET/POST/PUT/DELETE /api/configs/{filename} + validate/backup/restore,
scheduler, schedule, logs, log_files, docs, version, health,
get_base_url, security, security/status, system/force-reset
(plus newly discovered backups + PUT security routes)
STALE (2):
- Docker-Installation.md: removed deprecated version: "3.7" from
compose example (Compose v2 has dropped the version field)
- v4-Migration-Guide.md: added "Post-v4.0 notable additions" section
covering upload_speed_on_limit_reached, min/max_torrent_size,
reset_upload_speed_on_unmet_minimums,
rem_unregistered_grace_minutes/max_torrents
Misc:
- Docker-Installation.md: clarified the QBT_WEB_SERVER=true comment
- Standalone-Scripts.md: noted update-readme-version.py is internal CI
- Config-Setup.md: added "Last validated against v4.7.1" header note
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Updated Config Setup (markdown)
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
Updated Config Setup (markdown)
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
Updated Config Setup (markdown)
Updated Config Setup (markdown)
Updated Config Setup (markdown)
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
Updated Config Setup (markdown)
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]
chore(docs): Sync docs to wiki [skip-cd]