diff --git a/DockerEnv b/DockerEnv new file mode 100644 index 000000000..ef6310375 --- /dev/null +++ b/DockerEnv @@ -0,0 +1,78 @@ +#Remove # for variables you want to use +#OPENVPN_PROVIDER= +#OPENVPN_CONFIG= +#OPENVPN_USERNAME= +#OPENVPN_PASSWORD= +#LOCAL_NETWORK= +#TRANSMISSION_ALT_SPEED_DOWN=50 +#TRANSMISSION_ALT_SPEED_ENABLED=false +#TRANSMISSION_ALT_SPEED_TIME_BEGIN=540 +#TRANSMISSION_ALT_SPEED_TIME_DAY=127 +#TRANSMISSION_ALT_SPEED_TIME_ENABLED=false +#TRANSMISSION_ALT_SPEED_TIME_END=1020 +#TRANSMISSION_ALT_SPEED_UP=50 +#TRANSMISSION_BIND_ADDRESS_IPV4=0.0.0.0 +#TRANSMISSION_BIND_ADDRESS_IPV6=:: +#TRANSMISSION_BLOCKLIST_ENABLED=false +#TRANSMISSION_BLOCKLIST_URL=http://www.example.com/blocklist +#TRANSMISSION_CACHE_SIZE_MB=4 +#TRANSMISSION_DHT_ENABLED=true +#TRANSMISSION_DOWNLOAD_DIR=/data/completed +#TRANSMISSION_DOWNLOAD_LIMIT=100 +#TRANSMISSION_DOWNLOAD_LIMIT_ENABLED=0 +#TRANSMISSION_DOWNLOAD_QUEUE_ENABLED=true +#TRANSMISSION_DOWNLOAD_QUEUE_SIZE=5 +#TRANSMISSION_ENCRYPTION=1 +#TRANSMISSION_IDLE_SEEDING_LIMIT=30 +#TRANSMISSION_IDLE_SEEDING_LIMIT_ENABLED=false +#TRANSMISSION_INCOMPLETE_DIR=/data/incomplete +#TRANSMISSION_INCOMPLETE_DIR_ENABLED=true +#TRANSMISSION_LPD_ENABLED=false +#TRANSMISSION_MAX_PEERS_GLOBAL=200 +#TRANSMISSION_MESSAGE_LEVEL=2 +#TRANSMISSION_PEER_CONGESTION_ALGORITHM= +#TRANSMISSION_PEER_ID_TTL_HOURS=6 +#TRANSMISSION_PEER_LIMIT_GLOBAL=200 +#TRANSMISSION_PEER_LIMIT_PER_TORRENT=50 +#TRANSMISSION_PEER_PORT=51413 +#TRANSMISSION_PEER_PORT_RANDOM_HIGH=65535 +#TRANSMISSION_PEER_PORT_RANDOM_LOW=49152 +#TRANSMISSION_PEER_PORT_RANDOM_ON_START=false +#TRANSMISSION_PEER_SOCKET_TOS=default +#TRANSMISSION_PEX_ENABLED=true +#TRANSMISSION_PORT_FORWARDING_ENABLED=false +#TRANSMISSION_PREALLOCATION=1 +#TRANSMISSION_PREFETCH_ENABLED=1 +#TRANSMISSION_QUEUE_STALLED_ENABLED=true +#TRANSMISSION_QUEUE_STALLED_MINUTES=30 +#TRANSMISSION_RATIO_LIMIT=2 +#TRANSMISSION_RATIO_LIMIT_ENABLED=false +#TRANSMISSION_RENAME_PARTIAL_FILES=true +#TRANSMISSION_RPC_AUTHENTICATION_REQUIRED=false +#TRANSMISSION_RPC_BIND_ADDRESS=0.0.0.0 +#TRANSMISSION_RPC_ENABLED=true +#TRANSMISSION_RPC_PASSWORD=password +#TRANSMISSION_RPC_PORT=9091 +#TRANSMISSION_RPC_URL=/transmission/ +#TRANSMISSION_RPC_USERNAME=username +#TRANSMISSION_RPC_WHITELIST=127.0.0.1 +#TRANSMISSION_RPC_WHITELIST_ENABLED=false +#TRANSMISSION_SCRAPE_PAUSED_TORRENTS_ENABLED=true +#TRANSMISSION_SCRIPT_TORRENT_DONE_ENABLED=false +#TRANSMISSION_SCRIPT_TORRENT_DONE_FILENAME= +#TRANSMISSION_SEED_QUEUE_ENABLED=false +#TRANSMISSION_SEED_QUEUE_SIZE=10 +#TRANSMISSION_SPEED_LIMIT_DOWN=100 +#TRANSMISSION_SPEED_LIMIT_DOWN_ENABLED=false +#TRANSMISSION_SPEED_LIMIT_UP=100 +#TRANSMISSION_SPEED_LIMIT_UP_ENABLED=false +#TRANSMISSION_START_ADDED_TORRENTS=true +#TRANSMISSION_TRASH_ORIGINAL_TORRENT_FILES=false +#TRANSMISSION_UMASK=2 +#TRANSMISSION_UPLOAD_LIMIT=100 +#TRANSMISSION_UPLOAD_LIMIT_ENABLED=0 +#TRANSMISSION_UPLOAD_SLOTS_PER_TORRENT=14 +#TRANSMISSION_UTP_ENABLED=true +#TRANSMISSION_WATCH_DIR=/data/watch +#TRANSMISSION_WATCH_DIR_ENABLED=true +#TRANSMISSION_HOME=/data/transmission-home \ No newline at end of file diff --git a/README.md b/README.md index 3fd2f0007..0ada5a697 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,24 @@ As you can see the variables are prefixed with `TRANSMISSION_`, the variable is PS: `TRANSMISSION_BIND_ADDRESS_IPV4` will be overridden to the IP assigned to your OpenVPN tunnel interface. This is to prevent leaking the host IP. +#### Use docker env file +Another way is to use a docker env file where you can easily store all your env variables and maintain multiple configurations for different providers. +In the GitHub repository there is a provided DockerEnv file with all the current transmission and openvpn environment variables. You can use this to create local configurations +by filling in the details and removing the # of the ones you want to use. + +Please note that if you pass in env. variables on the command line these will override the ones in the env file. + +See explanation of variables above. +To use this env file, use the following to run the docker image: +``` +$ docker run --privileged -d \ + -v /your/storage/path/:/data \ + -v /etc/localtime:/etc/localtime:ro \ + -env-file /your/docker/env/file \ + -p 9091:9091 \ + haugene/transmission-openvpn +``` + ### User configuration options By default everything will run as the root user. However, it is possible to change who runs the transmission process.