From 82cea28b84773d3c122f7cff90de22852e2fe2fb Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 2 Oct 2019 02:38:57 -0400 Subject: [PATCH] Bot Updating Templated Files --- images/docker-nzbget.md | 45 +++++++++++++++++++++++++---------------- 1 file changed, 28 insertions(+), 17 deletions(-) diff --git a/images/docker-nzbget.md b/images/docker-nzbget.md index ca149ea44..32ae9415d 100644 --- a/images/docker-nzbget.md +++ b/images/docker-nzbget.md @@ -1,6 +1,12 @@ -# linuxserver/nzbget +# [linuxserver/nzbget](https://github.com/linuxserver/docker-nzbget) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-nzbget.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-nzbget/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/nzbget.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/nzbget) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/nzbget.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/nzbget) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nzbget.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/nzbget) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nzbget.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/nzbget) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-nzbget/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nzbget/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/index.html) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-nzbget.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-nzbget/releases) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/nzbget.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/nzbget "Get your own version badge on microbadger.com") +[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/nzbget.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/nzbget "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nzbget.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/nzbget) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nzbget.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/nzbget) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-nzbget/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nzbget/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/index.html) [Nzbget](http://nzbget.net/) is a usenet downloader, written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources. @@ -13,7 +19,7 @@ Simply pulling `linuxserver/nzbget` should retrieve the correct image for your a The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | @@ -23,7 +29,7 @@ The architectures supported by this image are: This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them. | Tag | Description | -| :---: | :--- | +| :----: | --- | | latest | Stable nzbget releases | | testing | nzbget pre-releases | @@ -33,7 +39,7 @@ Here are some example snippets to help you get started creating a container from ### docker -```text +``` docker create \ --name=nzbget \ -e PUID=1000 \ @@ -46,6 +52,7 @@ docker create \ linuxserver/nzbget ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -71,45 +78,48 @@ services: ## Parameters -Docker 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. +Docker 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. -### Ports \(`-p`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `6789` | WebUI | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | NZBGet App data. | | `/downloads` | Location of downloads on disk. | + + ## User / Group Identifiers -When using volumes \(`-v` flags\), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. +When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` ## Application Setup -Webui can be found at `:6789` and the default login details \(change ASAP\) are +Webui can be found at `:6789` and the default login details (change ASAP) are `login:nzbget, password:tegbzn6789` @@ -119,7 +129,7 @@ To change umask settings. ![](http://i.imgur.com/A4VMbwE.png) -scroll to bottom, set umask like this \(example shown for unraid\) +scroll to bottom, set umask like this (example shown for unraid) ![](http://i.imgur.com/mIqDEJJ.png) @@ -129,6 +139,8 @@ You can add an additional mount point for intermediate unpacking folder with:- for example, and changing the setting for InterDir in the PATHS tab of settings to `/intermediate` + + ## Support Info * Shell access whilst the container is running: @@ -160,4 +172,3 @@ for example, and changing the setting for InterDir in the PATHS tab of settings * **27.08.16:** - Add badges to README, perms fix on /app to allow updates. * **19.08.16:** - Rebase to alpine linux. * **18.08.15:** - Now useing latest version of unrar beta and implements the universal installer method. -