docker-surfshark

Docker container with OpenVPN client preconfigured for SurfShark

---

This is a multi-arch image, updated automatically thanks to GitHub Actions.

Its purpose is to provide the SurfShark VPN to all your containers.

The link is established using the OpenVPN client.

Configuration

The container is configurable using 5 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
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
OVPN_CONFIGS	No	Manually provide "Surfshark_Config.zip" file (contains surfshark OpenVPN configuration files)

SURFSHARK_USER and SURFSHARK_PASSWORD are provided at this page: https://my.surfshark.com/vpn/manual-setup/main.

Execution

You can run this image using Docker compose and the sample file 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:
            - 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.

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:

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.

Provide OpenVPN Configs Manually

Sometimes the startup.sh script fails to download OpenVPN configs file from https://my.surfshark.com/vpn/api/v1/server/configurations. Possibly this happens due to some form of DDoS protection on Surfshark's website. The following helped me resolve the problem:

1. Go to https://surfshark.com.

2. Click the "Log in" button.

3. This will display the "checking browser security" screen (typical DDoS protection middleware).

4. Once you're on https://my.surfshark.com/home/dashboard, paste https://my.surfshark.com/vpn/api/v1/server/configurations into your browser's URL bar, this will download the Surfshark_Config.zip file. Save the file somewhere.

   Typically, these DDoS protection middlewares will set some sort of cookie if the check is successful. This makes it possible to reach the target URL via the browser.

5. Create docker volume: docker volume create surfshark-config.

6. Find where it's located at: docker volume inspect surfshark-config ("Mountpoint" field).

   In my case it's: /var/lib/docker/volumes/surfshark-config/_data

7. Copy Surfshark_Config.zip to it:

   sudo cp Surfshark_Config.zip /var/lib/docker/volumes/surfshark-config/_data

8. Run the container with appropriate options:

   -v surfshark-config:/ovpn-configs (mount the volume)

   -e OVPN_CONFIGS=/ovpn-configs/Surfshark_Config.zip (specify environment variable)

Do you like my work?

or