Bot Updating Templated Files

pull/1/head
LinuxServer-CI 2019-02-12 14:37:46 +00:00
rodzic d632f03cef
commit efb5ffa8ee
1 zmienionych plików z 119 dodań i 63 usunięć

Wyświetl plik

@ -1,74 +1,124 @@
[linuxserverurl]: https://linuxserver.io
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: http://nzbget.net/
[hub]: https://hub.docker.com/r/linuxserver/nzbget/
# [linuxserver/nzbget](https://github.com/linuxserver/docker-nzbget)
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/nzbget.svg)](https://microbadger.com/images/linuxserver/nzbget "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/nzbget.svg)](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)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nzbget.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-nzbget/master)](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)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
* [forum.linuxserver.io][forumurl]
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
[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.
# linuxserver/nzbget
[![](https://images.microbadger.com/badges/version/linuxserver/nzbget.svg)](https://microbadger.com/images/linuxserver/nzbget "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/nzbget.svg)](https://microbadger.com/images/linuxserver/nzbget "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nzbget.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nzbget.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-nzbget)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-nzbget/)
## Supported Architectures
[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.
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
[![nzbget](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/nzbget-banner.png)][appurl]
Simply pulling `linuxserver/nzbget` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
## Version Tags
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 |
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
```
docker create \
--name nzbget \
-p 6789:6789 \
-e PUID=<UID> -e PGID=<GID> \
-e TZ=<timezone> \
-v </path/to/appdata>:/config \
-v <path/to/downloads>:/downloads \
linuxserver/nzbget
--name=nzbget \
-e PUID=1001 \
-e PGID=1001 \
-e TZ=Europe/London \
-p 6789:6789 \
-v <path to data>:/config \
-v <path/to/downloads>:/downloads \
--restart unless-stopped \
linuxserver/nzbget
```
This container is based on alpine linux with s6 overlay. For shell access whilst the container is running do `docker exec -it nzbget /bin/bash`.
You can choose between ,using tags, various branch versions of nzbget, no tag is required to remain on the main branch.
### docker-compose
Add one of the tags, if required, to the linuxserver/nzbget line of the run/create command in the following format, linuxserver/nzbget:testing
Compatible with docker-compose v2 schemas.
#### Tags
+ **testing**
```yaml
---
version: "2"
services:
nzbget:
image: linuxserver/nzbget
container_name: nzbget
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
volumes:
- <path to data>:/config
- <path/to/downloads>:/downloads
ports:
- 6789:6789
mem_limit: 4096m
restart: unless-stopped
```
## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` 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`)
| Parameter | Function |
| :----: | --- |
| `6789` | WebUI |
* `-p 6789` - NZBGet WebUI Port
* `-v /config` - NZBGet App data
* `-v /downloads` - location of downloads on disk
* `-e PGID` for for GroupID - see below for explanation
* `-e PUID` for for UserID - see below for explanation
* `-e TZ` for timezone EG. Europe/London
### Environment Variables (`-e`)
| Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
### Volume Mappings (`-v`)
| Volume | Function |
| :----: | --- |
| `/config` | NZBGet App data. |
| `/downloads` | Location of downloads on disk. |
### User / Group Identifiers
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
## User / Group Identifiers
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
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=1001` and `PGID=1001`, to find yours use `id user` as below:
```
$ id <dockeruser>
$ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
## Setting up the application
## Application Setup
Webui can be found at `<your-ip>:6789` and the default login details (change ASAP) are
@ -84,32 +134,38 @@ scroll to bottom, set umask like this (example shown for unraid)
![](http://i.imgur.com/mIqDEJJ.png)
You can add an additional mount point for intermediate unpacking folder with:-
## Info
* Shell access whilst the container is running: `docker exec -it nzbget /bin/bash`
To monitor the logs of the container in realtime: `docker logs -f nzbget`
`-v </path/to/intermedia_unpacking_folder>:/intermediate`
* container version number
for example, and changing the setting for InterDir in the PATHS tab of settings to `/intermediate`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbget`
* image version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/nzbget`
## Support Info
* Shell access whilst the container is running:
* `docker exec -it nzbget /bin/bash`
* To monitor the logs of the container in realtime:
* `docker logs -f nzbget`
* Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbget`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/nzbget`
## Versions
+ **20.01.19:** Add pipeline logic and multi arch.
+ **21.08.18:** Rebase to alpine 3.8.
+ **20.02.18:** Add note about supplemental mount point for intermediate unpacking.
+ **13.12.17:** Rebase to alpine 3.7.
+ **02.09.17:** Place app in subfolder rather than /app.
+ **12.07.17:** Add inspect commands to README, move to jenkins build and push.
+ **28.05.17:** Rebase to alpine 3.6.
+ **20.04.17:** Add testing branch.
+ **06.02.17:** Rebase to alpine 3.5.
+ **30.09.16:** Fix umask.
+ **09.09.16:** Add layer badges to README.
+ **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.
* **20.01.19:** - Add pipeline logic and multi arch, build from source.
* **21.08.18:** - Rebase to alpine 3.8.
* **20.02.18:** - Add note about supplemental mount point for intermediate unpacking.
* **13.12.17:** - Rebase to alpine 3.7.
* **02.09.17:** - Place app in subfolder rather than /app.
* **12.07.17:** - Add inspect commands to README, move to jenkins build and push.
* **28.05.17:** - Rebase to alpine 3.6.
* **20.04.17:** - Add testing branch.
* **06.02.17:** - Rebase to alpine 3.5.
* **30.09.16:** - Fix umask.
* **09.09.16:** - Add layer badges to README.
* **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.