mirror of
https://github.com/MarkusMcNugen/docker-qBittorrentvpn
synced 2024-11-22 10:34:57 +00:00
Update README.md
This commit is contained in:
parent
1e4b521a30
commit
4b37057ef5
18
README.md
18
README.md
@ -20,12 +20,10 @@ $ docker run --privileged -d \
|
||||
markusmcnugen/qbittorrentvpn
|
||||
```
|
||||
|
||||
You must set the environment variables `OPENVPN_USERNAME` and `OPENVPN_PASSWORD` to provide basic connection details.
|
||||
|
||||
As you can see, the container also expects a downloads volume to be mounted.
|
||||
This is where qBittorrent will store your downloads, incomplete downloads and look for a watch directory for new .torrent files.
|
||||
This is where qBittorrent will store your downloads, incomplete downloads and/or a watch directory for new .torrent files.
|
||||
|
||||
### Required environment options
|
||||
### Environment Variables
|
||||
| Variable | Function | Example |
|
||||
|----------|----------|-------|
|
||||
|`VPN_ENABLED`|Enable VPN? (yes\|no) Default:yes|`VPN_ENABLED=yes`|
|
||||
@ -37,12 +35,22 @@ This is where qBittorrent will store your downloads, incomplete downloads and lo
|
||||
## Access the WebUI
|
||||
Access http://IPADDRESS:8080 from a browser on the same network.
|
||||
|
||||
### Default credentials
|
||||
### Default Credentials
|
||||
| Credential | Default Value |
|
||||
|----------|----------|
|
||||
|`WebUI Username`|admin |
|
||||
|`WebUI Password`|adminadmin |
|
||||
|
||||
## How to use OpenVPN
|
||||
The container will fail to boot if `VPN_ENABLED` is set to anything other than no 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. You may need to edit the ovpn configuration file to load your VPN credentials from a file by setting `auth-user-pass`.
|
||||
|
||||
### Example auth-user-pass option
|
||||
`auth-user-pass credentials.conf`
|
||||
|
||||
### Example credentials.conf
|
||||
username
|
||||
password
|
||||
|
||||
## PUID/PGID
|
||||
User ID (PUID) and Group ID (PGID) can be found by issuing the following command for the user you want to run the container as:-
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user