StuffAnThings/qbit_manage
1
1
Fork 0
mirror of https://github.com/StuffAnThings/qbit_manage.git synced 2025-10-17 17:26:14 +08:00
Code Issues Projects Releases Packages Wiki Activity
qbit_manage/docs/Local-Installations.md
bobokun 3fa5fcee3b
v4.5.0 (#862) 
# Requirements Updated
- fastapi==0.116.0
- retrying==1.4.0
- uvicorn==0.35.0

# New Features
- **Web UI**: Introduced a new Web UI for configuring and managing qBit
Manage.
  - Visual Configuration Editor for YAML files.
  - Command Execution directly from the UI.
  - Undo/Redo History for changes.
  - Theme Support (light/dark mode).
  - Responsive Design for desktop and mobile.
  - Real-time YAML Preview.
- Pass skip qbitorrent check as optional parameter to the API (Adds
#860)\


**Full Changelog**:
https://github.com/StuffAnThings/qbit_manage/compare/v4.4.0...v4.5.0

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: ineednewpajamas <73252768+ineednewpajamas@users.noreply.github.com>
2025-07-11 19:13:41 -04:00

1.3 KiB
Raw Blame History

Local Installations

Below is a simple high level set of instructions for cloning the repository and executing qbit_manage

  • Requires python 3.9.0. Dependencies must be installed by running:

Navigate to the directory you'd liked to clone the repo into

Clone the repo

git clone https://github.com/StuffAnThings/qbit_manage

Install requirements

pip install .

If there are issues installing dependencies try:

pip install . --ignore-installed

Usage

To run the script in an interactive terminal run:

  • copy the config.yml.sample file to config.yml
  • Fill out the config file as outlined in the Config-Setup

Run the script -h to see a list of commands

python qbit_manage.py -h

Web API and Web UI

To run the Web API and Web UI, use the --web-server flag:

python qbit_manage.py --web-server

You can then access the Web UI in your browser, typically at http://localhost:8080.

Config

To choose the location of the YAML config file

python qbit_manage.py --config-file <path_to_config>

Log

To choose the location of the Log File

python qbit_manage.py --log-file <path_to_log>