From d58c3d9d0c213a6f2ac8eb448a386864ebb9b325 Mon Sep 17 00:00:00 2001 From: Roger Gonzalez Date: Mon, 1 Jan 2024 14:28:45 -0300 Subject: [PATCH 1/7] Fixed custom VPN URL --- content/advanced/vpn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/advanced/vpn.md b/content/advanced/vpn.md index 8b88945..962a9cb 100644 --- a/content/advanced/vpn.md +++ b/content/advanced/vpn.md @@ -36,7 +36,7 @@ YAMS uses [gluetun](https://github.com/qdm12/gluetun) for VPN. - [WeVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/wevpn.md) - [Windscribe](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/windscribe.md) -You can also set up a [custom VPN provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/Custom-provider), but **this is not officially supported for YAMS. You are on your own here.** +You can also set up a [custom VPN provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md), but **this is not officially supported for YAMS. You are on your own here.** ## Manual configuration From aac95732048d45b67f18f9b8e81de5ab7cde623e Mon Sep 17 00:00:00 2001 From: Mason Stooksbury Date: Sun, 22 Sep 2024 23:24:14 -0500 Subject: [PATCH 2/7] Adding link to install script per the todo section in the README --- README.md | 1 - content/install/steps.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index b6b7b5d..818e1ce 100644 --- a/README.md +++ b/README.md @@ -30,4 +30,3 @@ Your files will be on the `./public` folder, ready to upload to a server. ## todo - Add dark mode -- Add a hotlink to the install.sh in the instructions. diff --git a/content/install/steps.md b/content/install/steps.md index f26aaaf..82044eb 100644 --- a/content/install/steps.md +++ b/content/install/steps.md @@ -55,7 +55,7 @@ If you can run `docker run hello-world` without `sudo`, you can continue. If you ### Inspecting the `install` script by yourself (optional). -Its always a good practice to verify and study the scripts you run on your machine. You can always inspect `install.sh` on the Gitlab repo here: https://gitlab.com/rogs/yams/-/blob/master/docs.org. You don't have to be a complete expert in `bash` (I'm definitely not lol), but if you have any experience with the Linux terminal you should be able to at understand what's happening. +Its always a good practice to verify and study the scripts you run on your machine. You can always inspect [`install.sh`](https://gitlab.com/rogs/yams/-/blob/master/install.sh?ref_type=heads) script in the Gitlab repo here: https://gitlab.com/rogs/yams/-/blob/master/docs.org. You don't have to be a complete expert in `bash` (I'm definitely not lol), but if you have any experience with the Linux terminal you should be able to at least understand what's happening. ### Cloning from Gitlab From a7ec3fabf83fe44ef01cb37d0a46542d897f82e8 Mon Sep 17 00:00:00 2001 From: Mason Stooksbury Date: Tue, 24 Sep 2024 13:03:56 +0000 Subject: [PATCH 3/7] Updating the upgrade documentation --- content/install/upgrading-from-v1-to-v2.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/install/upgrading-from-v1-to-v2.md b/content/install/upgrading-from-v1-to-v2.md index 7873b44..161955d 100644 --- a/content/install/upgrading-from-v1-to-v2.md +++ b/content/install/upgrading-from-v1-to-v2.md @@ -3,18 +3,18 @@ title: "Upgrading YAMS from version 1 to version 2 (Advanced)" date: 2023-10-25T19:19:19-03:00 draft: false weight: 4 -summary: Are you running YAMS v1? Here's the guide to upgrade YAMS to v2! +summary: Are you running YAMS V1? Here's the guide to upgrade YAMS to V2! --- # First, a brief disclaimer -I want to make this very clear: **This is entirely optional!** I will continue to support YAMS v1 as well as YAMS v2. +I want to make this very clear: **This is entirely optional!** I will continue to support YAMS V1 as well as YAMS V2. -If you are completely happy with YAMS v1, or have a heavily modified setup, you can skip this tutorial! +If you are completely happy with YAMS V1, or have a heavily modified setup, you can skip this tutorial! ## What are the advantages? -- YAMS v2 introduces a new command: `yams upgrade`. It allows YAMS to upgrade itself. +- YAMS V2 introduces a new command: `yams update`. It allows YAMS to update itself. - Adding custom containers is now easier. You can find the tutorial here: [Add your own containers](/advanced/add-your-own-containers/). # Before starting @@ -34,7 +34,7 @@ cd ~/yams_upgrade ## Setup .env.example -Begin by opening the `.env.example` file. Add your correct information to the file. All this information is currently available in your YAMS v1 `docker-compose.yaml` file. +Begin by opening the `.env.example` file. Add your correct information to the file. All this information is currently available in your YAMS V1 `docker-compose.yaml` file. For the purposes of this tutorial: @@ -76,7 +76,7 @@ sed -i -e "s||/opt/yams/docker-compose.yaml|g" yams # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ REPLACE THE FIRST LINE HERE BETWEEN THE "|" sed -i -e "s||/opt/yams/docker-compose.custom.yaml|g" yams # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ REPLACE THE SECOND LINE HERE BETWEEN THE "|" -sed -i -e "s||/opt/yams|g" yams +sed -i -e "s||/opt/yams|g" yams # ^^^^^^^^^ REPLACE THE THIRD LINE HERE BETWEEN THE "|" ``` @@ -84,7 +84,7 @@ sed -i -e "s||/opt/yams|g" yams Move your custom containers to `docker-compose.custom.yaml`. If you need help, you can use this tutorial from the "Adding a container" section: [Add your own containers - Adding a container](/advanced/add-your-own-containers/#adding-a-container). -# Finish the upgrade +# Finish the update First, you need to stop YAMS. Run: @@ -127,7 +127,7 @@ cp $(which yams) yams-old sudo cp yams $(which yams) ``` -### Run the upgrade! +### Run the update! Now it's the time to execute the update! @@ -139,6 +139,6 @@ Everything should be up and running! # That's done! -YAMS should start back up again, and everything should be working as expected with the difference that now YAMS can be upgraded by using `yams upgrade`. +YAMS should start back up again, and everything should be working as expected with the difference that now YAMS can be updated by using `yams update`. -If you have any issues upgrading from v1 to v2, you can create a new post in our forum: [YAMS Forum: Upgrading YAMS from v1 to v2](https://forum.yams.media/viewforum.php?f=26) +If you have any issues upgrading from V1 to V2, you can create a new post in our forum: [YAMS Forum: Upgrading YAMS from V1 to V2](https://forum.yams.media/viewforum.php?f=26) From 7144695823a07f8fe70b7b592cc93fd886a03227 Mon Sep 17 00:00:00 2001 From: MasonStooksbury Date: Tue, 24 Sep 2024 08:06:55 -0500 Subject: [PATCH 4/7] Updating another broken discord link I missed, edited FAQ page about WIMPS --- content/contact/_index.md | 2 +- content/faqs/_index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/contact/_index.md b/content/contact/_index.md index 1870677..9daaeb2 100644 --- a/content/contact/_index.md +++ b/content/contact/_index.md @@ -7,7 +7,7 @@ weight: 100 ## YAMS Official Chats -- Discord: [https://discord.gg/cpnAm2Mu](https://discord.gg/cpnAm2Mu). +- Discord: [https://discord.gg/Gwae3tNMST](https://discord.gg/Gwae3tNMST). - Matrix: [https://matrix.to/#/#yams-space:chat.rogs.me](https://matrix.to/#/#yams-space:chat.rogs.me). - IRC: [libera.chat: #yams-chat IRC channel](ircs://irc.libera.chat/#yams-chat) diff --git a/content/faqs/_index.md b/content/faqs/_index.md index b4be785..10c6733 100644 --- a/content/faqs/_index.md +++ b/content/faqs/_index.md @@ -15,7 +15,7 @@ Because. That's why it's _**opinionated**_, you don't _necessarily_ have to agre ## I want to use YAMS in Windows. Can I do that? -You might have success running YAMS manually in Windows with `docker`, but I recommend you check out [WIMPS](https://github.com/Xaque8787/WIMPS), a YAMS inspired setup for Windows. According to its developer [/u/zachfive87](https://www.reddit.com/user/zachfive87/), "WIMPS isn't a finished project and is very rough around the edges" but you'll might have more success running WIMPS in Windows. +You might have success running YAMS manually in Windows with `docker`, but I recommend you check out [WIMPS](https://github.com/Xaque8787/WIMPS), a YAMS inspired setup for Windows. Although the project has been archived, it could provide a better starting point than YAMS. ## YAMS's configuration is too basic. I want more! From b21ba20c90722ee342c0810ed4fece8bb0e23852 Mon Sep 17 00:00:00 2001 From: Roger Gonzalez Date: Wed, 2 Oct 2024 15:24:35 -0300 Subject: [PATCH 5/7] Fixed hugo .Site.IsServer deprecation --- themes/hugo-whisper-theme/layouts/_default/baseof.html | 9 --------- 1 file changed, 9 deletions(-) diff --git a/themes/hugo-whisper-theme/layouts/_default/baseof.html b/themes/hugo-whisper-theme/layouts/_default/baseof.html index 9be88fb..ca6448e 100644 --- a/themes/hugo-whisper-theme/layouts/_default/baseof.html +++ b/themes/hugo-whisper-theme/layouts/_default/baseof.html @@ -9,13 +9,8 @@ {{ block "meta_tags" . }}{{end}} - {{ if .Site.IsServer }} - {{ $style := resources.Get "scss/style.scss" | toCSS (dict "targetPath" "css/style.css" "enableSourceMap" true) }} - - {{ else }} {{ $style := resources.Get "scss/style.scss" | toCSS (dict "targetPath" "css/style.css" "enableSourceMap" false) }} - {{ end }} {{ block "header_css" . }}{{ end }} @@ -60,11 +55,7 @@ {{ block "footer_js" . }} {{ end }} - {{ if .Site.IsServer }} - - {{ else }} - {{ end }} From c899c05e35788cf0703080d80d01277890f4dbec Mon Sep 17 00:00:00 2001 From: Mason Stooksbury Date: Wed, 2 Oct 2024 19:20:43 +0000 Subject: [PATCH 6/7] Prowlarr VPN documentation --- content/advanced/prowlarr-behind-vpn.md | 63 +++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 content/advanced/prowlarr-behind-vpn.md diff --git a/content/advanced/prowlarr-behind-vpn.md b/content/advanced/prowlarr-behind-vpn.md new file mode 100644 index 0000000..3e730da --- /dev/null +++ b/content/advanced/prowlarr-behind-vpn.md @@ -0,0 +1,63 @@ +--- +title: "Running Prowlarr behind the VPN" +date: 2024-09-27T16:44:00-03:00 +draft: false +weight: 3 +summary: How to put Prowlarr behind the VPN just like qBitTorrent +--- + +While not usually illegal, downloading .torrent files can be a grey area in a lot of places. Because of this, some ISPs will attempt to block indexers. +An obvious way around this is by putting Prowlarr itself behind the VPN. Here's the steps to do that + + +## Modifying Prowlarr +- Open your `docker-compose.yaml` file in your text editor of choice +- Scroll down to the `prowlarr` service and remove the `ports` section +- Add a new line: `network_mode: "service:gluetun"` (if you've renamed your Gluetun service, be sure to match the service names here) +- Under the existing `environment` section, add this line `- WEBUI_PORT=9696` +- Once finished, your Prowlarr service should look something like this + ```yaml + prowlarr: + image: lscr.io/linuxserver/prowlarr + container_name: prowlarr + network_mode: "service:gluetun" + environment: + - PUID=${PUID} + - PGID=${PGID} + - WEBUI_PORT=9696 + volumes: + - ${INSTALL_DIRECTORY}/config/prowlarr:/config + restart: unless-stopped + ``` + +## Modifying Gluetun +- Scroll down to the `gluetun` section +- Under the `ports` section, add this line `- 9696:9696/tcp` +- Under the `environment` section, add this line: `- FIREWALL_OUTBOUND_SUBNETS=192.168.1.0/24` (NOTE: You'll want the subnet to match the subnet for your containers) + - If you're unsure what subnets your containers are running under, open up Portainer, click on `Containers`, and look in the `IP Address` column + - You really only need to care about the first two sections of the IP address. So if your containers are running under `172.18.X.X` then your entry would look like: `- FIREWALL_OUTBOUND_SUBNETS=172.18.1.0/24` +- Once finished, your Gluetun service should look something like this: + ```yaml + gluetun: + image: qmcgaw/gluetun:v3 + container_name: gluetun + cap_add: + - NET_ADMIN + devices: + - /dev/net/tun:/dev/net/tun + ports: + - 8888:8888/tcp # HTTP proxy + - 8388:8388/tcp # Shadowsocks + - 8388:8388/udp # Shadowsocks + - 8080:8080/tcp # gluetun + - 9696:9696/tcp + volumes: + - ${INSTALL_DIRECTORY}/config/gluetun:/config + environment: + - FIREWALL_OUTBOUND_SUBNETS=192.168.1.0/24 # NOTE: May look different on your system. Double check the subnets in Portainer + restart: unless-stopped` + ``` + +Once all of your changes have been made, save and close the file + +In your terminal, run `yams restart` to bounce the stack and apply your changes From 8d0a8c685b2cf30062f08919e4e4af549091799a Mon Sep 17 00:00:00 2001 From: Roger Gonzalez Date: Thu, 28 Nov 2024 17:43:51 -0300 Subject: [PATCH 7/7] Update Matrix chat URL and add Discord chat URL --- config.toml | 2 +- content/contact/_index.md | 3 +-- content/faqs/common-errors.md | 2 +- layouts/partials/sub-footer.html | 2 +- 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/config.toml b/config.toml index 13ea585..d9a1519 100644 --- a/config.toml +++ b/config.toml @@ -64,7 +64,7 @@ summaryLength = 30 [[menu.main]] name = "Matrix" - url = "https://matrix.to/#/#yams-space:chat.rogs.me" + url = "https://matrix.to/#/#yams-space:rogs.me" weight = 99 [[menu.main]] diff --git a/content/contact/_index.md b/content/contact/_index.md index 9daaeb2..d47b6bc 100644 --- a/content/contact/_index.md +++ b/content/contact/_index.md @@ -7,9 +7,8 @@ weight: 100 ## YAMS Official Chats +- Matrix: [https://matrix.to/#/#yams-space:rogs.me](https://matrix.to/#/#yams-space:rogs.me). - Discord: [https://discord.gg/Gwae3tNMST](https://discord.gg/Gwae3tNMST). -- Matrix: [https://matrix.to/#/#yams-space:chat.rogs.me](https://matrix.to/#/#yams-space:chat.rogs.me). -- IRC: [libera.chat: #yams-chat IRC channel](ircs://irc.libera.chat/#yams-chat) ## Also, YAMS has a forum now! diff --git a/content/faqs/common-errors.md b/content/faqs/common-errors.md index f90b50b..7d19112 100644 --- a/content/faqs/common-errors.md +++ b/content/faqs/common-errors.md @@ -58,4 +58,4 @@ This command will display the last 100 lines of the Gluetun logs. Many of the issues arise due to misconfigurations in your VPN setup. Please review the documentation for your VPN by clicking [here](/advanced/vpn). -Review the logs to try and find a solution. If you require assistance, feel free to join our Matrix chat and ask for help! +Review the logs to try and find a solution. If you require assistance, feel free to join our [Matrix](https://matrix.to/#/#yams-space:rogs.me) or [Discord](https://discord.gg/Gwae3tNMST) chat and ask for help! diff --git a/layouts/partials/sub-footer.html b/layouts/partials/sub-footer.html index 715c69f..0376196 100644 --- a/layouts/partials/sub-footer.html +++ b/layouts/partials/sub-footer.html @@ -14,7 +14,7 @@ Discord
  • - #yams:chat.rogs.me + #yams-space:rogs.me
    • {{ if not (in (.Site.BaseURL | string) "localhost") }}