From 3fdf8e07a76c12d099fcc92ff5ae93a5125d1cd9 Mon Sep 17 00:00:00 2001 From: Kristian Haugene Date: Sun, 21 Oct 2018 19:01:51 +0200 Subject: [PATCH] Update README --- README.md | 35 ++++++++++++++++++++++------------- images/digitalocean.png | Bin 0 -> 3110 bytes images/patreon.png | Bin 0 -> 2307 bytes 3 files changed, 22 insertions(+), 13 deletions(-) create mode 100644 images/digitalocean.png create mode 100644 images/patreon.png diff --git a/README.md b/README.md index be8161dbc..c1b38f6fe 100644 --- a/README.md +++ b/README.md @@ -13,23 +13,31 @@ You need to specify your provider and credentials with environment variables, as well as mounting volumes where the data should be stored. An example run command to get you going is provided below. -Also worth mentioning. -If you want to route web traffic through the same tunnel that Transmission is using there -is a pre-installed Tinyproxy which will expose a proxy on port 8888 when enabled. -And if you're using PIA as provider it will update Transmission hourly with assigned open port (if the port forwarding feature is available in the selected region). +It also bundles an installation of Tinyproxy to also be able to proxy web traffic over your VPN, +as well as scripts for opening a port for Transmission if you are using PIA or Perfect Privacy providers. -GL HF! And if you run into problems, please check the README twice and maybe try the gitter chat before opening an issue :) +GL HF! And if you run into problems, please check the README twice and try the gitter chat before opening an issue :) -### about:maintenance +## Please help out (about:maintenance) -This image was created for my own use, but sharing is caring so it had to be open source. -The number of users, issues and pull-requests have gone up quite drastically since that -and that's great! It's been a lot of fun watching the activity level go up -and my pet project improve with it. +This image was created for my own use, but sharing is caring, so it had to be open source. +It has now gotten quite popular, and that's great! But keeping it up to date, providing support, fixes +and new features takes a lot of time. -But maintaining it takes time, and if you ever feel like donating, here's a button: +I'm therefore kindly asking you to donate if you feel like you're getting a good tool +and you're able to spare some dollars to keep it functioning as it should. There's a couple of ways to do it: -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=73XHRSK65KQYC) +Become a patron, supporting the project with a small monthly amount. + +[![Donate with Patreon](images/patreon.png)](https://www.patreon.com/haugene) + +Make a one time donation through PayPal. + +[![Donate with PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=73XHRSK65KQYC) + +Or use this referral code to DigitalOcean and get 25$ in credits, if you're interested in a cloud setup. + +[![Credits on DigitalOcean](images/digitalocean.png)](https://m.do.co/c/ca994f1552bc) You can also help out by submitting pull-requests or helping others with open issues or in the gitter chat. A big thanks to everyone who has contributed so far! @@ -198,7 +206,8 @@ This is to prevent leaking the host IP. This container also contains a web-proxy server to allow you to tunnel your web-browser traffic through the same OpenVPN tunnel. This is useful if you are using a private tracker that needs to see you login from the same IP address you are torrenting from. The default listening port is 8888. Note that only ports above 1024 can be specified as all ports below 1024 are privileged -and would otherwise require root permissions to run. +and would otherwise require root permissions to run. +Remember to add a port binding for your selected (or default) port when starting the container. | Variable | Function | Example | |----------|----------|-------| diff --git a/images/digitalocean.png b/images/digitalocean.png new file mode 100644 index 0000000000000000000000000000000000000000..a7b350bcb77f2526b509a1f455a67384c3ccf573 GIT binary patch literal 3110 zcmV+>4B7LEP)00004XF*Lt006O% z3;baP0000WV@Og>004R>004l5008;`004mK004C`008P>0026e000+ooVrmw00006 zVoOIv0RI600RN!9r;`8x00(qQO+^Rd3Ka|`5~zRo?f?J_DoI2^R9M69n0t^_)s@D7 zd!KXeyYKDSZC=f*<--gU`xHiWmx#&_2+%ctsRb6~asq zV+@H^5f#HIAi|7BNt9QJ(6niqHx0L;``+%pk8{u2YyP+mh_mEC!WfsH=o+-&B9OrAq+%ApGhz!oJhc zHXo9U8J_o;q+ukAkP%MXnmrXEb{#xRW@tGao_mS({|i3ER-#cT4^f%Qakp!@#TV)X z>~k+G=&}`WMQoN&?9b*S9hl}zr2oaZh^b*q1y|^QroalED(vwSsOb(2cj5rp=f)H__^AveeQ0l`$yMC>(@c*YlM(e zqyw7O{X#sE7lx&>Y>HT{>1?2(ZUwkSFg}z=ODgWnVxQ{aNdprSL9U703`iH5Iw;OF zL5EJyhg1)E9w-aSg3!`IScI2j4kyz;;Om2y(!Zm?qN3r8O5p<92+GksT@~P=x^g;` z3E15Rc^3>&8HIiKC?>8Fj-^2fC=El(Vf!755i3gBt5j+Hsyb*%l`=8sLe>SNVcY=N zc=N>p)#om%qo|zE7k!8;C`N6TrVp^`%GF5s{fg8A#V0O~`2DDQAC>djV)Zr#u@jrQwhE$%JgUV=4MwuH6@vG5~!j$1CpjKd{qlqi18Js{> zMOc{((@+~HlPPjt#^r(TB9|K>va1CYR0(_x7&vPZ$~TAsWdwD@&k1(qd9YykLcn5C zb%d)cLtGQI_-WDSj!u_3K^wik2^>vCU=%QPSUJ|U7HdP`Hby#;C(3)Nw4 zU^v1kTM_-Qy&ysup$4b{>NQku+yx@icS(7+nXqRVr%Houi2xgiPl7%7T!_#cvwE-R z$eCCbn_Qo%K2&rS83pX_D}@S%lnBj5L-WWuyPDF}yM`H=0-Mr#zUd0TsxRZf^LvI$0zzUclXUkmu?W zEQvRAQ{M1x1!cg#>Ns;19NXPSqc2MFjY=CY$t zg`dsh#~q%k4zQpy$iirlla>SHR|ykV37=eZAyPL_0n6r8FZ~vZ_@60T`ovsCPXqj6 z3295wj|Nv&!D1VRC$m?VT;$aqC4iW zs?1>zivEsfUo6N1OL3@RnCA-v0YM>!B104eqYhiw>_t-Z6{+tjPWIqhimgCZ)?;MG zFPC57_#%a$K16{qYp_bS;FJR&uOnuJm{y1}bOHr{XJ$b3VFpVn zVxFbw_;Zb7_RGSE6>!UP>}Q)vDn*Z!>Zt+5gGmCpM1UW56le`v1PUHM>g_TDFtmze z2Tt*J&gU}~Wjxo>#letGMR$?wG6iNSsP=_eN1n3Yil%IfjDQq8YFlzJZlxdse|Q(l z`ZEN`7kny;!sMvUih{>8?lze5E$sFCxy?Y07{+$F)GCN5;R<6wEA|yUt}Q^ofCco| zij)JL1H!C6c$gir8ou1)Gx*J8=NSEf!da!LuOrs4AHzltql~4BeJN%(wewn2ip>Yw znKE^?kX$4TTFPM8@VVXz+T#vQeG#nyTfq~bLD`z<^DW$16h7f7wgoil-d9A!Ss>iw zQ8zG7$TN(P(ubUf>!Ex>3uxcR`BW{Tt^x~PL%pMU!B!lh)ZflE5uJ>%S1bOQ^Z9mF zhzVoLv1&p%6$6=;^_is=Z#WhQ6!;=kxDUXUUm>)!l_8eGC~%_=uapING8SN2Jiw!8 z3QWrREU+{O9E&YVQGDNu*4PRoPk>Sw0V$e`Ik{+An9lOKjslO0VZM4me&PBgfsZL5 z=o9^I6AZ3lV0(^6Pq+fW(QFzJ=e@&y^KChbnTbXw=MA++80#p0UmoDcMT7L(x1$!X zWQ*L^Q{+GLX%2eA1WTP?LTSLt7Qq)zijX*-Vd?80D}kT_Who-Ap`v#_MJZVJ&TrA4 zXypE^&#I0BFRW|kEg;|vQ#2fp**r2XN%QMRcrouYEBFwBooA?4!llJ(!lE| ze!u4=Dzl9(@gO%jn&(l}qNogLep(UWt7ne0yFH7S46!g|u@absqDEV+v@}~|4tHCM zHY0o%#WAf|KOn-ZL5mfhVVppvQamrPSKu&;4Fa8hDb0Qdys1m&?IIPP#|^&}%Lw*M z%{*>|+p7aCo;sXHUvRb_WNp^x^XL9;LrcVFPI>{qfe-H#2P_lSp2hMEswRT8&BIp> zNNoa=VMx2E6Wv%v!3>Hp{8Wxrw&o25O|D@!f*w-F=l|4AM^K^q$M6aTX!|7$y%oFY zV@{mHOsOa28PxL0 zJ8Zc{v7y(|RD)vr&xA8Mx(gmm7zsP?Qrz{D@b(EjpzBZ?4t^Kv5{l)OA_Coe+MuTh zLHoRNjRv}kfWjAg9r`GRpTqS}O2|?K9E-xQXR5*tYejEtVVV(=QHT9wlkDGq4ENKQ z!TN9f^;_d1ONCvtQ4@bcKdlJ|747?u()ESWu>SUctb;MTuR$w7UPIo#@YDcXJOjRg zjsoN#==;Fw|AQm*6w{(20&UVO(@$Lv>u>$XBKs2l4)|YHfzP@>nuSaN001R)MObuX zVRU6WV{&C-bY%cCFflkSF)%GMF;p=!Ix{yqF*q$SG&(Ra{2EXx0000bbVXQnWMOn= zI&E)cX=Zrh($07*qoM6N<$f=*YY AUH||9 literal 0 HcmV?d00001 diff --git a/images/patreon.png b/images/patreon.png new file mode 100644 index 0000000000000000000000000000000000000000..6ef465b421972228afe7fe4e0c22ed847fe5fa64 GIT binary patch literal 2307 zcmV+e3H004R>004l5008;`004mK004C`008P>0026e000+ooVrmw00006 zVoOIv0RI600RN!9r;`8x00(qQO+^Rd3Ka|#Dn=kk!TSt>5CRBXaI%C0NPYZ9R(GJQl&6}f{G77@PQOZ9bZM1p{O5JpeiaTqM}kn#s_M7 zsh|U+1GOL$v4L8F@D3J;VrhZ4$vu8p>n7)>d9;4PQP<3woO93G>#X(PYp?a+JB5n$ zEo^VxPQiS<39rWPXu~tO4=eF=T#xn8eqEnuLpnOUrr?F>@9pV+^jUFY8>H5_>08*Y ztQD{yF2-dz2`?64!*j3?-i7by^_s@`XG!MZn)K;EURoIftEH%y$K$iuE#E(iZmh-= zm>~e4hv(sFyb_BE#cXW0QKa}*|v4#F*?1JsLHTWjm z6ZkSxcRc-$Ir~zK9%J#)VY{f+%K|6htC*SKULrDmwJ0Uk0QbQ=MOMwiI(!V@ML8Pi z%?=mJvR)KLQI6$&RllGp3#D@SeQ!^9L+4ev0ZYZik1J(asC-sIQKu|4+a3$(7+p3Q z=v~!4>Vy;&B~39Fnce&0a_owS61<;ba2(%Ta1_oJHS}+I3vL_PpTKx$~IAc*C&pLiz@H{uExz6EczCDQ#x zUyUUt%Zr$}UnK~G7{J3=ELQ8~>F+5C#@F%rw7m$^GM3hg?K5y?Z%=obfbT0-&%t7) zZ^(&m&3HeNleiatk%>49Q!}<{q5_=GfVZ*Yq57 zhgj_g;_bO=K7-?0GoTq_`F+oD896+G+_{p?(-Ww@vB-esS`Fs7?HaIN9mH7&EC zP1OA>EB5{(DCV-v!sR)Ui}0J&Ut7`tGuGhJoVcUX#}ma8|8(lj&A+n+gIQd#rVOy& zm%yKZetZz`7p3&HOt^XicnZ35lFrSEB}(C~V&yHyv0|kaxHrf3q;3x$$;AC|Ewcyy zgf&@zXJtTDu&eT1oUYaE)W16&AQ;TlitgT-6<1~OdV9L7jp-45MKt3h^4d<6gtepS zUz?M*zi8eKsg2O9WoCUGYo01wr0uo@ZzH~lvqjB+hgdCjQ5JSg{Z%=s0}cE6jb}u5 zKadkYEx)-^WO&t=+Y9xHO(!T3Rf zy;Fc!_K##y`TPj(5;S^7`m!EnLqGr4MPqKQWoE$>%AtMGPGXZYo=g^*-eA@1D!)&z z=xvw5w@qMcQabfi-cKGA%CJ>Sy9eB4BB{Wrnx$Ju4!v7~@|;uZPsHo;XJQe@!$g01W?>gM_)`ouBm^oMYd zQmJqz&KH}RpNiv!>4J{UPoSn%f@>WSXpz6QG=8{m^&fO}&bxsoy6yQEwC!a4CMB?^~+h93i!>0lY3Y5;Mh8Y-Gk#T#-BEnxJp( zqW)fE%SKiR9y=ND5hbB!c=z~)p>YA*kHjiDRj`MX)8?b1{@yM4ZNF$zE5r(E$c6;2 zx7m%7U?S_pN;y{4@VeO4U6j7`=1y}1J}KDFNrJhx3X-q}9}&kNn=_W1)3=dQ3SuyG zBESdoBlnBC_qZq}{S}=f@!kaWdZTRZ^W9^DUR^47u5Du5eTS%jDqH)y*tOk=mk2hp zQPk8%Ko@6_W%{tG^1XXS25zo8ks#K^3R{u3cN<~5!L<#x3~Cu{S(gcRS?bSB9PSib z{D$2J#YSqtmNFnVb1f4AUI-d><0$WHV#oPq!{-a<$n)_r^veuti!2yP|FTxD6TEgb zd9rdp@|*Rs{20ad%F%S-{@bHPrT#;Cjpg^4-%NR$t*haaMm$dz4dX<-TQG`sqU+x@ z%J@bjDJD9K9V3u!mWjr0tL?4PA5W+HZX&>2MM*hGEc@-nAy5~dpE?hVW6?{Del+`l zsGGh1FB1Y@2v)KGDDT#Z^NuemixrA;tbenu6b)``Xxx9jj0N~uTym4h*qa1hyB-_H z0h_4X