kalazzerx/sabnzbdvpn repository overview

⁠SABnzbd⁠, WireGuard and OpenVPN

Docker container which runs the latest SABnzbd⁠ client while connecting to WireGuard or OpenVPN with iptables killswitch to prevent IP leakage when the tunnel goes down.

Original Credit goes to DyonR⁠ whom I forked from in order to get version 3.5 of SABnzbd⁠.

⁠Docker Features

• Base: Debian bullseye-slim
• SABnzbd⁠
• Selectively enable or disable WireGuard or OpenVPN support
• IP tables killswitch to prevent IP leaking when VPN connection fails
• Specify name servers to add to container
• Configure UID and GID for config files and blackhole for SABnzbd
• HTTPS (default, port 8443) and HTTP (port 8080) Web UI
• Created with Unraid⁠ in mind

⁠Run container from Docker registry

The container is available from the Docker registry and this is the simplest way to get it
To run the container use this command, with additional parameters, please refer to the Variables, Volumes, and Ports section:

⁠Docker run example

$ docker run --privileged  -d \
              -v /your/config/path/:/config \
              -v /your/downloads/path/:/downloads \
              -e "VPN_ENABLED=yes" \
              -e "VPN_TYPE=wireguard" \
              -e "LAN_NETWORK=192.168.0.0/24" \
              -e "NAME_SERVERS=1.1.1.1,1.0.0.1" \
              -p 8080:8080 \
              --restart unless-stopped \
              kalazzerx/sabnzbdvpn

⁠Docker Compose example

This example uses pia vpn service

---
version: "3.4"
services:
  sabnzbd:
    image: kalazzerx/sabnzbdvpn:latest
    container_name: sabnzbdvpn
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=America/Chicago
      - VPN_ENABLED=yes
      - VPN_CLIENT=wireguard
      - VPN_PROV=pia
      - VPN_USER={pia vpn user}
      - VPN_PASS={pia vpn password}
      - STRICT_PORT_FORWARD=yes
      - ENABLE_PRIVOXY=yes
      - VPN_INPUT_PORTS=1234
      - VPN_OUTPUT_PORTS=5678
      - DEBUG=false
      - UMASK=0022
      - LAN_NETWORK={your local network/24} 192.168.0.0/24
      - 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

    volumes:
      - /sabnzbd/config:/config
      - /sabnzbd/incomplete:/incomplete-downloads
      - /etc/localtime:/etc/localtime:ro
      - /media:/downloads
    ports:
      - 8889:8080
      - 8128:8118 
    restart: unless-stopped
    privileged: true
    cap_add:
      - NET_ADMIN
      - SYS_MODULE
    sysctls:
      - net.ipv4.conf.all.src_valid_mark=1

⁠Variables, Volumes, and Ports

⁠Environment Variables

⁠Volumes

⁠Ports

⁠Access the WebUI

Access https://IPADDRESS:PORT⁠ from a browser on the same network. (for example: http://192.168.0.90:8443⁠)

⁠How to use WireGuard

The container will fail to boot if VPN_ENABLED is set and there is no valid .conf file present in the /config/wireguard directory. Drop a .conf file from your VPN provider into /config/wireguard and start the container again. The file must have the name wg0.conf.

⁠How to use OpenVPN

The container will fail to boot if VPN_ENABLED is set and there is no valid .ovpn file present in the /config/openvpn directory. Drop a .ovpn file from your VPN provider into /config/openvpn and start the container again. You may need to edit the ovpn configuration file to load your VPN credentials from a file by setting auth-user-pass.

Note: The script will use the first ovpn file it finds in the /config/openvpn directory. Adding multiple ovpn files will not start multiple VPN connections.

⁠Example auth-user-pass option for .ovpn files

auth-user-pass credentials.conf

⁠Example credentials.conf

username
password

⁠PUID/PGID

User ID (PUID) and Group ID (PGID) can be found by issuing the following command for the user you want to run the container as:

id <username>

⁠Issues

If you are having issues with this container please submit an issue on GitHub.
Please provide logs, Docker version and other information that can simplify reproducing the issue.
If possible, always use the most up to date version of Docker, you operating system, kernel and the container itself. Support is always a best-effort basis.
I personally do not use SABnzbd, thus providing support about the product is nearly impossible for me.