Skip to content

Commit fd4771a

Browse files
authored
Merge pull request #63 from thelamer/testing
adding dynamic readme
2 parents 61d01a7 + 8da28ee commit fd4771a

2 files changed

Lines changed: 215 additions & 168 deletions

File tree

‎README.md‎

Lines changed: 147 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,134 @@
1-
[linuxserverurl]: https://linuxserver.io
2-
[forumurl]: https://forum.linuxserver.io
3-
[ircurl]: https://www.linuxserver.io/irc/
4-
[podcasturl]: https://www.linuxserver.io/podcast/
5-
[appurl]: http://nzbget.net/
6-
[hub]: https://hub.docker.com/r/linuxserver/nzbget/
1+
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
72

8-
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
3+
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
94

10-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
11-
* [forum.linuxserver.io][forumurl]
12-
* [IRC][ircurl] on freenode at `#linuxserver.io`
13-
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
5+
* regular and timely application updates
6+
* easy user mappings (PGID, PUID)
7+
* custom base image with s6 overlay
8+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
9+
* regular security updates
1410

15-
# linuxserver/nzbget
16-
[![](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/)
11+
Find us at:
12+
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
13+
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
14+
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
15+
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
1716

18-
[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.
17+
# PSA: Changes are happening
1918

20-
[![nzbget](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/nzbget-banner.png)][appurl]
19+
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
20+
21+
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
22+
23+
# [linuxserver/nzbget](https://github.com/linuxserver/docker-nzbget)
24+
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
25+
[![](https://images.microbadger.com/badges/version/linuxserver/nzbget.svg)](https://microbadger.com/images/linuxserver/nzbget "Get your own version badge on microbadger.com")
26+
[![](https://images.microbadger.com/badges/image/linuxserver/nzbget.svg)](https://microbadger.com/images/linuxserver/nzbget "Get your own version badge on microbadger.com")
27+
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nzbget.svg)
28+
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nzbget.svg)
29+
[![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/)
30+
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/index.html)
31+
32+
[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.
33+
34+
[![nzbget](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/nzbget-banner.png)](http://nzbget.net/)
35+
36+
## Supported Architectures
37+
38+
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).
39+
40+
Simply pulling `linuxserver/nzbget` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
41+
42+
The architectures supported by this image are:
43+
44+
| Architecture | Tag |
45+
| :----: | --- |
46+
| x86-64 | amd64-latest |
47+
| arm64 | arm64v8-latest |
48+
| armhf | arm32v6-latest |
49+
50+
## Version Tags
51+
52+
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.
53+
54+
| Tag | Description |
55+
| :----: | --- |
56+
| latest | Stable nzbget releases |
57+
| testing | nzbget pre-releases |
2158

2259
## Usage
2360

61+
Here are some example snippets to help you get started creating a container.
62+
63+
### docker
64+
2465
```
2566
docker create \
26-
--name nzbget \
27-
-p 6789:6789 \
28-
-e PUID=<UID> -e PGID=<GID> \
29-
-e TZ=<timezone> \
30-
-v </path/to/appdata>:/config \
31-
-v <path/to/downloads>:/downloads \
32-
linuxserver/nzbget
67+
--name=nzbget \
68+
-e PUID=1001 \
69+
-e PGID=1001 \
70+
-e TZ=Europe/London \
71+
-p 6789:6789 \
72+
-v <path to data>:/config \
73+
-v <path/to/downloads>:/downloads \
74+
--restart unless-stopped \
75+
linuxserver/nzbget
3376
```
3477

35-
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`.
3678

37-
You can choose between ,using tags, various branch versions of nzbget, no tag is required to remain on the main branch.
79+
### docker-compose
3880

39-
Add one of the tags, if required, to the linuxserver/nzbget line of the run/create command in the following format, linuxserver/nzbget:testing
81+
Compatible with docker-compose v2 schemas.
4082

41-
#### Tags
42-
+ **testing**
83+
```
84+
---
85+
version: "2"
86+
services:
87+
nzbget:
88+
image: linuxserver/nzbget
89+
container_name: nzbget
90+
environment:
91+
- PUID=1001
92+
- PGID=1001
93+
- TZ=Europe/London
94+
volumes:
95+
- <path to data>:/config
96+
- <path/to/downloads>:/downloads
97+
ports:
98+
- 6789:6789
99+
mem_limit: 4096m
100+
restart: unless-stopped
101+
```
43102

44103
## Parameters
45104

46-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
47-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
48-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
49-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
50-
105+
Container 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.
51106

52-
* `-p 6789` - NZBGet WebUI Port
53-
* `-v /config` - NZBGet App data
54-
* `-v /downloads` - location of downloads on disk
55-
* `-e PGID` for for GroupID - see below for explanation
56-
* `-e PUID` for for UserID - see below for explanation
57-
* `-e TZ` for timezone EG. Europe/London
107+
| Parameter | Function |
108+
| :----: | --- |
109+
| `-p 6789` | WebUI |
110+
| `-e PUID=1001` | for UserID - see below for explanation |
111+
| `-e PGID=1001` | for GroupID - see below for explanation |
112+
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
113+
| `-v /config` | NZBGet App data. |
114+
| `-v /downloads` | Location of downloads on disk. |
58115

116+
## User / Group Identifiers
59117

60-
### User / Group Identifiers
118+
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`.
61119

62-
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" ™.
120+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
63121

64-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
122+
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
65123

66124
```
67-
$ id <dockeruser>
125+
$ id username
68126
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
69127
```
70128

71-
## Setting up the application
129+
130+
&nbsp;
131+
## Application Setup
72132

73133
Webui can be found at `<your-ip>:6789` and the default login details (change ASAP) are
74134

@@ -84,32 +144,55 @@ scroll to bottom, set umask like this (example shown for unraid)
84144

85145
![](http://i.imgur.com/mIqDEJJ.png)
86146

147+
You can add an additional mount point for intermediate unpacking folder with:-
87148

88-
## Info
89-
* Shell access whilst the container is running: `docker exec -it nzbget /bin/bash`
90-
To monitor the logs of the container in realtime: `docker logs -f nzbget`
149+
`-v </path/to/intermedia_unpacking_folder>:/intermediate`
91150

92-
* container version number
151+
for example, and changing the setting for InterDir in the PATHS tab of settings to `/intermediate`
93152

94-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbget`
95153

96-
* image version number
97154

98-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/nzbget`
155+
## Support Info
156+
157+
* Shell access whilst the container is running: `docker exec -it nzbget /bin/bash`
158+
* To monitor the logs of the container in realtime: `docker logs -f nzbget`
159+
* container version number
160+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbget`
161+
* image version number
162+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/nzbget`
163+
164+
## Updating Info
165+
166+
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
167+
168+
Below are the instructions for updating containers:
169+
170+
### Via Docker Run/Create
171+
* Update the image: `docker pull linuxserver/nzbget`
172+
* Stop the running container: `docker stop nzbget`
173+
* Delete the container: `docker rm nzbget`
174+
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
175+
* Start the new container: `docker start nzbget`
176+
* You can also remove the old dangling images: `docker image prune`
177+
178+
### Via Docker Compose
179+
* Update the image: `docker-compose pull linuxserver/nzbget`
180+
* Let compose update containers as necessary: `docker-compose up -d`
181+
* You can also remove the old dangling images: `docker image prune`
99182

100183
## Versions
101184

102-
+ **20.01.19:** Add pipeline logic and multi arch.
103-
+ **21.08.18:** Rebase to alpine 3.8.
104-
+ **20.02.18:** Add note about supplemental mount point for intermediate unpacking.
105-
+ **13.12.17:** Rebase to alpine 3.7.
106-
+ **02.09.17:** Place app in subfolder rather than /app.
107-
+ **12.07.17:** Add inspect commands to README, move to jenkins build and push.
108-
+ **28.05.17:** Rebase to alpine 3.6.
109-
+ **20.04.17:** Add testing branch.
110-
+ **06.02.17:** Rebase to alpine 3.5.
111-
+ **30.09.16:** Fix umask.
112-
+ **09.09.16:** Add layer badges to README.
113-
+ **27.08.16:** Add badges to README, perms fix on /app to allow updates.
114-
+ **19.08.16:** Rebase to alpine linux.
115-
+ **18.08.15:** Now useing latest version of unrar beta and implements the universal installer method.
185+
* **20.01.19:** - Add pipeline logic and multi arch, build from source.
186+
* **21.08.18:** - Rebase to alpine 3.8.
187+
* **20.02.18:** - Add note about supplemental mount point for intermediate unpacking.
188+
* **13.12.17:** - Rebase to alpine 3.7.
189+
* **02.09.17:** - Place app in subfolder rather than /app.
190+
* **12.07.17:** - Add inspect commands to README, move to jenkins build and push.
191+
* **28.05.17:** - Rebase to alpine 3.6.
192+
* **20.04.17:** - Add testing branch.
193+
* **06.02.17:** - Rebase to alpine 3.5.
194+
* **30.09.16:** - Fix umask.
195+
* **09.09.16:** - Add layer badges to README.
196+
* **27.08.16:** - Add badges to README, perms fix on /app to allow updates.
197+
* **19.08.16:** - Rebase to alpine linux.
198+
* **18.08.15:** - Now useing latest version of unrar beta and implements the universal installer method.

0 commit comments

Comments
 (0)