Update master from dev

.github/workflows/check-transmission-releases.yml

@@ -10,17 +10,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
+          token: ${{ secrets.PAT }}
           ref: dev
 
       - name: Check for new version of Transmission
         run: |
-          LATEST_VERSION=$(curl -L https://api.github.com/repos/transmission/transmission/releases/latest | grep tag_name | awk '{print $2}' | sed -e 's/"//g' -e 's/,//')
-          CURRENT_VERSION=$(cat upstream/transmission-version.txt)
-          if [ "$LATEST_VERSION" != "$CURRENT_VERSION" ]; then
+          LATEST_SHA=$(curl -L https://api.github.com/repos/transmission/transmission/tags | tac | tac | awk '/sha/ {print $2; exit}' | sed -e 's/[",]//g')
+          LATEST_VERSION=$(curl -L https://api.github.com/repos/transmission/transmission/releases/latest | awk '/tag_name/ {print $2}' | sed -e 's/[",]//g')
+          CURRENT_SHA=$(cat upstream/transmission-sha.txt)
+          if [ "$LATEST_SHA" != "$CURRENT_SHA" -a -n "$LATEST_SHA" -a -n "$LATEST_VERSION" ]; then
+            echo "$LATEST_SHA" > upstream/transmission-sha.txt
             echo "$LATEST_VERSION" > upstream/transmission-version.txt
+            git config --global user.email "[email protected]"
+            git config --global user.name "workflow runner"
+            git add upstream/transmission-sha.txt
             git add upstream/transmission-version.txt
+            git config user.email "[email protected]"
+            git config user.name "Transmission-Bot"
             git commit -m "update transmission build version to ${LATEST_VERSION}"
             git push origin dev
           fi

.github/workflows/docker-image-builds.yml

@@ -4,6 +4,16 @@ on:
     branches:
       - master
       - dev
+    paths-ignore:
+      - README.md
+      - docker-compose.yml
+      - mkdocs.yml
+      - .github/**
+      - docs/*
+      - images/*
+      - upstream/Dockerfile
+      - upstream/transmission-sha.txt
+      - upstream/transmission-version.txt
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+'
 
@@ -24,33 +34,29 @@ jobs:
             context: ./proxy
           - image-name: haugene/transmission-rss
             context: ./plugins/rss
-        platform:
-          - linux/amd64
-          - linux/arm
-          - linux/arm64
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # QEMU emulator to build for other platforms
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
 
       # Buildx automates creating the multi-arch manifest build
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       # Authenticate so that we can push to Docker Hub
       - name: Log in to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       # Generate image tags and labels
       - name: Generate Docker metadata
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: |
             ${{ matrix.image-name }}
@@ -63,10 +69,10 @@ jobs:
 
       # Finally, build and push the images
       - name: Build image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: ${{ matrix.context }}
-          platforms: ${{ matrix.platform }}
+          platforms: linux/amd64,linux/arm,linux/arm64
           build-args: |
             REVISION=${{ github.sha }}
           push: ${{ github.event_name != 'pull_request' }}

.github/workflows/docker-transmission-builds.yml

@@ -6,21 +6,17 @@ on:
     branches:
       - dev
     paths:
-      - upstream/transmission-version.txt
+      - "upstream/transmission-version.txt"
 
 jobs:
   build-transmission:
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        platform:
-          - linux/amd64
-          - linux/arm
-          - linux/arm64
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PAT }}
+          ref: dev
 
       # Get latest version of Transmission
       - name: Get Transmission version
@@ -30,33 +26,33 @@ jobs:
 
       # QEMU emulator to build for other platforms
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
 
       # Buildx automates creating the multi-arch manifest build
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       # Authenticate so that we can push to Docker Hub
       - name: Log in to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       # Generate image tag and labels
       - name: Generate Docker metadata
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: haugene/transmission-builder
           tags: type=match,pattern=(\d+.\d+.\d+),group=1,value=${{ env.TBT_VERSION }}
 
       # Finally, build and push the image
       - name: Build image
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           context: upstream
-          platforms: ${{ matrix.platform }}
+          platforms: linux/amd64,linux/arm,linux/arm64
           build-args: |
             REVISION=${{ github.sha }}
             TBT_VERSION=${{ env.TBT_VERSION }}
@@ -65,3 +61,15 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           cache-from: type=gha, scope=${{ github.workflow }}
           cache-to: type=gha, scope=${{ github.workflow}}
+
+      - name: Update build-version.txt
+        run: |
+          TBT_VERSION=${{ env.TBT_VERSION }}
+          echo "$TBT_VERSION" > upstream/build-version.txt
+          git config --global user.email "[email protected]"
+          git config --global user.name "workflow runner"
+          git add upstream/build-version.txt
+          git config user.email "[email protected]"
+          git config user.name "Transmission-Bot"
+          git commit -m "update image build version to ${TBT_VERSION}"
+          git push origin dev

.github/workflows/mkdocs.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Python
         uses: actions/setup-python@v4

Dockerfile

@@ -14,7 +14,7 @@ RUN apk --no-cache add curl jq \
     && mv /opt/transmission-ui/kettu-master /opt/transmission-ui/kettu \
     && echo "Install Transmission-Web-Control" \
     && mkdir /opt/transmission-ui/transmission-web-control \
-    && curl -sL $(curl -s https://api.github.com/repos/ronggang/transmission-web-control/releases/latest | jq --raw-output '.tarball_url') | tar -C /opt/transmission-ui/transmission-web-control/ --strip-components=2 -xz \
+    && curl -sL $(curl -s https://api.github.com/repos/transmission-web-control/transmission-web-control/releases/latest | jq --raw-output '.assets[0].browser_download_url') | tar -C /opt/transmission-ui/transmission-web-control/ --strip-components=2 -xz \
     && echo "Install Transmissionic" \
     && wget -qO- https://github.com/6c65726f79/Transmissionic/releases/download/v1.8.0/Transmissionic-webui-v1.8.0.zip | unzip -q - \
     && mv web /opt/transmission-ui/transmissionic
@@ -39,9 +39,10 @@ RUN set -ex; \
       libminiupnpc-dev \
       libnatpmp-dev \
       libpsl-dev \
-      libssl-dev
+      libssl-dev \
+      natpmpc
 
-FROM haugene/transmission-builder:4.0.4 as TransmissionBuilder
+FROM haugene/transmission-builder:4.0.5 as TransmissionBuilder
 
 FROM base
 
@@ -51,7 +52,7 @@ VOLUME /config
 COPY --from=TransmissionUIs /opt/transmission-ui /opt/transmission-ui
 COPY --from=TransmissionBuilder /var/tmp/*.deb /var/tmp/
 
-ARG TBT_VERSION=4.0.4
+ARG TBT_VERSION=4.0.5
 ARG DEBIAN_FRONTEND=noninteractive
 
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
@@ -113,6 +114,7 @@ ENV OPENVPN_USERNAME=**None** \
     DROP_DEFAULT_ROUTE= \
     WEBPROXY_ENABLED=false \
     WEBPROXY_PORT=8118 \
+    WEBPROXY_BIND_ADDRESS= \
     WEBPROXY_USERNAME= \
     WEBPROXY_PASSWORD= \
     LOG_TO_STDOUT=false \

README.md

@@ -1,5 +1,7 @@
 # OpenVPN and Transmission with WebUI
 
+[![Docker Build](https://img.shields.io/github/actions/workflow/status/haugene/docker-transmission-openvpn/docker-image-builds.yml
+)](https://hub.docker.com/r/haugene/transmission-openvpn/)
 [![Docker Pulls](https://img.shields.io/docker/pulls/haugene/transmission-openvpn.svg)](https://hub.docker.com/r/haugene/transmission-openvpn/)
 
 This container contains OpenVPN and Transmission with a configuration

docs/provider-specific.md

@@ -118,3 +118,74 @@ services:
           max-size: 10m
       image: haugene/transmission-openvpn:latest
 ```
+
+### PROTONVPN
+
+[PROTONVPN](https://protonvpn.com/support/linux-openvpn/#preparation) provides `.ovpn` configuration files. Just download the one you want to connect with and which allows P2P.
+
+### Prerequisites:
+User needs to have a paid account.
+
+1. download your ProtonVPN ovpn file from a destination which allows P2P.
+2. in the directory with your docker-compose file, create a directory: `mkdir protonvpn`
+3. copy your ovpn file (node-<country of choice>.protonvpn.net.udp.ovpn) from step 1 to the protonvpn directory
+4. add the environment vars below and add +pmp to your username if you want to use port forwarding.
+5. add the [update-port.sh](https://github.com/haugene/vpn-configs-contrib/blob/main/openvpn/protonvpn/update-port.sh) script for ProtonVPN from vpn-configs-contrib to the protonvpn directory of step 2.
+
+Here is a full example of `docker-compose.yml` file, assuming configuration file named `node-<country of choice>.protonvpn.net.udp`
+is under local `protonvpn` subdirectory.
+
+```yaml
+version: 3.7.1
+services:
+    transmission-openvpn:
+        container_name: TransmissionVPN
+        restart: on-failure:2
+        cap_add:
+            - NET_ADMIN
+        volumes:
+            - ./protonvpn/:/etc/openvpn/custom/
+            - /your/config/path/:/config # where transmission-home is stored
+            - /your/storage/path/:/data # where transmission will store the data
+        environment:
+            - OPENVPN_PROVIDER=custom
+            - OPENVPN_CONFIG=node-<country of choice>.protonvpn.net.udp
+            - OPENVPN_USERNAME=<username>+pmp
+            - OPENVPN_PASSWORD=<password>
+            - LOCAL_NETWORK=192.168.0.0/16
+        logging:
+            driver: json-file
+            options:
+                max-size: 10m
+        ports:
+            - 9091:9091
+        image: haugene/transmission-openvpn
+
+```
+
+
+After starting your container, the `peer listening port` in Transmission should be open after a minute or so. 
+
+If not you can jump in the container and run the script manually and see which error you get, or set the debug env variable: `- DEBUG=true` and look in the logging of your container for the output of the script `update-port.sh`
+
+
+To check which IP address your VPN is currently connected to, run this script:
+```bash
+#!/bin/bash
+
+f_container_name()
+{
+docker ps --format "{{.Names}}"| grep -i transmission
+}
+
+f_find_all()
+{
+curl --silent ipinfo.io/$ext_ip
+}
+
+var_cont_name=$(f_container_name)
+ext_ip=$(docker exec $var_cont_name curl --silent "http://ipinfo.io/ip")
+echo "Transmission VPN currently connected to IP address: $ext_ip"
+echo "This IP address is in the following country: "
+f_find_all
+```

docs/tips-tricks.md

@@ -213,7 +213,7 @@ $ sudo systemctl start transmission-openvpn.service
 A working example of running this container behind a traefik reverse proxy can be found here:
 [Config](https://github.com/haugene/docker-transmission-openvpn/issues/1763#issuecomment-844404143)
 
-#### Running this container with Podman
+# Running this container with Podman
 
 The `podman run` command is almost identical to [the one mentioned in README.md](../README.md#docker-run) but with the following exception:
 

docs/web-proxy.md

@@ -7,11 +7,12 @@ The default listening port is 8118. Note that only ports above 1024 can be speci
 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                 |
-| ------------------ | ----------------------- | ----------------------- |
-| `WEBPROXY_ENABLED` | Enables the web proxy   | `WEBPROXY_ENABLED=true` |
-| `WEBPROXY_PORT`    | Sets the listening port | `WEBPROXY_PORT=8118`    |
+| Variable                | Function                | Example                         |
+| ----------------------- | ----------------------- | ------------------------------- |
+| `WEBPROXY_ENABLED`      | Enables the web proxy   | `WEBPROXY_ENABLED=true`         |
+| `WEBPROXY_PORT`         | Sets the listening port | `WEBPROXY_PORT=8118`            |
+| `WEBPROXY_BIND_ADDRESS` | Sets the listen address | `WEBPROXY_BIND_ADDRESS=0.0.0.0` |
 
-The listening address is the one found bound to the eth0 interface.
+The listening address is the one found bound to the eth0 interface unless `WEBPROXY_BIND_ADDRESS` is set.
 
 `adr=$(ip -4  a show eth0| grep -oP "(?<=inet )([^/]+)")`

openvpn/fetch-external-configs.sh

@@ -64,7 +64,7 @@ elif [[ "${VPN_CONFIG_SOURCE_TYPE}" == "github_clone" ]]; then
       git -C "${config_repo}" checkout "${GITHUB_CONFIG_SOURCE_REVISION}"
     else
       echo "Cloning ${GITHUB_CONFIG_REPO_URL} into ${config_repo}"
-      config_repo_old="${config_repo}" + "_old"
+      config_repo_old="${config_repo}_old"
       mv "${config_repo}" "${config_repo_old}"
       git clone -b "${GITHUB_CONFIG_SOURCE_REVISION}" "${GITHUB_CONFIG_REPO_URL}" "${config_repo}"
     fi

openvpn/nordvpn/configure-openvpn.sh

@@ -7,7 +7,7 @@
 #
 # NORDVPN_COUNTRY: code or name
 # curl -s "https://api.nordvpn.com/v1/servers/countries" | jq --raw-output '.[] | [.code, .name] | @tsv'
-# NORDVPN_PROTOCOL: tcp or upd, tcp if none or unknown. Many technologies are not used as only openvpn_udp and openvpn_tcp are tested.
+# NORDVPN_PROTOCOL: tcp or udp, tcp if none or unknown. Many technologies are not used as only openvpn_udp and openvpn_tcp are tested.
 # Will request api with openvpn_<NORDVPN_PROTOCOL>.
 # curl -s "https://api.nordvpn.com/v1/technologies" | jq --raw-output '.[] | [.identifier, .name ] | @tsv' | grep openvpn
 # NORDVPN_CATEGORY: default p2p. not all countries have all combination of NORDVPN_PROTOCOL(technologies) and NORDVPN_CATEGORY(groups),
@@ -306,10 +306,8 @@ res="$(download_hostname ${selected})"
 log "OVPN: NORDVPN: selected: ${selected}, VPN_PROVIDER_HOME: ${VPN_PROVIDER_HOME}"
 # fix deprecated ciphers
 if [[ -f ${VPN_PROVIDER_HOME}/${selected}.ovpn ]]; then
-  #add data ciphers: DEPRECATED OPTION: --cipher set to 'AES-256-CBC' but missing in --data-ciphers (AES-256-GCM:AES-128-GCM).
-  if [[ 0 -le $(grep -c "cipher AES-256-CBC" ${VPN_PROVIDER_HOME}/${selected}.ovpn) ]] && [[ 0 -eq $(grep -c "data-ciphers AES-256-CBC" ${VPN_PROVIDER_HOME}/${selected}.ovpn) ]]; then
-      sed -i "/cipher AES-256-CBC/a data-ciphers AES-256-CBC" ${VPN_PROVIDER_HOME}/${selected}.ovpn
-  fi
+  # replace with a supported cipher. fixes: DEPRECATED OPTION: --cipher set to 'AES-256-CBC' but missing in --data-ciphers (AES-256-GCM:AES-128-GCM).
+  sed -i -e "s/cipher AES-256-CBC/cipher AES-256-GCM\ndata-ciphers AES-256-GCM/g" ${VPN_PROVIDER_HOME}/${selected}.ovpn
 fi
 #handle tests results.
 if [[ -n ${NORDVPN_TESTS} ]]; then
@@ -390,4 +388,4 @@ fi
 
 export OPENVPN_CONFIG=${selected}
 
-cd "${0%/*}"
+cd "${0%/*}"

openvpn/ovpn/configure-openvpn.sh

@@ -37,7 +37,8 @@ cd /etc/openvpn/ovpn
 find /etc/openvpn/ovpn -type f ! -name "*.sh" -delete
 
 # Download and extract wanted bundle into temporary file
-
+echo "deleting temp folder"
+rm -rf /tmp/ovpnxtract/
 echo "creating temp folder"
 mkdir /tmp/ovpnxtract/
 echo "entering temp folder"

plugins/rss/Dockerfile

@@ -7,6 +7,6 @@ ENV TRANSMISSION_DOWNLOAD_DIR=/data/completed \
     RSS_REGEXP=
 
 # Install build-base and transmission-rss gem
-RUN apk add build-base bash && gem install transmission-rss
+RUN apk add build-base bash && gem install ffi -v 1.16.3 && gem install transmission-rss
 
 ADD . /etc/transmission-rss