From 64508be8a77cc7d62b5054f986a066f57083d1b5 Mon Sep 17 00:00:00 2001 From: RandomNinjaAtk Date: Wed, 18 Mar 2020 19:28:31 -0400 Subject: [PATCH] Update README.md --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62effd7..6e42e0d 100644 --- a/README.md +++ b/README.md @@ -1 +1,39 @@ -# docker-sabnzbd-extended \ No newline at end of file +# [RandomNinjaAtk/sabnzbd-extended](https://github.com/RandomNinjaAtk/docker-sabnzbd-extended) + +This continer includes [SABnzbd](https://sabnzbd.org/) along with a set of post-processing scripts to enhance your SABnzbd usage + + +[![sabnzbd](https://raw.githubusercontent.com/RandomNinjaAtk/unraid-templates/master/randomninjaatk/img/sabnzbd-icon.png)](https://sabnzbd.org/) + +This containers base image is provided by: [linuxserver/sabnzbd](https://github.com/linuxserver/docker-sabnzbd) + + +## Supported Architectures + +The architectures supported by this image are: + +| Architecture | Tag | +| :----: | --- | +| x86-64 | amd64-latest | + +## Version Tags + +| Tag | Description | +| :----: | --- | +| latest | SAbnzbd + Extended Scripts + SMA | + +## Parameters + +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. + +| Parameter | Function | +| :----: | --- | +| `-p 8080` | The port for the Sonarr webinterface | +| `-e PUID=1000` | for UserID - see below for explanation | +| `-e PGID=1000` | for GroupID - see below for explanation | +| `-v /config` | Database and sonarr configs | +| `-v /storage` | Location of Downloads location | + +## Application Setup + +Access the webui at `:8080`, for more information check out [SABnzbd](https://sabnzbd.org/).