From 053a67c67841e2116e0824c1070743a0285a2980 Mon Sep 17 00:00:00 2001 From: MarkusMcNugen Date: Sun, 11 Feb 2018 16:52:40 -0500 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f2f7b73..c3faef2 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Docker container which runs a headless qBittorrent v4.3 client with WebUI while * Specify name servers to add to container * Configure UID and GID for config files and downloads by qBittorrent -## Run container from Docker registry +# Run container from Docker registry The container is available from the Docker registry and this is the simplest way to get it. To run the container use this command: @@ -33,6 +33,7 @@ $ docker run --privileged -d \ markusmcnugen/qbittorrentvpn ``` +# Variables ## Environment Variables | Variable | Required | Function | Example | |----------|----------|----------|----------| @@ -55,26 +56,26 @@ $ docker run --privileged -d \ | `8999` | TCP | Yes | qBittorrent listening port | `8999:8999`| | `8999` | UDP | Yes | qBittorrent listening port | `8999:8999/udp`| -## Access the WebUI +# Access the WebUI Access http://IPADDRESS:8080 from a browser on the same network. **Note:** qBittorrent throws a header mismatch error if trying to open the WebUI in unRAID with the WebUI link. Type https://IPADDRESS:PORT into a browser on the same network and it will work. -### Default Credentials +## Default Credentials | Credential | Default Value | |----------|----------| |`WebUI Username`|admin | |`WebUI Password`|adminadmin | -## How to use OpenVPN +# How to use OpenVPN The container will fail to boot if `VPN_ENABLED` is set to yes or empty and a .ovpn is not present in the /config/openvpn directory. Drop a .ovpn file from your VPN provider into /config/openvpn and start the container again. You may need to edit the ovpn configuration file to load your VPN credentials from a file by setting `auth-user-pass`. **Note:** The script will use the first ovpn file it finds in the /config/openvpn directory. Adding multiple ovpn files will not start multiple VPN connections. -### Example auth-user-pass option +## Example auth-user-pass option `auth-user-pass credentials.conf` -### Example credentials.conf +## Example credentials.conf username
password @@ -85,20 +86,20 @@ User ID (PUID) and Group ID (PGID) can be found by issuing the following command id ``` -## Issues +# Issues If you are having issues with this container please submit an issue on GitHub. Please provide logs, docker version and other information that can simplify reproducing the issue. Using the latest stable verison of Docker is always recommended. Support for older version is on a best-effort basis. -## Building the container yourself +# Building the container yourself To build this container, clone the repository and cd into it. -### Build it: +## Build it: ``` $ cd /repo/location/qbittorrentvpn $ docker build -t qbittorrentvpn . ``` -### Run it: +## Run it: ``` $ docker run --privileged -d \ -v /your/config/path/:/config \