StuffAnThings/qbit_manage
1
1
Fork 0
mirror of https://github.com/StuffAnThings/qbit_manage.git synced 2025-10-22 03:36:57 +08:00
Code Issues Projects Releases Packages Wiki Activity

Fix broken links in docs

Browse source
This commit is contained in:
bobokun 2025-08-16 23:02:01 -04:00
parent 2bb3fa35c1
commit 1490ac134b
No known key found for this signature in database
GPG key ID: B73932169607D927
5 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
VERSION
View file

@ -1 +1 @@
4.5.5-develop2
4.5.5-develop4

2
docs/Commands.md
View file

@ -8,7 +8,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.md) 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 |
| `-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 |
| `-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 if you would like to update your categories or move from one category to another. | False |

2
docs/Config-Setup.md
View file

@ -1,7 +1,7 @@
# Overview
The script utilizes a YAML config file to load information to connect to the various APIs you can connect with. Alternatively, you can configure qBit Manage using the [Web UI](Web-UI.md), which requires the [Web API](Web-API.md) to be enabled.
The script utilizes a YAML config file to load information to connect to the various APIs you can connect with. Alternatively, you can configure qBit Manage using the [Web UI](Web-UI), which requires the [Web API](Web-API) to be enabled.
## Default Configuration File Locations

2
docs/Docker-Installation.md
View file

@ -78,7 +78,7 @@ The Web API and Web UI are enabled by default in this Docker setup.
2. Access the Web UI at `http://your-host:8080`
3. Access the Web API at `http://your-host:8080/api/run-command`
See the [Web API Documentation](Web-API.md) for detailed usage instructions and examples.
See the [Web API Documentation](Web-API) for detailed usage instructions and examples.
You will also need to define not just the config volume but the volume to your torrents, this is in order to use the recycling bin, remove orphans and the no hard link options

4
docs/Local-Installations.md
View file

@ -78,7 +78,7 @@ After installation, qbit_manage will look for configuration files in platform-sp
copy config\config.yml.sample "%APPDATA%\qbit-manage\config.yml" # Windows
```
3. Edit the configuration file as outlined in the [Config-Setup](Config-Setup.md) guide.
3. Edit the configuration file as outlined in the [Config-Setup](Config-Setup) guide.
**Alternative**: You can place the config file anywhere and specify its location using the `--config-file` option.
@ -141,7 +141,7 @@ qbit-manage --schedule 1440 # Run every 24 hours (1440 minutes)
| `--schedule`, `-sch` | Run on a schedule (minutes) |
| `--run`, `-r` | Run once and exit (no scheduler) |
For a complete list of commands and options, see the [Commands](Commands.md) documentation.
For a complete list of commands and options, see the [Commands](Commands) documentation.
### Virtual Environment (Recommended)