Skip to content

Commit

Permalink
remove exposed ports and tidy up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
binhex committed Jun 13, 2024
1 parent a869a48 commit cd62cce
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
6 changes: 0 additions & 6 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@ ADD run/nobody/*.sh /home/nobody/
RUN chmod +x /root/*.sh /home/nobody/*.sh && \
/bin/bash /root/install.sh "${RELEASETAG}" "${TARGETARCH}"

# docker settings
#################

# expose port for privoxy
EXPOSE 8118

# set permissions
#################

Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,13 @@ Latest stable WireGuard release from Arch Linux repo.

## Usage

```bash
```text
docker run -d \
--cap-add=NET_ADMIN \
-p 8118:8118 \
-p 9118:9118 \
-p 58946:58946 \
-p 58946:58946/udp \
--name=<container name> \
-v <path for config files>:/config \
-v /etc/localtime:/etc/localtime:ro \
Expand Down Expand Up @@ -75,6 +77,8 @@ docker run -d \
--cap-add=NET_ADMIN \
-p 8118:8118 \
-p 9118:9118 \
-p 58946:58946 \
-p 58946:58946/udp \
--name=privoxyvpn \
-v /root/docker/config:/config \
-v /etc/localtime:/etc/localtime:ro \
Expand All @@ -101,10 +105,6 @@ docker run -d \
binhex/arch-privoxyvpn
```

## IMPORTANT

Please note `VPN_INPUT_PORTS` is **NOT** to define the incoming port for the VPN, this environment variable is used to define port(s) you want to allow in to the VPN network when network binding multiple containers together, configuring this incorrectly with the VPN provider assigned incoming port COULD result in IP leakage, you have been warned!.

## OpenVPN

Please note this Docker image does not include the required OpenVPN configuration file and certificates. These will typically be downloaded from your VPN providers website (look for OpenVPN configuration files), and generally are zipped.
Expand Down Expand Up @@ -147,6 +147,10 @@ The list of default NS providers in the above example(s) is as follows:-
37.235.x.x = FreeDNS<br/>
1.x.x.x = Cloudflare

---
**IMPORTANT**<br/>
Please note `VPN_INPUT_PORTS` is **NOT** to define the incoming port for the VPN, this environment variable is used to define port(s) you want to allow in to the VPN network when network binding multiple containers together, configuring this incorrectly with the VPN provider assigned incoming port COULD result in IP leakage, you have been warned!.

---
User ID (PUID) and Group ID (PGID) can be found by issuing the following command for the user you want to run the container as:-

Expand Down

0 comments on commit cd62cce

Please sign in to comment.