Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update qbit-manage.md to correct instances of qbit_manage to qbit-manage #320

Merged
merged 4 commits into from
Nov 30, 2024
Merged

Update qbit-manage.md to correct instances of qbit_manage to qbit-manage #320

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
73112bc
Update qbit-manage.md to correct instances of qbit_manage to qbit-manage
rsimplicio Nov 27, 2024
c04913d
Update qbit-manage.md with missing logs directory in tail command
rsimplicio Nov 27, 2024
89088e9
Update qbit-manage.md
saltydk Nov 30, 2024
fc217a4
Update qbit-manage.md
saltydk Nov 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/sandbox/apps/qbit-manage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# qBit Management
# qBit Manage

## What is it?

[qBit Management](https://github.com/StuffAnThings/qbit_manage) is a program used to manage your qBittorrent instance.
[qBit Manage](https://github.com/StuffAnThings/qbit_manage) is a program used to manage your qBittorrent instance.

| Details | | | |
|-------------|-------------|-------------|-------------|
| [:material-home: qBit Management](https://github.com/StuffAnThings/qbit_manage){: .header-icons } | [:octicons-link-16: Docs](https://github.com/StuffAnThings/qbit_manage/wiki){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/StuffAnThings/qbit_manage){: .header-icons } | [:material-docker: Docker:](https://hotio.dev/containers/qbitmanage/){: .header-icons } |
| [:material-home: qBit Manage](https://github.com/StuffAnThings/qbit_manage){: .header-icons } | [:octicons-link-16: Docs](https://github.com/StuffAnThings/qbit_manage/wiki){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/StuffAnThings/qbit_manage){: .header-icons } | [:material-docker: Docker:](https://hotio.dev/containers/qbitmanage/){: .header-icons } |

**Functions include:-** <br />
**Functions include:** <br />

- Tag torrents based on tracker and then set seed goals/limit upload speed by tag.

Expand All @@ -33,18 +33,18 @@

### 1. Installation

Before installing qBit Management, you should have a **[qBittorrent](../../apps/qbittorrent.md)** instance running on your local machine.
Before installing qBit Manage, you should have a **[qBittorrent](../../apps/qbittorrent.md)** instance running on your local machine.

``` shell

sb install sandbox-qbit-manage

```

After installation has finished, stop the qbit_manage docker container and edit the config file that will have been created at `/opt/qbit_manage/config.yml`
After installation has finished, stop the qbit-manage docker container and edit the config file that will have been created at `/opt/qbit-manage/config.yml`

```shell
docker stop qbit_manage
docker stop qbit-manage
```

Minimally you will need to change the following items in order to connect with your qBittorrent instance:-
Expand All @@ -68,10 +68,10 @@ The config file is full of examples that more than likely will not work for you,
After making adjustments to the config file, you can start the docker container again.

```shell
docker start qbit_manage
docker start qbit-manage
```

Either tail the log ( `tail -f "/opt/qbit_manage/activity.log"` ) or open the log file after a few minutes to check for any errors or behaviour that may have been unexpected. The container has been deliberately set to **DRY RUN MODE** initially so you can see what the script will do without actually moving deleting, tagging, or categorising anything.. Once you are happy your life's work will not be destroyed and any errors have been resolved you can edit the qbit_manage variables in the sandbox settings.yml file and then run the role again. Set `qbt_dry_run: false` to run in live mode. This will delete and move files according to your settings.
Either tail the log ( `tail -f "/opt/qbit-manage/logs/activity.log"` ) or open the log file after a few minutes to check for any errors or behaviour that may have been unexpected. The container has been deliberately set to **DRY RUN MODE** initially so you can see what the script will do without actually moving deleting, tagging, or categorising anything.. Once you are happy your life's work will not be destroyed and any errors have been resolved you can edit the qbit_manage variables in the sandbox settings.yml file and then run the role again. Set `qbt_dry_run: false` to run in live mode. This will delete and move files according to your settings.

Apply the changes to the sandbox settings file with:

Expand Down Expand Up @@ -105,4 +105,4 @@ qbit_manage:
qbt_width: "100" # Default is "100"
```

- [:octicons-link-16: Documentation: qBit Management Docs](https://github.com/StuffAnThings/qbit_manage/wiki){: .header-icons }
- [:octicons-link-16: Documentation: qBit Manage Docs](https://github.com/StuffAnThings/qbit_manage/wiki){: .header-icons }