Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #24

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,56 @@ docker run
-p 8080:8080
-v '/local/path/to/config':'/home/root/.cyberghost:rw'
```
OR using Docker Compose
```
version: '3'
services:
cyberghostvpn:
image: tmcphee/cyberghostvpn
container_name: cyberghostvpn
network_mode: "bridge"
privileged: true
cap_add:
- NET_ADMIN
volumes:
- /local/path/to/config:/home/root/.cyberghost:rw
environment:
- TZ=America/New_York
- [email protected]
- PASS=mypassword
- COUNTRY=US
- NETWORK=192.168.1.0/24
- WHITELISTPORTS=9090,8080
ports:
- 9090:9090
- 8080:8080
restart: unless-stopped
```

Other containers can connect to this image by using its network connection.
`--net=container:cyberghostvpn`
```
docker run -d --net=container:cyberghostvpn other-container
```
OR in Docker Compose
`network_mode: container:cyberghostvpn`
```
services:
other_service:
image: other_service_image
container_name: other_service
network_mode: container:cyberghostvpn
```

If using Docker Compose, place all ports needed from other container into the ports section
```
ports:
- 9090:9090
- 8080:8080
- 6000:6000
- 6881:6881
```

Note: If the other containers have exposed ports for example a WEBUI. Forward that port in the cyberghostvpn image, add the port to WHITELISTPORTS environment variable, and set your local LAN using NETWORK environment variable. See [Environment variables](https://github.com/tmcphee/cyberghostvpn#environment-variables) below for details.

## Selecting a country
Expand Down