{"id":13558598,"url":"https://github.com/binhex/arch-rtorrentvpn","last_synced_at":"2025-04-03T13:31:40.151Z","repository":{"id":37336688,"uuid":"52789138","full_name":"binhex/arch-rtorrentvpn","owner":"binhex","description":"Docker build script for Arch Linux base with ruTorrent, rTorrent, autodl-irssi, Privoxy and OpenVPN","archived":true,"fork":false,"pushed_at":"2023-02-20T20:19:11.000Z","size":365,"stargazers_count":239,"open_issues_count":33,"forks_count":36,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-11-04T09:37:27.248Z","etag":null,"topics":["autodl-irssi","docker-image","downloader","flood","openvpn","privoxy","rtorrent","rutorrent","torrents","vpn"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/binhex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-02-29T12:24:23.000Z","updated_at":"2024-10-03T17:49:34.000Z","dependencies_parsed_at":"2024-01-07T22:49:38.116Z","dependency_job_id":"adbe4446-9bcf-4e34-8377-89c831c306bc","html_url":"https://github.com/binhex/arch-rtorrentvpn","commit_stats":null,"previous_names":[],"tags_count":181,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binhex%2Farch-rtorrentvpn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binhex%2Farch-rtorrentvpn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binhex%2Farch-rtorrentvpn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binhex%2Farch-rtorrentvpn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/binhex","download_url":"https://codeload.github.com/binhex/arch-rtorrentvpn/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247009644,"owners_count":20868583,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autodl-irssi","docker-image","downloader","flood","openvpn","privoxy","rtorrent","rutorrent","torrents","vpn"],"created_at":"2024-08-01T12:05:03.252Z","updated_at":"2025-04-03T13:31:39.893Z","avatar_url":"https://github.com/binhex.png","language":"Shell","funding_links":["https://www.paypal.com/en_US/i/btn/btn_donate_SM.gif","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=MM5E27UX6AUU4"],"categories":["Shell","\u003ca id=\"d62a971d37c69db9f3b9187318c3921a\"\u003e\u003c/a\u003e工具","Shell (473)","others"],"sub_categories":["\u003ca id=\"8ea8f890cf767c3801b5e7951fca3570\"\u003e\u003c/a\u003e公网访问局域网"],"readme":"**NOTICE**\n\nThis image is now deprecated and will no longer be maintained - 14/02/2023\n\n**Application**\n\n[rTorrent-ps](https://github.com/pyroscope/rtorrent-ps)\u003cbr/\u003e\n[ruTorrent](https://github.com/Novik/ruTorrent)\u003cbr/\u003e\n[autodl-irssi](https://github.com/autodl-community/autodl-irssi)\u003cbr/\u003e\n[Privoxy](http://www.privoxy.org/)\u003cbr/\u003e\n[OpenVPN](https://openvpn.net/)\u003cbr/\u003e\n[WireGuard](https://www.wireguard.com/)\n\n**Description**\n\nrTorrent is a quick and efficient BitTorrent client that uses, and is in development alongside, the libTorrent (not to be confused with libtorrent-rasterbar) library. It is written in C++ and uses the ncurses programming library, which means it uses a text user interface. When combined with a terminal multiplexer (e.g. GNU Screen or Tmux) and Secure Shell, it becomes a convenient remote BitTorrent client, this Docker image includes the popular ruTorrent web frontend to rTorrent for ease of use.\u003cbr/\u003e\n\nThis Docker includes OpenVPN and WireGuard to ensure a secure and private connection to the Internet, including use of iptables to prevent IP leakage when the tunnel is down. It also includes Privoxy to allow unfiltered access to index sites, to use Privoxy please point your application at `http://\u003chost ip\u003e:8118`.\n\n**Build notes**\n\nLatest stable rTorrent-ps release from Arch Linux AUR.\u003cbr/\u003e\nLatest stable ruTorrent release from Arch Linux AUR.\u003cbr/\u003e\nLatest stable Privoxy release from Arch Linux repo.\u003cbr/\u003e\nLatest stable OpenVPN release from Arch Linux repo.\u003cbr/\u003e\nLatest stable WireGuard release from Arch Linux repo.\n\n**!!! IMPORTANT !!!**\n\nAs from 15th of January 2020, if the web ui and/or rpc2 password have not been defined (defined via environment variables) then the password(s) will be randomised and no longer set to 'rutorrent'.\n\nPlease see link below to the rtorrentvpn FAQ, Q3. and Q4. for more details:-\nhttps://github.com/binhex/documentation/blob/master/docker/faq/rtorrentvpn.md\n\n**Usage**\n```\ndocker run -d \\\n    --cap-add=NET_ADMIN \\\n    -p 9080:9080 \\\n    -p 9443:9443 \\\n    -p 8118:8118 \\\n    --name=\u003ccontainer name\u003e \\\n    -v \u003cpath for data files\u003e:/data \\\n    -v \u003cpath for config files\u003e:/config \\\n    -v /etc/localtime:/etc/localtime:ro \\\n    -e VPN_ENABLED=\u003cyes|no\u003e \\\n    -e VPN_USER=\u003cvpn username\u003e \\\n    -e VPN_PASS=\u003cvpn password\u003e \\\n    -e VPN_PROV=\u003cpia|airvpn|custom\u003e \\\n    -e VPN_CLIENT=\u003copenvpn|wireguard\u003e \\\n    -e VPN_OPTIONS=\u003cadditional openvpn cli options\u003e \\\n    -e STRICT_PORT_FORWARD=\u003cyes|no\u003e \\\n    -e ENABLE_PRIVOXY=\u003cyes|no\u003e \\\n    -e ENABLE_AUTODL_IRSSI=\u003cyes|no\u003e \\\n    -e ENABLE_RPC2=\u003cyes|no\u003e \\\n    -e ENABLE_RPC2_AUTH=\u003cyes|no\u003e \\\n    -e ENABLE_WEBUI_AUTH=\u003cyes|no\u003e \\\n    -e RPC2_USER=\u003crpc2 username\u003e \\\n    -e RPC2_PASS=\u003crpc2 password\u003e \\\n    -e WEBUI_USER=\u003cwebui username\u003e \\\n    -e WEBUI_PASS=\u003cwebui password\u003e \\\n    -e LAN_NETWORK=\u003clan ipv4 network\u003e/\u003ccidr notation\u003e \\\n    -e NAME_SERVERS=\u003cname server ip(s)\u003e \\\n    -e VPN_INPUT_PORTS=\u003cport number(s)\u003e \\\n    -e VPN_OUTPUT_PORTS=\u003cport number(s)\u003e \\\n    -e DEBUG=\u003ctrue|false\u003e \\\n    -e PHP_TZ=\u003cphp timezone\u003e \\\n    -e UMASK=\u003cumask for created files\u003e \\\n    -e PUID=\u003cuid for user\u003e \\\n    -e PGID=\u003cgid for user\u003e \\\n    binhex/arch-rtorrentvpn\n```\n\u0026nbsp;\nPlease replace all user variables in the above command defined by \u003c\u003e with the correct values.\n\n**Access ruTorrent (web ui)**\n\n`http://\u003chost ip\u003e:9080/`\n\nor\n\n`https://\u003chost ip\u003e:9443/`\n\nUsername:- Value of 'WEBUI_USER'\u003cbr/\u003e\nPassword:- Value of 'WEBUI_PASS'\n\n**Access Privoxy**\n\n`http://\u003chost ip\u003e:8118`\n\n**PIA example**\n```\ndocker run -d \\\n    --cap-add=NET_ADMIN \\\n    -p 9080:9080 \\\n    -p 9443:9443 \\\n    -p 8118:8118 \\\n    --name=rtorrentvpn \\\n    -v /root/docker/data:/data \\\n    -v /root/docker/config:/config \\\n    -v /etc/localtime:/etc/localtime:ro \\\n    -e VPN_ENABLED=yes \\\n    -e VPN_USER=myusername \\\n    -e VPN_PASS=mypassword \\\n    -e VPN_PROV=pia \\\n    -e VPN_CLIENT=openvpn \\\n    -e STRICT_PORT_FORWARD=yes \\\n    -e ENABLE_PRIVOXY=yes \\\n    -e ENABLE_AUTODL_IRSSI=yes \\\n    -e ENABLE_RPC2=yes \\\n    -e ENABLE_RPC2_AUTH=yes \\\n    -e ENABLE_WEBUI_AUTH=yes \\\n    -e RPC2_USER=admin \\\n    -e RPC2_PASS=NzRhMjE4NjUzZDYw \\\n    -e WEBUI_USER=admin \\\n    -e WEBUI_PASS=NzRhMjE4NjUzZDYw \\\n    -e LAN_NETWORK=192.168.1.0/24 \\\n    -e NAME_SERVERS=84.200.69.80,37.235.1.174,1.1.1.1,37.235.1.177,84.200.70.40,1.0.0.1 \\\n    -e VPN_INPUT_PORTS=1234 \\\n    -e VPN_OUTPUT_PORTS=5678 \\\n    -e DEBUG=false \\\n    -e PHP_TZ=UTC \\\n    -e UMASK=000 \\\n    -e PUID=0 \\\n    -e PGID=0 \\\n    binhex/arch-rtorrentvpn\n```\n\u0026nbsp;\n**AirVPN provider**\n\nAirVPN users will need to generate a unique OpenVPN configuration file by using the following link https://airvpn.org/generator/\n\n1. Please select Linux and then choose the country you want to connect to\n2. Save the ovpn file to somewhere safe\n3. Start the rtorrentvpn docker to create the folder structure\n4. Stop rtorrentvpn docker and copy the saved ovpn file to the /config/openvpn/ folder on the host\n5. Start rtorrentvpn docker\n6. Check supervisor.log to make sure you are connected to the tunnel\n\nAirVPN users will also need to create a port forward by using the following link https://airvpn.org/ports/ and clicking Add. This port will need to be specified in the rTorrent-ps configuration file located at /config/rtorrent/config/rtorrent.rc with the option `port_range = \u003cstart incoming port\u003e-\u003cend incoming port\u003e` and `port_random = no`.\n\nrTorrent-ps example config\n```\nport_range = 49400-49400\nport_random = no\n```\n\u0026nbsp;\n**AirVPN example**\n```\ndocker run -d \\\n    --cap-add=NET_ADMIN \\\n    -p 9080:9080 \\\n    -p 9443:9443 \\\n    -p 8118:8118 \\\n    --name=rtorrentvpn \\\n    -v /root/docker/data:/data \\\n    -v /root/docker/config:/config \\\n    -v /etc/localtime:/etc/localtime:ro \\\n    -e VPN_ENABLED=yes \\\n    -e VPN_PROV=airvpn \\\n    -e VPN_CLIENT=openvpn \\\n    -e ENABLE_PRIVOXY=yes \\\n    -e ENABLE_AUTODL_IRSSI=yes \\\n    -e ENABLE_RPC2=yes \\\n    -e ENABLE_RPC2_AUTH=yes \\\n    -e ENABLE_WEBUI_AUTH=yes \\\n    -e RPC2_USER=admin \\\n    -e RPC2_PASS=NzRhMjE4NjUzZDYw \\\n    -e WEBUI_USER=admin \\\n    -e WEBUI_PASS=NzRhMjE4NjUzZDYw \\\n    -e LAN_NETWORK=192.168.1.0/24 \\\n    -e NAME_SERVERS=84.200.69.80,37.235.1.174,1.1.1.1,37.235.1.177,84.200.70.40,1.0.0.1 \\\n    -e VPN_INPUT_PORTS=1234 \\\n    -e VPN_OUTPUT_PORTS=5678 \\\n    -e DEBUG=false \\\n    -e PHP_TZ=UTC \\\n    -e UMASK=000 \\\n    -e PUID=0 \\\n    -e PGID=0 \\\n    binhex/arch-rtorrentvpn\n```\n\u0026nbsp;\n\n**IMPORTANT**\u003cbr/\u003e\nPlease note 'VPN_INPUT_PORTS' is **NOT** to define the incoming port for the VPN, this environment variable is used to define port(s) you want to allow in to the VPN network when network binding multiple containers together, configuring this incorrectly with the VPN provider assigned incoming port COULD result in IP leakage, you have been warned!.\n\n**OpenVPN**\u003cbr/\u003e\nPlease note this Docker image does not include the required OpenVPN configuration file and certificates. These will typically be downloaded from your VPN providers website (look for OpenVPN configuration files), and generally are zipped.\n\nPIA users - The URL to download the OpenVPN configuration files and certs is:-\n\nhttps://www.privateinternetaccess.com/openvpn/openvpn.zip\n\nOnce you have downloaded the zip (normally a zip as they contain multiple ovpn files) then extract it to /config/openvpn/ folder (if that folder doesn't exist then start and stop the docker container to force the creation of the folder).\n\nIf there are multiple ovpn files then please delete the ones you don't want to use (normally filename follows location of the endpoint) leaving just a single ovpn file and the certificates referenced in the ovpn file (certificates will normally have a crt and/or pem extension).\n\n**WireGuard**\u003cbr/\u003e\nIf you wish to use WireGuard (defined via 'VPN_CLIENT' env var value ) then due to the enhanced security and kernel integration WireGuard will require the container to be defined with privileged permissions and sysctl support, so please ensure you change the following docker options:-  \u003cbr/\u003e\n\nfrom\n```\n    --cap-add=NET_ADMIN \\\n```\nto\n```\n    --sysctl=\"net.ipv4.conf.all.src_valid_mark=1\" \\\n    --privileged=true \\\n```\n\nPIA users - The WireGuard configuration file will be auto generated and will be stored in ```/config/wireguard/wg0.conf``` AFTER the first run, if you wish to change the endpoint you are connecting to then change the ```Endpoint``` line in the config file (default is Netherlands).\n\nOther users - Please download your WireGuard configuration file from your VPN provider, start and stop the container to generate the folder ```/config/wireguard/``` and then place your WireGuard configuration file in there.\n\n**Notes**\u003cbr/\u003e\nDue to Google and OpenDNS supporting EDNS Client Subnet it is recommended NOT to use either of these NS providers.\nThe list of default NS providers in the above example(s) is as follows:-\n\n84.200.x.x = DNS Watch\n37.235.x.x = FreeDNS\n1.x.x.x = Cloudflare\n\nUser ID (PUID) and Group ID (PGID) can be found by issuing the following command for the user you want to run the container as:-\n\n`id \u003cusername\u003e`\n\nIf you want to create an additional user account for ruTorrent webui then please execute the following on the host:-\n\n`docker exec -it \u003ccontainer name\u003e /home/nobody/createuser.sh \u003cusername to create\u003e \u003cpassword for the user\u003e`\n\nIf you want to delete a user account (or change the password for an account) then please execute the following on the host:-\n\n`docker exec -it \u003ccontainer name\u003e /home/nobody/deluser.sh \u003cusername to delete\u003e`\n\nIf you do not define the PHP timezone you may see issues with the ruTorrent Scheduler plugin, please make sure you set the PHP timezone by specifying this using the environment variable PHP_TZ. Valid timezone values can be found here, http://php.net/manual/en/timezones.php\n___\nIf you appreciate my work, then please consider buying me a beer  :D\n\n[![PayPal donation](https://www.paypal.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=MM5E27UX6AUU4)\n\n[Documentation](https://github.com/binhex/documentation) | [Support forum](http://forums.unraid.net/index.php?topic=47832.0)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinhex%2Farch-rtorrentvpn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbinhex%2Farch-rtorrentvpn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinhex%2Farch-rtorrentvpn/lists"}