From f59438d2568bb29bb1cac9b907ee2e024c59a139 Mon Sep 17 00:00:00 2001 From: Actionbot Date: Sat, 30 Aug 2025 17:37:16 +0000 Subject: [PATCH] chore(docs): Sync docs to wiki [skip-cd] --- Commands.md | 2 +- Config-Setup.md | 4 ++-- Docker-Installation.md | 2 +- Installation.md | 4 ++-- Unraid-Installation.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Commands.md b/Commands.md index 0ba2708..ca10330 100644 --- a/Commands.md +++ b/Commands.md @@ -9,7 +9,7 @@ | `-r` or`--run` | QBT_RUN | N/A | Run without the scheduler. Script will exit after completion. | False | | `-sch` or `--schedule` | QBT_SCHEDULE | N/A | Schedule to run every x minutes or choose customize schedule via [cron](https://crontab.guru/examples.html). (Default set to 1440 (1 day)) | 1440 | | `-sd` or `--startup-delay` | QBT_STARTUP_DELAY | N/A | Set delay in seconds on the first run of a schedule (Default set to 0) | 0 | -| `-c CONFIG` or `--config-file CONFIG` | QBT_CONFIG | N/A | Override the default config file location. By default, qbit_manage looks for `config.yml` in platform-specific directories (see [Config-Setup](Config-Setup) for details). Use this to specify a custom path or filename. `Example: tv.yml`. Supports wildcards to use multiple configs. `Example: config-*.yml` | Platform-specific | +| `-cd CONFIG_DIR` or `--config-dir CONFIG_DIR` | QBT_CONFIG_DIR | N/A | Override the default config directory location. By default, qbit_manage looks for `config.yml` in platform-specific directories (see [Config-Setup](Config-Setup) for details). Use this to specify a custom directory path. `Example: /path/to/config/dir`. | Platform-specific | | `-lf LOGFILE,` or `--log-file LOGFILE,` | QBT_LOGFILE | N/A | This is used if you want to use a different name for your log file. `Example: tv.log` | activity.log | | `-re` or `--recheck` | QBT_RECHECK | recheck | Recheck paused torrents sorted by lowest size. Resume if Completed. | False | | `-cu` or `--cat-update` | QBT_CAT_UPDATE | cat_update | Use this option to update your categories or switch between them. The category function takes the save path of the torrent and assigns the corresponding category to it based on that path. | False | diff --git a/Config-Setup.md b/Config-Setup.md index f4166a1..c1756d6 100644 --- a/Config-Setup.md +++ b/Config-Setup.md @@ -13,9 +13,9 @@ The script looks for the configuration file in different locations depending on - **Linux/Unix**: `~/.config/qbit-manage/config.yml` (or `$XDG_CONFIG_HOME/qbit-manage/config.yml` if XDG_CONFIG_HOME is set) ### Docker Installation -- `/app/config.yml` (inside the container) +- `/config/config.yml` (inside the container) -You can override the default location by using the `--config-file` or `-c` command line option to specify a custom path. +You can override the default location by using the `--config-dir` or `-cd` command line option to specify a custom directory. A template Configuration File can be found in the repo [config/config.yml.sample](https://github.com/StuffAnThings/qbit_manage/blob/master/config/config.yml.sample). diff --git a/Docker-Installation.md b/Docker-Installation.md index f0b192a..adf9e98 100644 --- a/Docker-Installation.md +++ b/Docker-Installation.md @@ -43,7 +43,7 @@ services: # Scheduler Configuration - QBT_RUN=false - QBT_SCHEDULE=1440 - - QBT_CONFIG=config*.yml + - QBT_CONFIG_DIR=/config - QBT_LOGFILE=qbit_manage.log # Command Flags diff --git a/Installation.md b/Installation.md index de63e75..cfe38d5 100644 --- a/Installation.md +++ b/Installation.md @@ -206,7 +206,7 @@ uv pip install -e . --upgrade - **Host Mount**: Typically mounted from `/path/to/your/config:/config` ### Custom Location -You can override the default location using the `--config-file` or `-c` command line option: +You can override the default location using the `--config-dir` or `-cd` command line option: ```bash -qbit-manage --config-file /path/to/your/config.yml +qbit-manage --config-dir /path/to/your/config/directory ``` diff --git a/Unraid-Installation.md b/Unraid-Installation.md index eea1b42..ade92ea 100644 --- a/Unraid-Installation.md +++ b/Unraid-Installation.md @@ -81,7 +81,7 @@ http://[UNRAID-IP]:8080 #!/bin/bash echo "Running qBitTorrent Management" python3 /mnt/user/data/scripts/qbit/qbit_manage.py \ - --config-file /mnt/user/data/scripts/qbit/config.yml \ + --config-dir /mnt/user/data/scripts/qbit/ \ --log-file /mnt/user/data/scripts/qbit/activity.log \ --run echo "qBitTorrent Management Completed"