StuffAnThings/qbit_manage
1
1
Fork 0
mirror of https://github.com/StuffAnThings/qbit_manage.git synced 2025-09-14 00:54:33 +08:00
Code Issues Projects Releases Packages Wiki Activity
Page: Web UI
Pages
Commands Config Setup Docker Installation Home Installation Standalone Scripts Unraid Installation Web API Web UI v4 Migration Guide
6 Web UI
Actionbot edited this page 2025-09-10 23:29:43 +00:00
Table of Contents

qBit Manage Web UI

Important

Below is a summary of the WebUI. For details on the specific features and settings please see the rest of the wiki and sample config file to understand the functionality and description of each setting. The WebUI is effectively a GUI config file editor. You cannot edit environmental or container variables via the WebUI.

Overview

The qBit Manage Web UI provides a modern interface for configuring and managing qBit Manage. It offers real-time editing of YAML configuration files through an intuitive visual interface, eliminating the need for manual file editing.

Key Features

The qBit Manage Web UI offers a range of features designed to simplify your configuration and management tasks:

  • Visual Configuration Editor: Easily edit your YAML configuration files through intuitive forms, eliminating the need for manual text editing.
  • Command Execution: Run qBit Manage commands on demand directly from the Web UI, without waiting for scheduled runs.
  • Undo/Redo History: Track and revert changes with a comprehensive history, ensuring you can always go back to a previous state.
  • Theme Support: Switch between light and dark modes, with automatic detection of your system's preferred theme.
  • Responsive Design: Access and manage your qBit Manage instance seamlessly from both desktop and mobile devices.
  • YAML Preview: See a real-time preview of the YAML configuration as you make changes, ensuring accuracy before saving.

Security Features

The Web UI includes built-in security options to protect your qBit Manage instance:

Authentication Methods

  • None: No authentication required (default for personal use)
  • Basic Authentication: Username and password login with browser popup
  • API Only: No web UI authentication, but API key required for API requests

API Key Usage

When authentication is enabled, you can generate an API key for programmatic access:

  1. Access the Security section in the Web UI
  2. Generate a new API key
  3. Use the key in API requests with the X-API-Key header

Example API call with key:

curl -H "X-API-Key: your_api_key_here" http://localhost:8080/api/run-command

Security Best Practices

  • Use strong passwords with at least 8 characters
  • Enable authentication when running on public networks
  • Keep API keys secure and regenerate them periodically
  • Use HTTPS in production environments

Troubleshooting Authentication Issues

Can't Access Web UI After Enabling Authentication

If you get locked out after enabling authentication:

  1. Edit the settings file directly (config/qbm_settings.yml)
  2. Set authentication.enabled: false or authentication.method: none
  3. Restart qBit Manage
  4. Reconfigure authentication through the web UI

Basic Authentication Not Working

  • Ensure your browser supports HTTP Basic Authentication
  • Check that your credentials are correct
  • Try clearing browser cache/cookies
  • If rate limited, wait 1 minute before trying again (maximum 10 attempts per minute)

Configuration Sections

The Web UI organizes all configuration options into logical sections for easy navigation and management:

  1. Commands: Define and manage the various script execution workflows.
  2. qBittorrent Connection: Set up and configure access to your qBittorrent instance.
  3. Settings: Adjust general application preferences and behavior.
  4. Directory Paths: Specify important file system locations used by qBit Manage.
  5. Categories: Manage your torrent categories and their associated save paths.
  6. Category Changes: Configure rules for bulk modification of torrent categories.
  7. Tracker Configuration: Define settings and tags based on torrent tracker URLs.
  8. No Hard Links: Handle torrents that do not have hard links, often used for media management.
  9. Share Limits: Apply rules for torrent ratio and seeding time based on custom criteria.
  10. Recycle Bin: Configure how deleted torrents and their data are managed.
  11. Orphaned Files: Set up cleanup rules for files not associated with any torrents.
  12. Notifications: Configure various alert and notification settings.
  13. Logs: View application logs for monitoring and troubleshooting.

Usage

To get started with the qBit Manage Web UI:

  1. Ensure the qBit Manage backend is running and accessible. If running in Docker, ensure the web server is enabled and the port is mapped (e.g., QBT_WEB_SERVER=true and ports: - "8080:8080").
  2. Access the Web UI through your web browser at the configured address (e.g., http://localhost:8080 or http://your-docker-host-ip:8080).
  3. Select your desired configuration file from the dropdown menu.
  4. Navigate through the different configuration sections using the sidebar.
  5. Use the preview button to review the generated YAML before saving.
  6. Save your changes when you are satisfied with the configuration.
  7. To run commands immediately, open the "Run Commands" modal (using the button in the toolbar or the Ctrl+R keyboard shortcut), select the commands you wish to run, and click "Run".

Keyboard Shortcuts

For quicker navigation and actions, the Web UI supports the following keyboard shortcuts:

  • Ctrl+S: Save the current configuration.
  • Ctrl+R: Open the "Run Commands" modal to execute qBit Manage operations immediately.
  • Ctrl+Z: Undo the last change.
  • Ctrl+Y: Redo the last undone change.
  • Ctrl+/: Toggle the "Help" modal.
  • Ctrl+P or Cmd+P: Toggle the YAML preview.
  • Escape: Close any open modals or panels.

Want to contribute to this Wiki or have suggestions?

Fork it and send a pull request.

Submit a Docs request.