mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-06-11 01:55:59 +02:00
Realign logic of titles
This commit is contained in:
Alexandre
@@ -1,4 +1,5 @@
|
||||
# Home assistant add-on: qbittorrent
|
||||
|
||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||
|
||||
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
||||
@@ -7,12 +8,15 @@
|
||||
Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield]
|
||||
![Supports smb mounts][smb-shield] ![Supports openvpn][openvpn-shield] ![Supports ingress][ingress-shield] ![Supports ssl][ssl-shield]
|
||||
|
||||
# About
|
||||
----------
|
||||
## About
|
||||
|
||||
---
|
||||
|
||||
[Qbittorrent](https://github.com/qbittorrent/qBittorrent) is a cross-platform free and open-source BitTorrent client.
|
||||
This addon is based on the docker image from [linuxserver.io](https://www.linuxserver.io/).
|
||||
|
||||
This addons has several configurable options :
|
||||
|
||||
- allowing to mount local external drive, or smb share from the addon
|
||||
- [alternative webUI](https://github.com/qbittorrent/qBittorrent/wiki/List-of-known-alternate-WebUIs)
|
||||
- usage of ssl
|
||||
@@ -20,12 +24,14 @@ This addons has several configurable options :
|
||||
- optional openvpn support
|
||||
- allow setting specific DNS servers
|
||||
|
||||
# Installation
|
||||
----------
|
||||
## Installation
|
||||
|
||||
---
|
||||
|
||||
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
||||
|
||||
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
||||
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
||||
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
||||
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
||||
1. Install this add-on.
|
||||
1. Click the `Save` button to store your configuration.
|
||||
1. Set the add-on options to your preferences
|
||||
@@ -33,10 +39,12 @@ The installation of this add-on is pretty straightforward and not different in c
|
||||
1. Check the logs of the add-on to see if everything went well.
|
||||
1. Open the webUI and adapt the software options
|
||||
|
||||
# Configuration
|
||||
--------------
|
||||
## Configuration
|
||||
|
||||
---
|
||||
|
||||
Webui can be found at <http://your-ip:8080>, or in your sidebar using Ingress.
|
||||
The default username/password : described in the startup log.
|
||||
The default username/password : described in the startup log.
|
||||
Configurations can be done through the app webUI, except for the following options
|
||||
|
||||
Network disk is mounted to /mnt/share name
|
||||
@@ -48,7 +56,7 @@ ssl: true/false
|
||||
certfile: fullchain.pem #ssl certificate, must be located in /ssl
|
||||
keyfile: privkey.pem #sslkeyfile, must be located in /ssl
|
||||
whitelist: "localhost,192.168.0.0/16" # list ip subnets that won't need a password (optional)
|
||||
Username: "admin" #username to access webui. Please change it as the default is admin for all installations.
|
||||
Username: "admin" #username to access webui. Please change it as the default is admin for all installations.
|
||||
customUI: selection from list # alternative webUI can be set here. Latest version set at each addon start.
|
||||
DNS_servers : 8.8.8.8,1.1.1.1 # Keep blank to use router’s DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover
|
||||
SavePath: "/share/qbittorrent" # Define the download directory
|
||||
@@ -59,21 +67,26 @@ cifspassword: "password" # optional, smb password
|
||||
cifsdomain: "domain" # optional, allow setting the domain for the smb share
|
||||
password, same for all smb shares
|
||||
openvpn_enabled: true/false # is openvpn required to start qbittorrent
|
||||
openvpn_alternative_mode: true/false # if enabled, will tunnel only qbittorrent and not webui through vpn. Allows webui connection from external networks, but risk of decreased stability.
|
||||
openvpn_config": For example "config.ovpn" # name of the file located in /config/openvpn.
|
||||
openvpn_alternative_mode: true/false # if enabled, will tunnel only qbittorrent and not webui through vpn. Allows webui connection from external networks, but risk of decreased stability.
|
||||
openvpn_config": For example "config.ovpn" # name of the file located in /config/openvpn.
|
||||
openvpn_username": USERNAME
|
||||
openvpn_password: YOURPASSWORD
|
||||
run_duration: 12h #for how long should the addon run. Must be formatted as number + time unit (ex : 5s, or 2m, or 12h, or 5d...)
|
||||
```
|
||||
# Integration with HA
|
||||
|
||||
## Integration with HA
|
||||
|
||||
Use the [qBittorrent integration](https://www.home-assistant.io/integrations/qbittorrent/)
|
||||
|
||||
## Support
|
||||
|
||||
Create an issue on github, or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-qbittorrent/279247)
|
||||
|
||||
# Illustration (vuetorrent webui)
|
||||
--------------
|
||||
|
||||
## Illustration (vuetorrent webui)
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||
[smb-shield]: https://img.shields.io/badge/smb-yes-green.svg
|
||||
@@ -84,4 +97,3 @@ Create an issue on github, or ask on the [home assistant thread](https://communi
|
||||
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||
|
||||
|
||||
Reference in New Issue
Block a user