mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Documentation

pull/38/head
LinuxServer-CI 2021-04-20 06:58:29 -04:00
rodzic 7f3c35688d
commit c4fffd1971
1 zmienionych plików z 21 dodań i 26 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

47
images/docker-nntp2nntp.md
Wyświetl plik

@ -1,6 +1,9 @@
---
title: nntp2nntp
---
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-nntp2nntp/blob/master/.github/CONTRIBUTING.md -->
# [linuxserver/nntp2nntp](https://github.com/linuxserver/docker-nntp2nntp)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-nntp2nntp.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-nntp2nntp)
@ -18,7 +21,6 @@ title: nntp2nntp
Whilst we know of no nntp2nntp security issues the [upstream code](https://github.com/linuxserver/nntp2nntp) 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
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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
@ -33,6 +35,20 @@ The architectures supported by this image are:
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
## 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
@ -64,7 +80,7 @@ services:
### docker cli
```
```bash
docker run -d \
--name=nntp2nntp \
-e PUID=1000 \
@ -78,7 +94,6 @@ docker run -d \
ghcr.io/linuxserver/nntp2nntp
```
## 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.
@ -89,7 +104,6 @@ Docker images are configured using parameters passed at runtime (such as those a
| :----: | --- |
| `1563` | will map the container's port 1563 to port 1563 on the host |
### Environment Variables (`-e`)
| Env | Function |
@ -106,15 +120,13 @@ Docker images are configured using parameters passed at runtime (such as those a
| :----: | --- |
| `/config` | this will store config on the docker host |
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
```
```bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
@ -125,7 +137,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
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](https://en.wikipedia.org/wiki/Umask) 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`.
@ -134,33 +145,17 @@ Ensure any volume directories on the host are owned by the same user you specify
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```
```bash
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## 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
```
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=nntp2nntp&query=%24.mods%5B%27nntp2nntp%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=nntp2nntp "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/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: