10 KiB
title |
---|
nntp2nntp |
DEPRECATION NOTICE
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/nntp2nntp
Nntp2nntp proxy allow you to use your NNTP Account from multiple systems, each with own user name and password. It fully supports SSL and you can also limit the access to proxy with SSL certificates. nntp2nntp proxy is very simple and pretty fast.
Warning
Whilst we know of no nntp2nntp security issues the upstream code for this project has received no changes since 06.08.15 and is likely abandoned permanently. For this reason we strongly recommend you do not make this application public facing and if you must do so other layers of security and SSL should be considered an absolute bare minimum requirement. We see this proxy being used primarily on a LAN so that all the users NNTP applications can share a common set of internal credentials allowing for central managment of the upstream account e.g change provider, server, thread limits for all applications with one global config change.
Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/nntp2nntp:latest
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 | Available | Tag |
---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ❌ |
Application Setup
Edit sample config file config/nntp2nntp.conf
with upstream provider details and rename the local users.
New user passwords can be created by running the password hash generator
docker exec -it nntp2nntp /usr/bin/nntp2nntp.py pass
entering the desired password and copying the resulting string to the relevant user line in /config/nntp2nntp.conf
Example with a user called Dave
and with a password of password
Dave = 5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
---
version: "2.1"
services:
nntp2nntp:
image: lscr.io/linuxserver/nntp2nntp:latest
container_name: nntp2nntp
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- PUID=<yourUID>
- PGID=<yourGID>
volumes:
- <path to data>:/config
ports:
- 1563:1563
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=nntp2nntp \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e PUID=<yourUID> \
-e PGID=<yourGID> \
-p 1563:1563 \
-v <path to data>:/config \
--restart unless-stopped \
lscr.io/linuxserver/nntp2nntp:latest
Parameters
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 |
---|---|
1563 |
will map the container's port 1563 to port 1563 on the host |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
TZ=Etc/UTC |
specify a timezone to use, see this list. |
PUID=<yourUID> |
specify your UID |
PGID=<yourGID> |
specify your GID |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
this will store config on the docker host |
Miscellaneous Options
Parameter | Function |
---|
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD
based on the contents of the /run/secrets/mysecretpassword
file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022
setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
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
.
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:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Docker Mods
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
- Shell access whilst the container is running:
docker exec -it nntp2nntp /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f nntp2nntp
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nntp2nntp
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nntp2nntp:latest
Versions
- 04.07.23: - Deprecate container.
- 04.07.23: - Deprecate armhf. As announced here
- 10.10.22: - Rebase to Alpine 3.15.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.04.19: - Multiarch builds and build from Github fork.
- 15.05.18: - Initial Release.