StuffAnThings/qbit_manage
1
1
Fork 0
mirror of https://github.com/StuffAnThings/qbit_manage.git synced 2025-11-10 16:30:54 +08:00
Code Issues Projects Releases Packages Wiki Activity

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

Actionbot 2025-08-30 12:40:37 +00:00
parent 9d9c283117
commit 95127408d0
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Commands.md

@ -3,6 +3,7 @@
| **Shell Command** | **Docker Environment Variable** | **Config Command** | **Description** | **Default Value** |
|:---------------------------------------:|:-------------------------------:|:---------------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------:|
| `-ws` or `--web-server` | QBT_WEB_SERVER | N/A | Start the webUI server to handle command requests via HTTP API. | False |
| `-H` or `--host` | QBT_HOST | N/A | Hostname for the web server (default: 0.0.0.0). | 8080 |
| `-p` or `--port` | QBT_PORT | N/A | Port number for the web server (default: 8080). | 8080 |
| `-b` or `--base-url` | QBT_BASE_URL | N/A | Base URL path for the web UI (e.g., '/qbit-manage'). Default is empty (root). | "" |
| `-r` or`--run` | QBT_RUN | N/A | Run without the scheduler. Script will exit after completion. | False |

5
Web-API.md

@ -2,14 +2,14 @@
## Overview
qBit Manage provides a REST API that allows you to trigger commands via HTTP requests. The API server runs on port 8080 by default and can be configured using the `--port` option or `QBT_PORT` environment variable.
qBit Manage provides a REST API that allows you to trigger commands via HTTP requests. The API server runs at 8080, listening to all hostnames, by default and can be configured using the `--host` and `--port` options or `QBT_HOST` and `QBT_PORT` environment variables.
## Running the Web Server
### Command Line
```bash
python qbit_manage.py --web-server --port 8080
python qbit_manage.py --web-server --host 0.0.0.0 --port 8080
```
### Docker
@ -22,6 +22,7 @@ services:
container_name: qbit_manage
environment:
- QBT_WEB_SERVER=true # Enable web server
- QBT_HOST=0.0.0.0 # Set web server host
- QBT_PORT=8080 # Set web server port
ports:
- "8080:8080" # Map container port to host