fix folder name + add VPNUNLIMITED in README
This commit is contained in:
71
README.md
71
README.md
@@ -92,7 +92,7 @@ By default a folder named transmission-home will also be created under /data, th
|
|||||||
This is a list of providers that are bundled within the image. Feel free to create an issue if your provider is not on the list, but keep in mind that some providers generate config files per user. This means that your login credentials are part of the config an can therefore not be bundled. In this case you can use the custom provider setup described later in this readme. The custom provider setting can be used with any provider.
|
This is a list of providers that are bundled within the image. Feel free to create an issue if your provider is not on the list, but keep in mind that some providers generate config files per user. This means that your login credentials are part of the config an can therefore not be bundled. In this case you can use the custom provider setup described later in this readme. The custom provider setting can be used with any provider.
|
||||||
|
|
||||||
| Provider Name | Config Value (`OPENVPN_PROVIDER`) |
|
| Provider Name | Config Value (`OPENVPN_PROVIDER`) |
|
||||||
|:-----------------------------|:-------------|
|
| :---------------------- | :-------------------------------- |
|
||||||
| Anonine | `ANONINE` |
|
| Anonine | `ANONINE` |
|
||||||
| AnonVPN | `ANONVPN` |
|
| AnonVPN | `ANONVPN` |
|
||||||
| BlackVPN | `BLACKVPN` |
|
| BlackVPN | `BLACKVPN` |
|
||||||
@@ -131,7 +131,7 @@ This is a list of providers that are bundled within the image. Feel free to crea
|
|||||||
| TigerVPN | `TIGER` |
|
| TigerVPN | `TIGER` |
|
||||||
| TorGuard | `TORGUARD` |
|
| TorGuard | `TORGUARD` |
|
||||||
| Trust.Zone | `TRUSTZONE` |
|
| Trust.Zone | `TRUSTZONE` |
|
||||||
| TunnelBear | `TUNNELBEAR`|
|
| TunnelBear | `TUNNELBEAR` |
|
||||||
| UsenetServerVPN | `USENETSERVER` |
|
| UsenetServerVPN | `USENETSERVER` |
|
||||||
| Windscribe | `WINDSCRIBE` |
|
| Windscribe | `WINDSCRIBE` |
|
||||||
| VPNArea.com | `VPNAREA` |
|
| VPNArea.com | `VPNAREA` |
|
||||||
@@ -141,21 +141,22 @@ This is a list of providers that are bundled within the image. Feel free to crea
|
|||||||
| VPNFacile | `VPNFACILE` |
|
| VPNFacile | `VPNFACILE` |
|
||||||
| VPNTunnel | `VPNTUNNEL` |
|
| VPNTunnel | `VPNTUNNEL` |
|
||||||
| VyprVpn | `VYPRVPN` |
|
| VyprVpn | `VYPRVPN` |
|
||||||
|
| VPNUnlimited | `VPNUNLIMITED` |
|
||||||
|
|
||||||
### Required environment options
|
### Required environment options
|
||||||
| Variable | Function | Example |
|
| Variable | Function | Example |
|
||||||
|----------|----------|-------|
|
| ------------------ | --------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
|`OPENVPN_PROVIDER` | Sets the OpenVPN provider to use. | `OPENVPN_PROVIDER=provider`. Supported providers and their config values are listed in the table above. |
|
| `OPENVPN_PROVIDER` | Sets the OpenVPN provider to use. | `OPENVPN_PROVIDER=provider`. Supported providers and their config values are listed in the table above. |
|
||||||
|`OPENVPN_USERNAME`|Your OpenVPN username |`OPENVPN_USERNAME=asdf`|
|
| `OPENVPN_USERNAME` | Your OpenVPN username | `OPENVPN_USERNAME=asdf` |
|
||||||
|`OPENVPN_PASSWORD`|Your OpenVPN password |`OPENVPN_PASSWORD=asdf`|
|
| `OPENVPN_PASSWORD` | Your OpenVPN password | `OPENVPN_PASSWORD=asdf` |
|
||||||
|
|
||||||
### Network configuration options
|
### Network configuration options
|
||||||
| Variable | Function | Example |
|
| Variable | Function | Example |
|
||||||
|----------|----------|-------|
|
| ------------------- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
|`OPENVPN_CONFIG` | Sets the OpenVPN endpoint to connect to. | `OPENVPN_CONFIG=UK Southampton`|
|
| `OPENVPN_CONFIG` | Sets the OpenVPN endpoint to connect to. | `OPENVPN_CONFIG=UK Southampton` |
|
||||||
|`OPENVPN_OPTS` | Will be passed to OpenVPN on startup | See [OpenVPN doc](https://openvpn.net/index.php/open-source/documentation/manuals/65-openvpn-20x-manpage.html) |
|
| `OPENVPN_OPTS` | Will be passed to OpenVPN on startup | See [OpenVPN doc](https://openvpn.net/index.php/open-source/documentation/manuals/65-openvpn-20x-manpage.html) |
|
||||||
|`LOCAL_NETWORK` | Sets the local network that should have access. Accepts comma separated list. | `LOCAL_NETWORK=192.168.0.0/24`|
|
| `LOCAL_NETWORK` | Sets the local network that should have access. Accepts comma separated list. | `LOCAL_NETWORK=192.168.0.0/24` |
|
||||||
|`CREATE_TUN_DEVICE` | Creates /dev/net/tun device inside the container, mitigates the need mount the device from the host | `CREATE_TUN_DEVICE=true`|
|
| `CREATE_TUN_DEVICE` | Creates /dev/net/tun device inside the container, mitigates the need mount the device from the host | `CREATE_TUN_DEVICE=true` |
|
||||||
|
|
||||||
### Firewall configuration options
|
### Firewall configuration options
|
||||||
When enabled, the firewall blocks everything except traffic to the peer port and traffic to the rpc port from the LOCAL_NETWORK and the internal docker gateway.
|
When enabled, the firewall blocks everything except traffic to the peer port and traffic to the rpc port from the LOCAL_NETWORK and the internal docker gateway.
|
||||||
@@ -163,26 +164,26 @@ When enabled, the firewall blocks everything except traffic to the peer port and
|
|||||||
If TRANSMISSION_PEER_PORT_RANDOM_ON_START is enabled then it allows traffic to the range of peer ports defined by TRANSMISSION_PEER_PORT_RANDOM_HIGH and TRANSMISSION_PEER_PORT_RANDOM_LOW.
|
If TRANSMISSION_PEER_PORT_RANDOM_ON_START is enabled then it allows traffic to the range of peer ports defined by TRANSMISSION_PEER_PORT_RANDOM_HIGH and TRANSMISSION_PEER_PORT_RANDOM_LOW.
|
||||||
|
|
||||||
| Variable | Function | Example |
|
| Variable | Function | Example |
|
||||||
|----------|----------|-------|
|
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
|
||||||
|`ENABLE_UFW` | Enables the firewall | `ENABLE_UFW=true`|
|
| `ENABLE_UFW` | Enables the firewall | `ENABLE_UFW=true` |
|
||||||
|`UFW_ALLOW_GW_NET` | Allows the gateway network through the firewall. Off defaults to only allowing the gateway. | `UFW_ALLOW_GW_NET=true`|
|
| `UFW_ALLOW_GW_NET` | Allows the gateway network through the firewall. Off defaults to only allowing the gateway. | `UFW_ALLOW_GW_NET=true` |
|
||||||
|`UFW_EXTRA_PORTS` | Allows the comma separated list of ports through the firewall. Respects UFW_ALLOW_GW_NET. | `UFW_EXTRA_PORTS=9910,23561,443`|
|
| `UFW_EXTRA_PORTS` | Allows the comma separated list of ports through the firewall. Respects UFW_ALLOW_GW_NET. | `UFW_EXTRA_PORTS=9910,23561,443` |
|
||||||
|`UFW_DISABLE_IPTABLES_REJECT` | Prevents the use of `REJECT` in the `iptables` rules, for hosts without the `ipt_REJECT` module (such as the Synology NAS). | `UFW_DISABLE_IPTABLES_REJECT=true`|
|
| `UFW_DISABLE_IPTABLES_REJECT` | Prevents the use of `REJECT` in the `iptables` rules, for hosts without the `ipt_REJECT` module (such as the Synology NAS). | `UFW_DISABLE_IPTABLES_REJECT=true` |
|
||||||
|
|
||||||
### Health check option
|
### Health check option
|
||||||
|
|
||||||
Because your VPN connection can sometimes fail, Docker will run a health check on this container every 5 minutes to see if the container is still connected to the internet. By default, this check is done by pinging google.com once. You change the host that is pinged.
|
Because your VPN connection can sometimes fail, Docker will run a health check on this container every 5 minutes to see if the container is still connected to the internet. By default, this check is done by pinging google.com once. You change the host that is pinged.
|
||||||
|
|
||||||
| Variable | Function | Example |
|
| Variable | Function | Example |
|
||||||
|----------|----------|-------|
|
| ------------------- | ------------------------------------------------------------------ | ------------ |
|
||||||
| `HEALTH_CHECK_HOST` | this host is pinged to check if the network connection still works | `google.com` |
|
| `HEALTH_CHECK_HOST` | this host is pinged to check if the network connection still works | `google.com` |
|
||||||
|
|
||||||
### Permission configuration options
|
### Permission configuration options
|
||||||
By default the startup script applies a default set of permissions and ownership on the transmission download, watch and incomplete directories. The GLOBAL_APPLY_PERMISSIONS directive can be used to disable this functionality.
|
By default the startup script applies a default set of permissions and ownership on the transmission download, watch and incomplete directories. The GLOBAL_APPLY_PERMISSIONS directive can be used to disable this functionality.
|
||||||
|
|
||||||
| Variable | Function | Example |
|
| Variable | Function | Example |
|
||||||
|----------|----------|-------|
|
| -------------------------- | -------------------------------------- | -------------------------------- |
|
||||||
|`GLOBAL_APPLY_PERMISSIONS` | Disable setting of default permissions | `GLOBAL_APPLY_PERMISSIONS=false`|
|
| `GLOBAL_APPLY_PERMISSIONS` | Disable setting of default permissions | `GLOBAL_APPLY_PERMISSIONS=false` |
|
||||||
|
|
||||||
### Alternative web UIs
|
### Alternative web UIs
|
||||||
You can override the default web UI by setting the ```TRANSMISSION_WEB_HOME``` environment variable. If set, Transmission will look there for the Web Interface files, such as the javascript, html, and graphics files.
|
You can override the default web UI by setting the ```TRANSMISSION_WEB_HOME``` environment variable. If set, Transmission will look there for the Web Interface files, such as the javascript, html, and graphics files.
|
||||||
@@ -190,9 +191,9 @@ You can override the default web UI by setting the ```TRANSMISSION_WEB_HOME``` e
|
|||||||
[Combustion UI](https://github.com/Secretmapper/combustion), [Kettu](https://github.com/endor/kettu) and [Transmission-Web-Control](https://github.com/ronggang/transmission-web-control/) come bundled with the container. You can enable either of them by setting```TRANSMISSION_WEB_UI=combustion```, ```TRANSMISSION_WEB_UI=kettu``` or ```TRANSMISSION_WEB_UI=transmission-web-control```, respectively. Note that this will override the ```TRANSMISSION_WEB_HOME``` variable if set.
|
[Combustion UI](https://github.com/Secretmapper/combustion), [Kettu](https://github.com/endor/kettu) and [Transmission-Web-Control](https://github.com/ronggang/transmission-web-control/) come bundled with the container. You can enable either of them by setting```TRANSMISSION_WEB_UI=combustion```, ```TRANSMISSION_WEB_UI=kettu``` or ```TRANSMISSION_WEB_UI=transmission-web-control```, respectively. Note that this will override the ```TRANSMISSION_WEB_HOME``` variable if set.
|
||||||
|
|
||||||
| Variable | Function | Example |
|
| Variable | Function | Example |
|
||||||
|----------|----------|-------|
|
| ----------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|`TRANSMISSION_WEB_HOME` | Set Transmission web home | `TRANSMISSION_WEB_HOME=/path/to/web/ui`|
|
| `TRANSMISSION_WEB_HOME` | Set Transmission web home | `TRANSMISSION_WEB_HOME=/path/to/web/ui` |
|
||||||
|`TRANSMISSION_WEB_UI` | Use the specified bundled web UI | `TRANSMISSION_WEB_UI=combustion`, `TRANSMISSION_WEB_UI=kettu` or `TRANSMISSION_WEB_UI=transmission-web-control`|
|
| `TRANSMISSION_WEB_UI` | Use the specified bundled web UI | `TRANSMISSION_WEB_UI=combustion`, `TRANSMISSION_WEB_UI=kettu` or `TRANSMISSION_WEB_UI=transmission-web-control` |
|
||||||
|
|
||||||
### Transmission configuration options
|
### Transmission configuration options
|
||||||
|
|
||||||
@@ -202,7 +203,7 @@ The environment variables are the same name as used in the transmission settings
|
|||||||
and follow the format given in these examples:
|
and follow the format given in these examples:
|
||||||
|
|
||||||
| Transmission variable name | Environment variable name |
|
| Transmission variable name | Environment variable name |
|
||||||
|----------------------------|---------------------------|
|
| -------------------------- | ------------------------------------- |
|
||||||
| `speed-limit-up` | `TRANSMISSION_SPEED_LIMIT_UP` |
|
| `speed-limit-up` | `TRANSMISSION_SPEED_LIMIT_UP` |
|
||||||
| `speed-limit-up-enabled` | `TRANSMISSION_SPEED_LIMIT_UP_ENABLED` |
|
| `speed-limit-up-enabled` | `TRANSMISSION_SPEED_LIMIT_UP_ENABLED` |
|
||||||
| `ratio-limit` | `TRANSMISSION_RATIO_LIMIT` |
|
| `ratio-limit` | `TRANSMISSION_RATIO_LIMIT` |
|
||||||
@@ -224,9 +225,9 @@ and would otherwise require root permissions to run.
|
|||||||
Remember to add a port binding for your selected (or default) port when starting the container.
|
Remember to add a port binding for your selected (or default) port when starting the container.
|
||||||
|
|
||||||
| Variable | Function | Example |
|
| Variable | Function | Example |
|
||||||
|----------|----------|-------|
|
| ------------------ | ----------------------- | ----------------------- |
|
||||||
|`WEBPROXY_ENABLED` | Enables the web proxy | `WEBPROXY_ENABLED=true`|
|
| `WEBPROXY_ENABLED` | Enables the web proxy | `WEBPROXY_ENABLED=true` |
|
||||||
|`WEBPROXY_PORT` | Sets the listening port | `WEBPROXY_PORT=8888` |
|
| `WEBPROXY_PORT` | Sets the listening port | `WEBPROXY_PORT=8888` |
|
||||||
|
|
||||||
### User configuration options
|
### User configuration options
|
||||||
|
|
||||||
@@ -234,9 +235,9 @@ By default everything will run as the root user. However, it is possible to chan
|
|||||||
You may set the following parameters to customize the user id that runs transmission.
|
You may set the following parameters to customize the user id that runs transmission.
|
||||||
|
|
||||||
| Variable | Function | Example |
|
| Variable | Function | Example |
|
||||||
|----------|----------|-------|
|
| -------- | ------------------------------------------- | ----------- |
|
||||||
|`PUID` | Sets the user id who will run transmission | `PUID=1003`|
|
| `PUID` | Sets the user id who will run transmission | `PUID=1003` |
|
||||||
|`PGID` | Sets the group id for the transmission user | `PGID=1003` |
|
| `PGID` | Sets the group id for the transmission user | `PGID=1003` |
|
||||||
|
|
||||||
### Dropping default route from iptables (advanced)
|
### Dropping default route from iptables (advanced)
|
||||||
|
|
||||||
@@ -256,12 +257,12 @@ To enable this feature, you'll need to mount the /scripts directory.
|
|||||||
Once /scripts is mounted you'll need to write your custom code in the following bash shell scripts:
|
Once /scripts is mounted you'll need to write your custom code in the following bash shell scripts:
|
||||||
|
|
||||||
| Script | Function |
|
| Script | Function |
|
||||||
|----------|----------|
|
| ----------------------------------- | ------------------------------------------------------------ |
|
||||||
|/scripts/openvpn-pre-start.sh | This shell script will be executed before openvpn start |
|
| /scripts/openvpn-pre-start.sh | This shell script will be executed before openvpn start |
|
||||||
|/scripts/transmission-pre-start.sh | This shell script will be executed before transmission start |
|
| /scripts/transmission-pre-start.sh | This shell script will be executed before transmission start |
|
||||||
|/scripts/transmission-post-start.sh | This shell script will be executed after transmission start |
|
| /scripts/transmission-post-start.sh | This shell script will be executed after transmission start |
|
||||||
|/scripts/transmission-pre-stop.sh | This shell script will be executed before transmission stop |
|
| /scripts/transmission-pre-stop.sh | This shell script will be executed before transmission stop |
|
||||||
|/scripts/transmission-post-stop.sh | This shell script will be executed after transmission stop |
|
| /scripts/transmission-post-stop.sh | This shell script will be executed after transmission stop |
|
||||||
|
|
||||||
Don't forget to include the #!/bin/bash shebang and to make the scripts executable using chmod a+x
|
Don't forget to include the #!/bin/bash shebang and to make the scripts executable using chmod a+x
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user