diff options
| -rw-r--r-- | content/advanced/_index.md | 6 | ||||
| -rw-r--r-- | content/advanced/vpn.md | 95 | ||||
| -rw-r--r-- | content/config/qbittorrent.md | 8 | ||||
| -rw-r--r-- | content/donate/_index.md | 14 | ||||
| -rw-r--r-- | content/donate/thanks.md | 23 | ||||
| -rw-r--r-- | content/install/steps.md | 31 |
6 files changed, 134 insertions, 43 deletions
diff --git a/content/advanced/_index.md b/content/advanced/_index.md new file mode 100644 index 0000000..fe83fe5 --- /dev/null +++ b/content/advanced/_index.md @@ -0,0 +1,6 @@ +--- +title: "Advanced" +date: 2023-01-16T10:56:37-03:00 +draft: false +weight: 100 +--- diff --git a/content/advanced/vpn.md b/content/advanced/vpn.md index 271ebe5..ca84150 100644 --- a/content/advanced/vpn.md +++ b/content/advanced/vpn.md @@ -3,6 +3,99 @@ title: "VPN" date: 2023-01-15T21:16:29-03:00 draft: false weight: 1 +summary: Advanced configuration for the VPN, supported VPN lists and manual configuration --- -Working on it :) +Remember: **You should always use a VPN when downloading torrents!**. + +YAMS uses [gluetun](https://github.com/qdm12/gluetun) for VPN. + +### Official supported VPNs + +- [AirVPN](https://github.com/qdm12/gluetun/wiki/AirVPN) +- [Cyberghost](https://github.com/qdm12/gluetun/wiki/Cyberghost) +- [ExpressVPN](https://github.com/qdm12/gluetun/wiki/ExpressVPN) +- [FastestVPN](https://github.com/qdm12/gluetun/wiki/FastestVPN) +- [Hidemyass](https://github.com/qdm12/gluetun/wiki/Hidemyass) +- [IPVanish](https://github.com/qdm12/gluetun/wiki/IPVanish) +- [IVPN](https://github.com/qdm12/gluetun/wiki/IVPN) +- [Mullvad](https://github.com/qdm12/gluetun/wiki/Mullvad) **(Recommended!)** +- [NordVPN](https://github.com/qdm12/gluetun/wiki/NordVPN) +- [Perfect privacy](https://github.com/qdm12/gluetun/wiki/Perfect-privacy) +- [Privado](https://github.com/qdm12/gluetun/wiki/Privado) +- [Private internet access](https://github.com/qdm12/gluetun/wiki/Private-internet-access) +- [PrivateVPN](https://github.com/qdm12/gluetun/wiki/PrivateVPN) +- [ProtonVPN](https://github.com/qdm12/gluetun/wiki/ProtonVPN) +- [PureVPN](https://github.com/qdm12/gluetun/wiki/PureVPN) +- [SlickVPN](https://github.com/qdm12/gluetun/wiki/SlickVPN) +- [Surfshark](https://github.com/qdm12/gluetun/wiki/Surfshark) +- [Torguard](https://github.com/qdm12/gluetun/wiki/Torguard) +- [VPN Secure](https://github.com/qdm12/gluetun/wiki/VPN-Secure) +- [VPN Unlimited](https://github.com/qdm12/gluetun/wiki/VPN-Unlimited) +- [VyprVPN](https://github.com/qdm12/gluetun/wiki/VyprVPN) +- [WeVPN](https://github.com/qdm12/gluetun/wiki/WeVPN) +- [Windscribe](https://github.com/qdm12/gluetun/wiki/Windscribe) + +You can also set a [custom VPN provider](https://github.com/qdm12/gluetun/wiki/Custom-provider), but **this is not officially supported for YAMS. You are on your own here.** + +### Manual configuration + +To manually configure your VPN, you have to edit your `docker-compose.yaml` file. + +First, stop `YAMS`: +```bash +$ yams stop +``` + +Then, open your `docker-compose.yaml` file. For this tutorial, I'm assuming the install location is `/opt/yams`. Also, you don't have to use `vim`, you can use `nano` or any other editor. + +```bash +$ vim /opt/yams/docker-compose.yaml +``` + +On the file, find the `qbitorrent` config and make the following changes: + +```yaml +... + # ports: # qbittorrent -> Comment this line + # - 8080:8080 # qbittorrent -> Comment this line + network_mode: "service:gluetun" -> Uncomment this line +``` + +Then, at the bottom, find the `gluetun` config and make the following changes: + +```yaml +... + - 8080:8080/tcp # gluetun -> Uncomment this line +... + environment: + - VPN_SERVICE_PROVIDER=<vpn_service> # -> Replace "<vpn_service>" with your VPN service provider + - VPN_TYPE=openvpn + - OPENVPN_USER=<vpn_user> # -> Replace "<vpn_user>" with your VPN username + - OPENVPN_PASSWORD=<vpn_password> # -> Replace "<vpn_password>" with your VPN password + - SERVER_COUNTRIES=<vpn_country> # -> Replacee "<vpn_country>" with your VPN country +``` + +Now, restart `YAMS`: + +```bash +$ yams restart +``` + +Finally, check that your VPN is running correctly: + +```bash +$ yams check-vpn + +Getting your qBittorrent IP... +<your_qbittorrent_ip> +Your country in qBittorrent is Brazil + +Getting your IP... +<your_local_ip> +Your local IP country is North Korea + +Your IPs are different. qBittorrent is working as expected! ✅ +``` + +If it's not running correctly, check every setting and make sure they are all correct. diff --git a/content/config/qbittorrent.md b/content/config/qbittorrent.md index ba7d0a1..a2dd71e 100644 --- a/content/config/qbittorrent.md +++ b/content/config/qbittorrent.md @@ -16,7 +16,7 @@ So, just like µTorrent, qBitorrent is a torrent downloader. Pretty easy! ## First, check your VPN! -If you configured Mullvad correctly, your VPN should already be running. To test, run on your terminal: +If you configured your VPN correctly, it should be running. To test, run on your terminal: ```bash $ yams check-vpn @@ -27,9 +27,11 @@ If everything is working correctly, you should get a message like this: ```bash Getting your qBittorrent IP... <qBittorrent IP> +Your country in qBittorrent is Brazil Getting your IP... <your local IP> +Your local IP country is North Korea Your IPs are different. qBittorrent is working as expected! ✅ ``` @@ -40,14 +42,16 @@ If the check fails (or you haven't configured the VPN), you'll see a message lik ```bash Getting your qBittorrent IP... <your local IP> +Your country in qBittorrent is North Korea Getting your IP... <your local IP> +Your local IP country is North Korea Your IPs are the same! qBittorrent is NOT working! ⚠️ ``` -**You should always run a VPN when downloading torrents!** You can manually set your VPN here: [Advanced VPN settings](/advanced/vpn). You can come back here after you have fixed this! +**You should always run a VPN when downloading torrents!** You can manually set your VPN [here](/advanced/vpn/#manual-configuration) or you can run the YAMS installer again and use the automatic installer. Come back here after you have fixed this! ## Initial configuration diff --git a/content/donate/_index.md b/content/donate/_index.md index 97c4b9f..cb5a8d1 100644 --- a/content/donate/_index.md +++ b/content/donate/_index.md @@ -10,12 +10,13 @@ If you **really** wish to donate, first I would like to say thank you from the b Second, I would prefer you donate to any of the projects used in this script. They are the ones doing the real work, I just created a `docker-compose` file, a couple of bash scripts and a documentation. -- [linuxserver.io donations page](https://www.linuxserver.io/donate) -- [Sonarr donations page](https://sonarr.tv/donate) -- [Radarr donations page](https://radarr.video/donate) -- [Emby premier page](https://emby.media/premiere.html) (Recommended! I personally use this service) -- [qBittorrent donations page](https://www.qbittorrent.org/donate) -- [Bazarr donations page](https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=XHHRWXT9YB7WE&source=url) +- [linuxserver.io donations page](https://www.linuxserver.io/donate). +- [Sonarr donations page](https://sonarr.tv/donate). +- [Radarr donations page](https://radarr.video/donate). +- [Emby premier page](https://emby.media/premiere.html) (Recommended! I personally use this service). +- [qBittorrent donations page](https://www.qbittorrent.org/donate). +- [Bazarr donations page](https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=XHHRWXT9YB7WE&source=url). +- [gluetun donations page](https://www.paypal.me/qmcgaw). - Jackett does not have a donation page 🤔 Just let them know YAMS sent you there 😎 @@ -36,6 +37,7 @@ I'm not doing this for the money, and thank God I don't need donations to keep t - [qBittorrent](https://www.qbittorrent.org/). - [Bazarr](https://www.bazarr.media/). - [Jackett](https://github.com/Jackett/Jackett). +- [gluetun](https://github.com/qdm12/gluetun). - My friends: + [xploshioOn](https://github.com/xploshioOn). + [norlis](https://github.com/norlis). diff --git a/content/donate/thanks.md b/content/donate/thanks.md deleted file mode 100644 index a20437d..0000000 --- a/content/donate/thanks.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Special thanks" -date: 2023-01-11T09:24:26-03:00 -draft: true -weight: 100 ---- - -- [linuxserver.io](https://info.linuxserver.io/) for their amazing docker images. -- [Sonarr](https://sonarr.tv/). -- [Radarr](https://radarr.video/). -- [Emby](https://emby.media/). -- [qBittorrent](https://www.qbittorrent.org/). -- [Bazarr](https://www.bazarr.media/). -- [Jackett](https://github.com/Jackett/Jackett). -- My friends: - + [xploshioOn](https://github.com/xploshioOn). - + [norlis](https://github.com/norlis). - + [isaac152](https://github.com/isaac152). - -## And finally: -You 🫵, for being such an amazing human being, checking out my project and (hopefully!) using it on your media server. - -# Thank you! 🙇 diff --git a/content/install/steps.md b/content/install/steps.md index 506b4b3..115bda1 100644 --- a/content/install/steps.md +++ b/content/install/steps.md @@ -33,7 +33,7 @@ Before installing, make sure you have: The location `/opt/yams` is **recommended**, but you can use whatever you like if your current user has permissions on the directory. ```bash -sudo mkdir -p /opt/yams +sudo mkdir -p /opt/yams sudo chown -R $USER:$USER /opt/yams ``` @@ -107,31 +107,40 @@ Select `y` or `n` if you are happy with the folder you selected. Press `[ENTER]` #### VPN ```bash Time to setup the VPN. -The automatic installer only works with Mullvad, but you can setup many other VPNs manually. -If you want to use any other VPN, choose "N" -Do you want to configure Mullvad VPN? [Y/n]: +You can check the supported VPN list here: https://yams.media/advanced/vpn. +Do you want to configure a VPN? [Y/n]: ``` -Now its time to configure the VPN. The automatic installer only supports [Mullvad VPN](https://mullvad.net/en/), and **I strongly recommend you use Mullvad**. Why? Basically: -- They don't require your email or information to register. +Now its time to configure the VPN. The automatic installer supports all the VPNs on [this list](/advanced/vpn#official-supported-vpns), but **I strongly recommend you use Mullvad**. Why? Basically: +- They don't require your email or information to create a new account. - It's simple to configure. - They only have monthly subscriptions, so you can leave them whenever you want. - You can pay with crypto. -If want to use Mullvad, select `Y` and continue with this instructions. If you have any other VPN, choose `N` and move to [finishing the installation](#finishing-the-installation). You can set your VPN later in the [qBittorrent configuration](/config/qbittorrent). **You should always use a VPN when downloading torrents!** +If want to configure a VPN, select `Y` and continue with this instructions. If you don't have a VPN or don't want to use a VPN, choose `N` and move to [finishing the installation](#finishing-the-installation). You can set your VPN later in the [qBittorrent configuration](/config/qbittorrent). **You should always use a VPN when downloading torrents!** ```bash -What's your Mullvad username? (without spaces): +What's your VPN service? (with spaces) [mullvad]: ``` -First, just enter your Mullvad username. As you may know, Mullvad only requires your username to login. Paste your username and press `[ENTER]`. +First, select your VPN provider. You can go to [this list](/advanced/vpn#official-supported-vpns) and verify the name of your VPN. + +```bash +What's your VPN username? (without spaces): +``` +Now, just enter your VPN username. If it has spaces, delete them. + +```bash +What's your VPN password? (if you are using mullvad, just enter your username again): +``` +Then, enter your VPN password. The script is going to output `*` characters to hide your password, so don't worry about leaking your password on the screen. ``` What country do you want to use? -You can check the countries list here: https://mullvad.net/en/servers/ [brazil]: +You can check the countries list for your VPN here: <url> [brazil]: ``` -Select a country for the VPN to connect to. You can always check Mullvad's list here: https://mullvad.net/en/servers/. You should choose a country that is close to yours, or you can even choose your own country if it's available. The closer the server is, the better speeds you'll get. If you don't choose anything, the installer its going to default to Brazil. +Select a country for the VPN to connect to. You can always check your VPN server list in [their documentation](/advanced/vpn#official-supported-vpns). You should choose a country that is close to yours, or you can even choose your own country if it's available. The closer the server is, the better speeds you'll get. If you don't choose anything, the installer its going to default to Brazil. ### Finishing the installation |