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 df10f58 commit 6d615cb
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 13 deletions.
8 changes: 0 additions & 8 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +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 http
EXPOSE 8080

# expose port for https
EXPOSE 8090

# set permissions
#################
Expand Down
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,21 @@ This Docker includes OpenVPN and WireGuard to ensure a secure and private connec

Latest stable SABnzbd release from Arch Linux AUR.<br/>
Latest stable Privoxy release from Arch Linux repo.<br/>
Latest stable microsocks release from GitHub.<br/>
Latest stable OpenVPN release from Arch Linux repo.<br/>
Latest stable WireGuard release from Arch Linux repo.

## Usage

```bash
```text
docker run -d \
--cap-add=NET_ADMIN \
-p 8080:8080 \
-p 8090:8090 \
-p 8118:8118 \
-p 9118:9118 \
-p 58946:58946 \
-p 58946:58946/udp \
--name=<container name> \
-v <path for data files>:/data \
-v <path for config files>:/config \
Expand Down Expand Up @@ -67,6 +71,12 @@ Please replace all user variables in the above command defined by <> with the co

`http://<host ip>:8118`

## Access microsocks

`<host ip>:9118`

default credentials: admin/socks

## PIA example

```bash
Expand All @@ -75,6 +85,9 @@ docker run -d \
-p 8080:8080 \
-p 8090:8090 \
-p 8118:8118 \
-p 9118:9118 \
-p 58946:58946 \
-p 58946:58946/udp \
--name=sabnzbdvpn \
-v /root/docker/data:/data \
-v /root/docker/config:/config \
Expand Down Expand Up @@ -102,10 +115,6 @@ docker run -d \
binhex/arch-sabnzbdvpn
```

## 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 @@ -148,6 +157,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 6d615cb

Please sign in to comment.