SimpleSocks5

SimpleSocks5 is a lightweight Docker container running 3proxy, a SOCKS5 proxy server.
This container comes in two versions:

• Debian-based: Built on Debian Bookworm "slim," offering broad compatibility with various systems while keeping the image size reasonably small.
• Alpine-based: For those looking for a minimal image size, the Alpine version offers a significantly smaller footprint, though it may not work on all devices (e.g., Raspberry Pi 3).

The container provides SOCKS5 proxy functionality with user authentication via a configurable 3proxy.cfg file.
The Debian-based version is recommended for most users due to its better compatibility.

Features

• Minimal image size: Two options available (Debian or Alpine), with the smallest size on Alpine.
• User authentication: Easily configure users in the 3proxy.cfg file.
• Cross-architecture support: Available for multiple architectures.

Supported Architectures

The Docker images are available for the following architectures:

• linux/amd64
• linux/arm64
• linux/arm/v7
• linux/arm/v6

Tags and Versions

The Docker images are tagged as follows:

• Debian-based images:

  • simplesocks5:latest (always the latest Debian image)
  • simplesocks5:debian
  • simplesocks5:debian-latest

• Alpine-based images:

  • simplesocks5:alpine
  • simplesocks5:alpine-latest

The latest tag (simplesocks5:latest) will always point to the Debian version for compatibility, but Alpine versions are available if you prefer a smaller image size.

Usage

To start the SimpleSocks5 container:

1. Clone the repository:

   git clone https://github.com/rezzorix/simplesocks5.git
   cd simplesocks5
   

2. Configure the 3proxy.cfg file:

Edit the 3proxy.cfg file to set up your user authentication.

3. Start the container using Docker Compose

   docker-compose up -d
   

Build your own image

Alternatively, if you prefer to build the image on your own:

1. Go to the ./build directory and run:

    cd ./build
    docker-compose build && docker-compose up -d
   

This will build the image for your current architecture with Debian by default.

Choosing a specific base image (Debian or Alpine) can be done by editing the ./build/docker-compose.yml:

• To build with Debian:

dockerfile: Dockerfile.debian

• To build with Alpine:

dockerfile: Dockerfile.alpine