From 95127408d07defd2493ca4a732dd96dfdb6ec8bb Mon Sep 17 00:00:00 2001 From: Actionbot Date: Sat, 30 Aug 2025 12:40:37 +0000 Subject: [PATCH] chore(docs): Sync docs to wiki [skip-cd] --- Commands.md | 1 + Web-API.md | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Commands.md b/Commands.md index 1c15c02..0ba2708 100644 --- a/Commands.md +++ b/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 | diff --git a/Web-API.md b/Web-API.md index 1719593..1fe6966 100644 --- a/Web-API.md +++ b/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