sabnzbdvpn

sabnzbdvpn

Docker app from Dyon's Repository

Overview

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

SABnzbd - The automated Usenet download tool

License Join our Discord

SABnzbd is an Open Source Binary Newsreader written in Python.

It's totally free, easy to use, and works practically everywhere. SABnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction. SABnzbd offers an easy setup wizard and has self-analysis tools to verify your setup.

If you want to know more you can head over to our website: https://sabnzbd.org.

Resolving Dependencies

SABnzbd has a few dependencies you'll need before you can get running. If you've previously run SABnzbd from one of the various Linux packages, then you likely already have all the needed dependencies. If not, here's what you're looking for:

  • python (Python 3.10 and above, often called python3)
  • Python modules listed in requirements.txt. Install with python3 -m pip install -r requirements.txt
  • par2 (Multi-threaded par2 installation guide can be found here)
  • unrar (make sure you get the "official" non-free version of unrar)

Optional:

  • See requirements.txt

Your package manager should supply these. If not, we've got links in our installation guide.

Running SABnzbd from source

Once you've sorted out all the dependencies, simply run:

python3 -OO SABnzbd.py

Or, if you want to run in the background:

python3 -OO SABnzbd.py -d -f /path/to/sabnzbd.ini

If you want multi-language support, run:

python3 tools/make_mo.py

Our many other command line options are explained in depth here.

About Our Repo

The workflow we use, is a simplified form of "GitFlow". Basically:

  • master contains only stable releases (which have been merged to master) and is intended for end-users.
  • develop is the target for integration and is not intended for end-users.
  • 1.1.x is a release and maintenance branch for 1.1.x (1.1.0 -> 1.1.1 -> 1.1.2) and is not intended for end-users.
  • feature/my_feature is a temporary feature branch based on develop.
  • bugfix/my_bugfix is an optional temporary branch for bugfix(es) based on develop.

Conditions:

  • Merging of a stable release into master will be simple: the release branch is always right.
  • master is not merged back to develop.
  • develop is not re-based on master.
  • Release branches branch from develop only.
  • Bugfixes created specifically for a release branch are done there (because they are specific, they're not cherry-picked to develop).
  • Bugfixes done on develop may be cherry-picked to a release branch.
  • We will not release a 1.0.2 if a 1.1.0 has already been released.

Privacy Policy

This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.

Code Signing Policy

For our Windows release, free code signing is provided by SignPath.io, certificate by SignPath Foundation.

Install Sabnzbdvpn on Unraid in a few clicks.

Find Sabnzbdvpn in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Sabnzbdvpn Review the template variables and paths Click Install

Categories

Download Statistics

84,782
Total Downloads
453
This Month
984
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Explore more like this

Explore all

Details

Repository
dyonr/sabnzbdvpn
Last Updated2022-11-21
First Seen2020-08-20

Runtime arguments

Web UI
https://[IP]:[PORT:8443]/
Network
bridge
Shell
bash
Privileged
true
Extra Params
--restart unless-stopped

Template configuration

VPN_ENABLEDVariable

Enable VPN? yes/no

Default
yes
Value
yes
VPN_TYPEVariable

openvpn / wireguard?

Default
openvpn
Value
openvpn
VPN_USERNAMEVariable

Username used to authenticate to the VPN (OpenVPN only)

VPN_PASSWORDVariable

Password used to authenticate to the VPN (OpenVPN only)

LAN_NETWORKVariable

Your local network address in CIDR notation

Default
192.168.0.0/24
Value
192.168.0.0/24
Downloads PathPathrw

Path for /downloads

Target
/downloads
WEBUI_PORT_HTTPPorttcp

Port used to access SABnzbd (HTTP) remotely

Target
8080
Default
8080
Value
8080
WEBUI_PORT_HTTPSPorttcp

Port used to access SABnzbd (HTTPS) remotely

Target
8443
Default
8443
Value
8443
PUIDVariable

The UID applied to the /config and /downloads

Default
99
Value
99
PGIDVariable

The GID applied to the /config and /downloads

Default
100
Value
100
NAME_SERVERSVariable

DNS used by the container

Default
1.1.1.1,1.0.0.1
Value
1.1.1.1,1.0.0.1
UMASKVariable

umask used by the container

Default
002
Value
002
HEALTH_CHECK_HOSTVariable

Host used to check if connection is up

Default
one.one.one.one
Value
one.one.one.one
HEALTH_CHECK_INTERVALVariable

Interval in seconds between connection check

Default
300
Value
300
HEALTH_CHECK_SILENTVariable

1 supresses the 'Network is up' message

Default
1
Value
1
ADDITIONAL_PORTSVariable

Additional ports for routing other containers through this one

configPathrw

config path of sabnzbdvpn

Target
/config
Default
/mnt/user/appdata/sabnzbdvpn/
Value
/mnt/user/appdata/sabnzbdvpn/