Bot Updating Documentation

pull/45/head
LinuxServer-CI 2021-10-10 20:43:45 +02:00
rodzic 314dd06d53
commit 373eb51c4e
1 zmienionych plików z 13 dodań i 10 usunięć

Wyświetl plik

@ -10,7 +10,7 @@ title: nntp2nntp
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-nntp2nntp.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-nntp2nntp/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-nntp2nntp/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-nntp2nntp/container_registry)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/nntp2nntp.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/nntp2nntp "Get your own version badge on microbadger.com")
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/nntp2nntp)
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nntp2nntp.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/nntp2nntp)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nntp2nntp.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/nntp2nntp)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-nntp2nntp%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nntp2nntp/job/master/)
@ -25,7 +25,7 @@ Whilst we know of no nntp2nntp security issues the [upstream code](https://githu
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/).
Simply pulling `ghcr.io/linuxserver/nntp2nntp` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
Simply pulling `lscr.io/linuxserver/nntp2nntp` 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:
@ -52,18 +52,16 @@ Dave = 5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8
## Usage
Here are some example snippets to help you get started creating a container from this image.
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
Compatible with docker-compose v2 schemas.
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
```yaml
---
version: "2.1"
services:
nntp2nntp:
image: ghcr.io/linuxserver/nntp2nntp
image: lscr.io/linuxserver/nntp2nntp
container_name: nntp2nntp
environment:
- PUID=1000
@ -78,7 +76,7 @@ services:
restart: unless-stopped
```
### docker cli
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
```bash
docker run -d \
@ -91,7 +89,7 @@ docker run -d \
-p 1563:1563 \
-v <path to data>:/config \
--restart unless-stopped \
ghcr.io/linuxserver/nntp2nntp
lscr.io/linuxserver/nntp2nntp
```
## Parameters
@ -120,6 +118,11 @@ Docker images are configured using parameters passed at runtime (such as those a
| :----: | --- |
| `/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__`.
@ -165,7 +168,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
* Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' nntp2nntp`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/nntp2nntp`
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nntp2nntp`
## Versions