qbit_manage/docs/Home.md
bobokun 27231150ec
4.1.1 (#528)
* 4.1.1-develop

* Updated docs

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

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

* Fixes #522

* (docs): automatically add Supported Version to README (#521)

* (docs): add version for qbit / qbit api to readme (#523)

(cherry picked from commit 37e560f7ef)

* (docs): automate supported versions for readme

(docs): readme updates

(chore): fix pre-commit increase_version

* (chore): automate supported version updates

---------

Co-authored-by: bakerboy448 <mailto:55419169+bakerboy448@users.noreply.github.com>

* Adds pre-commit hook to update-readme-version

* Bump actions/setup-python from 4 to 5 (#525)

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump actions/checkout from 3 to 4 (#526)

Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump peter-evans/create-pull-request from 4 to 6 (#527)

Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 4 to 6.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](https://github.com/peter-evans/create-pull-request/compare/v4...v6)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Dependabot to auto-update qbittorrent-api on master

* 4.1.1

* fixes pre-commit on github actions

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Actionbot <actions@github.com>
Co-authored-by: bakerboy448 <55419169+bakerboy448@users.noreply.github.com>
Co-authored-by: bakerboy448 <mailto:55419169+bakerboy448@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-04-07 21:33:15 -04:00

45 lines
2.7 KiB
Markdown

# qBit_manage Wiki
This wiki should tell you everything you need to know about the script to get it working.
## Getting Started
1. Install qbit_manage either by installing Python3.8.1+ on the localhost and following the [Local Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Local-Installations) Guide or by installing Docker and following the [Docker Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Docker-Installation) Guide or the [unRAID Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Unraid-Installation) Guide.<br>
2. Once installed, you have to [set up your Configuration](https://github.com/StuffAnThings/qbit_manage/wiki/Config-Setup) by create a [Configuration File](https://github.com/StuffAnThings/qbit_manage/blob/master/config/config.yml.sample) filled with all your values to connect to your qBittorrent instance.
3. Please refer to the list of [Commands](https://github.com/StuffAnThings/qbit_manage/wiki/Commands) that can be used with this tool.
## Support
* If you have any questions or require support please join the [Notifiarr Discord](https://discord.com/invite/AURf8Yz) and post your question under the `qbit-manage` channel.
* If you're getting an Error or have an Enhancement post in the [Issues](https://github.com/StuffAnThings/qbit_manage/issues/new).
* If you have a configuration question post in the [Discussions](https://github.com/StuffAnThings/qbit_manage/discussions/new).
* Pull Request are welcome but please submit them to the [develop branch](https://github.com/StuffAnThings/qbit_manage/tree/develop).
## Table of Contents
* [Home](Home)
* [Installation](Installation)
* [unRAID Installation](Unraid-Installation)
* [Local Installation](Local-Installations)
* [NIX Installation](Nix-Installation)
* [Docker Installation](Docker-Installation)
* [V4 Migration Guide](v4-Migration-Guide)
* [Config Setup](Config-Setup)
* [Sample Config File](Config-Setup#config-file)
* [List of variables](Config-Setup#list-of-variables)
* [commands](Config-Setup#commands)
* [qbt](Config-Setup#qbt)
* [settings](Config-Setup#settings)
* [directory](Config-Setup#directory)
* [cat](Config-Setup#cat)
* [cat_changes](Config-Setup#cat_changes)
* [tracker](Config-Setup#tracker)
* [nohardlinks](Config-Setup#nohardlinks)
* [share_limits](Config-Setup#share_limits)
* [recyclebin](Config-Setup#recyclebin)
* [orphaned](Config-Setup#orphaned)
* [apprise](Config-Setup#apprise)
* [notifiarr](Config-Setup#notifiarr)
* [webhooks](Config-Setup#webhooks)
* [bhd](Config-Setup#bhd)
* [Commands](Commands)