From 31a131204a2f33cff9343520bd2722ed1bead630 Mon Sep 17 00:00:00 2001 From: Eric Nemchik Date: Mon, 9 Oct 2023 18:58:35 -0500 Subject: [PATCH 1/2] feat: :sparkles: add privoxyvpn Signed-off-by: Eric Nemchik --- .../.apps/privoxyvpn/privoxyvpn.aarch64.yml | 3 ++ .../.apps/privoxyvpn/privoxyvpn.hostname.yml | 3 ++ .../.apps/privoxyvpn/privoxyvpn.labels.yml | 24 ++++++++++++ .../.apps/privoxyvpn/privoxyvpn.netmode.yml | 3 ++ compose/.apps/privoxyvpn/privoxyvpn.ports.yml | 5 +++ .../.apps/privoxyvpn/privoxyvpn.x86_64.yml | 3 ++ compose/.apps/privoxyvpn/privoxyvpn.yml | 39 +++++++++++++++++++ 7 files changed, 80 insertions(+) create mode 100644 compose/.apps/privoxyvpn/privoxyvpn.aarch64.yml create mode 100644 compose/.apps/privoxyvpn/privoxyvpn.hostname.yml create mode 100644 compose/.apps/privoxyvpn/privoxyvpn.labels.yml create mode 100644 compose/.apps/privoxyvpn/privoxyvpn.netmode.yml create mode 100644 compose/.apps/privoxyvpn/privoxyvpn.ports.yml create mode 100644 compose/.apps/privoxyvpn/privoxyvpn.x86_64.yml create mode 100644 compose/.apps/privoxyvpn/privoxyvpn.yml diff --git a/compose/.apps/privoxyvpn/privoxyvpn.aarch64.yml b/compose/.apps/privoxyvpn/privoxyvpn.aarch64.yml new file mode 100644 index 0000000000..6d42522c00 --- /dev/null +++ b/compose/.apps/privoxyvpn/privoxyvpn.aarch64.yml @@ -0,0 +1,3 @@ +services: + privoxyvpn: + image: ghcr.io/binhex/arch-privoxyvpn:${PRIVOXYVPN_TAG} diff --git a/compose/.apps/privoxyvpn/privoxyvpn.hostname.yml b/compose/.apps/privoxyvpn/privoxyvpn.hostname.yml new file mode 100644 index 0000000000..9d7bb9a117 --- /dev/null +++ b/compose/.apps/privoxyvpn/privoxyvpn.hostname.yml @@ -0,0 +1,3 @@ +services: + privoxyvpn: + hostname: ${DOCKERHOSTNAME} diff --git a/compose/.apps/privoxyvpn/privoxyvpn.labels.yml b/compose/.apps/privoxyvpn/privoxyvpn.labels.yml new file mode 100644 index 0000000000..1b53e670ea --- /dev/null +++ b/compose/.apps/privoxyvpn/privoxyvpn.labels.yml @@ -0,0 +1,24 @@ +services: + privoxyvpn: + labels: + com.dockstarter.appinfo.deprecated: "false" + com.dockstarter.appinfo.description: "Privoxy, microsocks, OpenVPN, WireGuard" + com.dockstarter.appinfo.nicename: "PrivoxyVPN" + com.dockstarter.appvars.privoxyvpn_enable_privoxy: "no" + com.dockstarter.appvars.privoxyvpn_enable_socks: "no" + com.dockstarter.appvars.privoxyvpn_enabled: "false" + com.dockstarter.appvars.privoxyvpn_lan_network: "192.168.x.x/24" + com.dockstarter.appvars.privoxyvpn_name_servers: "1.1.1.1,8.8.8.8" + com.dockstarter.appvars.privoxyvpn_network_mode: "" + com.dockstarter.appvars.privoxyvpn_restart: "unless-stopped" + com.dockstarter.appvars.privoxyvpn_socks_pass: "your-socks-pass" + com.dockstarter.appvars.privoxyvpn_socks_user: "your-socks-user" + com.dockstarter.appvars.privoxyvpn_tag: "latest" + com.dockstarter.appvars.privoxyvpn_vpn_client: "openvpn" + com.dockstarter.appvars.privoxyvpn_vpn_enable: "no" + com.dockstarter.appvars.privoxyvpn_vpn_input_ports: "" + com.dockstarter.appvars.privoxyvpn_vpn_options: "" + com.dockstarter.appvars.privoxyvpn_vpn_output_ports: "" + com.dockstarter.appvars.privoxyvpn_vpn_pass: "your-vpn-pass" + com.dockstarter.appvars.privoxyvpn_vpn_prov: "custom" + com.dockstarter.appvars.privoxyvpn_vpn_user: "your-vpn-user" diff --git a/compose/.apps/privoxyvpn/privoxyvpn.netmode.yml b/compose/.apps/privoxyvpn/privoxyvpn.netmode.yml new file mode 100644 index 0000000000..428aeb86c7 --- /dev/null +++ b/compose/.apps/privoxyvpn/privoxyvpn.netmode.yml @@ -0,0 +1,3 @@ +services: + privoxyvpn: + network_mode: ${PRIVOXYVPN_NETWORK_MODE} diff --git a/compose/.apps/privoxyvpn/privoxyvpn.ports.yml b/compose/.apps/privoxyvpn/privoxyvpn.ports.yml new file mode 100644 index 0000000000..aaaee0023f --- /dev/null +++ b/compose/.apps/privoxyvpn/privoxyvpn.ports.yml @@ -0,0 +1,5 @@ +services: + privoxyvpn: + ports: + - ${PRIVOXYVPN_PORT_8118}:8118 + - ${PRIVOXYVPN_PORT_9118}:9118 diff --git a/compose/.apps/privoxyvpn/privoxyvpn.x86_64.yml b/compose/.apps/privoxyvpn/privoxyvpn.x86_64.yml new file mode 100644 index 0000000000..6d42522c00 --- /dev/null +++ b/compose/.apps/privoxyvpn/privoxyvpn.x86_64.yml @@ -0,0 +1,3 @@ +services: + privoxyvpn: + image: ghcr.io/binhex/arch-privoxyvpn:${PRIVOXYVPN_TAG} diff --git a/compose/.apps/privoxyvpn/privoxyvpn.yml b/compose/.apps/privoxyvpn/privoxyvpn.yml new file mode 100644 index 0000000000..b7fc6ea572 --- /dev/null +++ b/compose/.apps/privoxyvpn/privoxyvpn.yml @@ -0,0 +1,39 @@ +services: + privoxyvpn: + cap_add: + - NET_ADMIN + - SYS_MODULE + container_name: privoxyvpn + devices: + - /dev/net/tun + environment: + - ENABLE_PRIVOXY=${PRIVOXYVPN_ENABLE_PRIVOXY} + - ENABLE_SOCKS=${PRIVOXYVPN_ENABLE_SOCKS} + - LAN_NETWORK=${PRIVOXYVPN_LAN_NETWORK} + - NAME_SERVERS=${PRIVOXYVPN_NAME_SERVERS} + - PGID=${PGID} + - PUID=${PUID} + - SOCKS_PASS=${PRIVOXYVPN_SOCKS_PASS} + - SOCKS_USER=${PRIVOXYVPN_SOCKS_USER} + - TZ=${TZ} + - VPN_CLIENT=${PRIVOXYVPN_VPN_CLIENT} + - VPN_ENABLED=${PRIVOXYVPN_VPN_ENABLE} + - VPN_INPUT_PORTS=${PRIVOXYVPN_VPN_INPUT_PORTS} + - VPN_OPTIONS=${PRIVOXYVPN_VPN_OPTIONS} + - VPN_OUTPUT_PORTS=${PRIVOXYVPN_VPN_OUTPUT_PORTS} + - VPN_PASS=${PRIVOXYVPN_VPN_PASS} + - VPN_PROV=${PRIVOXYVPN_VPN_PROV} + - VPN_USER=${PRIVOXYVPN_VPN_USER} + logging: + driver: json-file + options: + max-file: ${DOCKERLOGGING_MAXFILE} + max-size: ${DOCKERLOGGING_MAXSIZE} + privileged: true + restart: ${PRIVOXYVPN_RESTART} + sysctls: + - net.ipv4.conf.all.src_valid_mark=1 + volumes: + - /etc/localtime:/etc/localtime:ro + - ${DOCKERCONFDIR}/privoxyvpn:/config + - ${DOCKERSTORAGEDIR}:/storage From 7b9e757a9c3e04f2dba91e3b12b4d9b5fd0bffa7 Mon Sep 17 00:00:00 2001 From: Eric Nemchik Date: Thu, 19 Oct 2023 16:54:20 -0500 Subject: [PATCH 2/2] docs: :memo: privoxyvpn docs Signed-off-by: Eric Nemchik --- docs/apps/privoxyvpn.md | 19 +++++++++++++++++++ docs/apps/sabnzbdvpn.md | 4 ++-- mkdocs.yml | 1 + 3 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 docs/apps/privoxyvpn.md diff --git a/docs/apps/privoxyvpn.md b/docs/apps/privoxyvpn.md new file mode 100644 index 0000000000..ff63b0475e --- /dev/null +++ b/docs/apps/privoxyvpn.md @@ -0,0 +1,19 @@ +# PrivoxyVPN + +[![Docker Pulls](https://img.shields.io/docker/pulls/binhex/arch-privoxyvpn?style=flat-square&color=607D8B&label=docker%20pulls&logo=docker)](https://hub.docker.com/r/binhex/arch-privoxyvpn) +[![GitHub Stars](https://img.shields.io/github/stars/binhex/arch-privoxyvpn?style=flat-square&color=607D8B&label=github%20stars&logo=github)](https://github.com/binhex/arch-privoxyvpn) +[![Compose Templates](https://img.shields.io/static/v1?style=flat-square&color=607D8B&label=compose&message=templates)](https://github.com/GhostWriters/DockSTARTer/tree/master/compose/.apps/privoxyvpn) + +## Description + +PrivoxyVPN is an Arch Linux based Docker Image with +[Privoxy](http://privoxy.org/), [MicroSocks](https://github.com/rofl0r/microsocks), [OpenVPN](https://openvpn.net/) and [WireGuard](https://www.wireguard.com/). + +The support forum for PrivoxyVPN is located +[here](https://forums.unraid.net/topic/78028-support-binhex-privoxyvpn/). + +## Install/Setup + +This application does not have any specific setup instructions documented. If +you need assistance setting up this application please visit our +[support page](https://dockstarter.com/basics/support/). diff --git a/docs/apps/sabnzbdvpn.md b/docs/apps/sabnzbdvpn.md index b161a3c6a5..3613ef4907 100644 --- a/docs/apps/sabnzbdvpn.md +++ b/docs/apps/sabnzbdvpn.md @@ -19,9 +19,9 @@ This application does not have any specific setup instructions documented. If you need assistance setting up this application please visit our [support page](https://dockstarter.com/basics/support/). -### DelugeVPN WebUI Access +### SABnzbdVPN WebUI Access -If you're attempting to get access to the DelugeVPN WebUI remotely outside of +If you're attempting to get access to the SABnzbdVPN WebUI remotely outside of your home network using [SWAG](https://dockstarter.com/apps/swag/) you must follow the steps outlined in [VPN Information](https://dockstarter.com/advanced/vpn-info/). diff --git a/mkdocs.yml b/mkdocs.yml index 4d7fd0c6c2..c65363eeb7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -205,6 +205,7 @@ nav: - apps/plexanisync.md - apps/portainer.md - apps/portaineragent.md + - apps/privoxyvpn.md - apps/prometheus.md - apps/prowlarr.md - apps/pyload.md