Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilteoood/docker-surfshark
Docker container with OpenVPN client preconfigured for SurfShark
https://github.com/ilteoood/docker-surfshark
Last synced: 4 days ago
JSON representation
Docker container with OpenVPN client preconfigured for SurfShark
- Host: GitHub
- URL: https://github.com/ilteoood/docker-surfshark
- Owner: ilteoood
- License: mit
- Created: 2020-03-14T20:48:21.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-17T12:48:31.000Z (6 months ago)
- Last Synced: 2024-12-28T00:14:23.519Z (12 days ago)
- Language: Shell
- Size: 149 KB
- Stars: 141
- Watchers: 8
- Forks: 34
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# docker-surfshark
Docker container with OpenVPN client preconfigured for SurfShark
[](https://microbadger.com/images/ilteoood/docker-surfshark "Get your own version badge on microbadger.com")
[](https://microbadger.com/images/ilteoood/docker-surfshark "Get your own image badge on microbadger.com")
------------------------------------------------
This is a [multi-arch](https://medium.com/gft-engineering/docker-why-multi-arch-images-matters-927397a5be2e) image, updated automatically thanks to [GitHub Actions](https://github.com/features/actions).
Its purpose is to provide the [SurfShark VPN](https://surfshark.com/) to all your containers.
The link is established using the [OpenVPN](https://openvpn.net/) client.
## Configuration
The container is configurable using different environment variables:
| Name | Mandatory | Description |
|------|-----------|-------------|
|SURFSHARK_USER|Yes|Username provided by SurfShark|
|SURFSHARK_PASSWORD|Yes|Password provided by SurfShark|
|SURFSHARK_COUNTRY|No|The country, supported by SurfShark, in which you want to connect|
|SURFSHARK_CITY|No|The city of the country in which you want to connect|
|SURFSHARK_CONFIGS_ENDPOINT|No|The endpoint to be used to read Surfshark's configuration zip|
|OPENVPN_OPTS|No|Any additional options for OpenVPN|
|CONNECTION_TYPE|No|The connection type that you want to use: tcp, udp|
|LAN_NETWORK|No|Lan network used to access the web ui of attached containers. Can be comma seperated for multiple subnets Comment out or leave blank: example 192.168.0.0/24|
|CREATE_TUN_DEVICE|No|Creates the TUN device, useful for NAS users|
|ENABLE_MASQUERADE|No|Masquerade NAT allows you to translate multiple IP addresses to another single IP address.|
|ENABLE_SOCKS_SERVER|No|Control whether the SOCKS server for the VPN is run or not (default: do not run)|
|OVPN_CONFIGS|No|Manually provide the path used to read the "Surfshark_Config.zip" file (contains Surshark's OpenVPN configuration files)
|ENABLE_KILL_SWITCH|No|Enable the kill-switch functionality
`SURFSHARK_USER` and `SURFSHARK_PASSWORD` are provided at [this page](https://my.surfshark.com/vpn/manual-setup/main/openvpn).
## Execution
You can run this image using [Docker compose](https://docs.docker.com/compose/) and the [sample file](./docker-compose.yml) provided.
**Remember: if you want to use the web gui of a container, you must open its ports on `docker-surfshark` as described below.**
```
version: "2"
services:
surfshark:
image: ilteoood/docker-surfshark
container_name: surfshark
environment:
- SURFSHARK_USER=YOUR_SURFSHARK_USER
- SURFSHARK_PASSWORD=YOUR_SURFSHARK_PASSWORD
- SURFSHARK_COUNTRY=it
- SURFSHARK_CITY=mil
- CONNECTION_TYPE=udp
- LAN_NETWORK=
cap_add:
- NET_ADMIN
devices:
- /dev/net/tun
ports:
- 1080:1080 #if you want to use the socks5 server
- 9091:9091 #we open here the port for transmission, as this container will be the access point for the others
restart: unless-stopped
dns:
- 1.1.1.1
service_test:
image: byrnedo/alpine-curl
container_name: alpine
command: -L 'https://ipinfo.io'
depends_on:
- surfshark
network_mode: service:surfshark
restart: always
transmission:
image: linuxserver/transmission
container_name: transmission
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/Rome
#ports:
#- 9091:9091 needed to access transmission's GUI
network_mode: service:surfshark
restart: unless-stopped
```
Or you can use the standard `docker run` command.
```sh
sudo docker run -it --cap-add=NET_ADMIN --device /dev/net/tun --name CONTAINER_NAME -e SURFSHARK_USER=YOUR_SURFSHARK_USER -e SURFSHARK_PASSWORD=YOUR_SURFSHARK_PASSWORD ilteoood/docker-surfshark
```
If you want to attach a container to the VPN, you can simply run:
```sh
sudo docker run -it --net=container:CONTAINER_NAME alpine /bin/sh
```
If you want access to an attached container's web ui you will also need to expose those ports.
The attached container must not be started until this container is up and fully running.
If you face network connection problems, I suggest you to set a specific DNS server for each container.
Alternatively, if your software supports it, you can use the socks5 server embedded in this container. It will redirect your traffic through the Surfshark's VPN.
## Provide OpenVPN Configs Manually
Sometimes the startup script fails to download OpenVPN configs file from Surfshark's website, possibly due to the DDoS protection on it.
To avoid it, you can provide your own `Surfshark_Config.zip` file, downloading it from [here](https://my.surfshark.com/vpn/api/v1/server/configurations).
Then, you **must** make the `zip` available inside the container, using a [bind mount](https://docs.docker.com/storage/bind-mounts/) or a [volume](https://docs.docker.com/storage/volumes/).
Finally, you **must** set the `OVPN_CONFIGS` environment variable.
## Do you like my work?
or
