StuffAnThings/qbit_manage
1
1
Fork 0
mirror of https://github.com/StuffAnThings/qbit_manage.git synced 2025-11-07 06:56:14 +08:00
Code Issues Projects Releases Packages Wiki Activity

chore(docs): Sync docs to wiki [skip-cd]

Actionbot 2025-08-30 17:37:16 +00:00
parent 95127408d0
commit f59438d256
5 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
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 |

4
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).

2
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

4
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
```

2
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"