Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

instructions for docker and linux #353

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions wiki/installation/install-docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Installation of SABnzbd docker

If there is no ready-made SABnzbd package for your operating system or NAS, this page is for you.

If you're able to use Docker on your operating system or NAS, SABnzbd based on docker can be a very nice solution
as the docker image contains all needed software.
And a docker image can directly land on your system, without the need for intermediate developers and release processes.

Worth knowing:
* docker itself has a learning curve
* docker is an isolated container, so you need to take care of mapping to the host:
* port for the Web interface (normally 8080)
* Config Folder
* Completed Download Folder
* performance of SABnzbd within docker can be a bit lower than straight on OS & hardware


## SABnzbd docker images

You can find SABnzbd docker images via https://hub.docker.com/search?q=sabnzbd

The most used SABnzbd docker image is linuxserver.io's image: https://hub.docker.com/r/linuxserver/sabnzbd

Note: SABnzbd docker images are not provided by the SABnzbd team, but by third parties.


## GUI / Graphical User Interface

If your OS or NAS provides a GUI to install & configure docker,
it's probably the easiest way to find, install, configure & manage SABnzbd docker that way.

Examples of NAS solution that offer a GUI for docker: (modern) Synology devices and Unraid.

Check your NAS how to install & configure docker.

## Non-GUI: docker-compose and commandline

This is the harder way.

See the page of your SABnzbd image how to start via docker-compose or from the commandline.
In case of linuxserver.io's image: https://docs.linuxserver.io/images/docker-sabnzbd/#usage

Pay extra attention to the mapping of port and folders: this is often the more difficult part for users.


35 changes: 35 additions & 0 deletions wiki/installation/install-linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Linux


Depending on the Linux distribution you're using, there are different

# Ubuntu

SABnzbd is in the repository as "sabnzbdplus".
If you want updates: use jcfp's PPA

See [details](/wiki/installation/install-ubuntu-repo.html)

# Debian:

SABnzbd is in the repository as "sabnzbdplus".

See [details](/wiki/installation/install-debian.md)

# Flatpak

See https://flathub.org/apps/org.sabnzbd.sabnzbd

# Snap

See https://snapcraft.io/sabnzbd

# Docker

See [docker instructions](/wiki/installation/install-docker.md)

* From source

See [source instructions](/wiki/installation/install-off-modules.html)