Giter Club home page Giter Club logo

surfsocks's Introduction

SurfSocks

SurfSocks is a SOCK5 proxy that proxies through the SurfShark VPN. This repo can be built for various architectures although my main use was for the Raspberry Pi 4 (armv71).

This image was inspired by and based on the following:

arch-privoxyvpn

wollen-socks

ovpn-openvpn-privoxy

Usage

Docker Run

docker run -d \
    --cap-add=NET_ADMIN \
    -p 8118:8118 \
    --name=<container name> \
    -v /etc/localtime:/etc/localtime:ro \
    -e VPN_USER=<vpn username from SurfShark manual setup> \
    -e VPN_PASS=<vpn password from SurfShark manual setup> \
    -e VPN_FILE=</surfshark/*server location*.ovpn> \
    -e PRIVATE_NET=<lan ipv4 network>/<cidr notation> \
    s0uldrag0n/surfsocks

Docker Compose

version: '3'

services:
  vpnproxy:
    image: "s0uldrag0n/surfsocks"
    environment:
     - VPN_USER=<vpn username from SurfShark manual setup>
     - VPN_PASS=<vpn password from SurfShark manual setup>
     - VPN_FILE=</surfshark/*server location*.ovpn>
     - PRIVATE_NET=<lan ipv4 network>/<cidr notation>
    ports:
     - "8118:8118"
    cap_add:
     - NET_ADMIN

ย  Please replace all user variables in the above command defined by <> with the correct values.

Access Privoxy

http://<host ip>:8118

Environment Variables

VPN_USER - This is the username provided by SurfShark from the manual setup section.

VPN_PASS - This is the password provided by SurfShark from the manual setup section.

VPN_FILE - This should be the path to the OVPN file used by OpenVPN. This is provided by SurfShark and is already part of the container. You will just have to specify the filename preceeded by /surfshark/ to reference the file in the existing location (ex. /surfshark/nl-ams.prod.surfshark.com_udp.ovpn).

PRIVATE_NET - The CIDR mask of the local IP addresses (e.g. 192.168.1.0/24, 10.1.1.0/24) which will be acessing the proxy. This is so the response to a request can be returned to the client (i.e. your browser). (Credits to joltcan)

Privoxy Configuration

You can override the privoxy settings by mounting your own config to /etc/privoxy.

surfsocks's People

Contributors

s0uldrag0n avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.