Sign inSign up

arembez/softether-client

By arembez

Updated 21 days ago

Softether VPN Client Deployment

Image
Networking
0

2.3K

arembez/softether-client repository overview

SoftEther VPN Client Deployment

See the GitHub repository for full documentation, examples, and release notes:

https://github.com/arembez/softether-client

A lightweight Docker image for SoftEther VPN Client with automatic connection management, DHCP provisioning, route pinning, health monitoring, and self-healing recovery.

Features

  • Automatic VPN connection and reconnection
  • DHCP configuration for SoftEther virtual adapters
  • VPN server route pinning to preserve the control connection
  • Optional VPN default-route enforcement
  • Policy-based routing for uplink preservation
  • Stateful connection lifecycle management
  • Route-aware health monitoring
  • Automatic local recovery before reconnecting
  • Works in both bridge and host networking modes

Quick Start

services:
  softether:
    image: arembez/softether-client:latest
    container_name: softether
    cap_add:
      - NET_ADMIN
    environment:
      - SE_SERVER=vpn.example.com:443
      - SE_HUB=VPNHUB
      - SE_NICNAME=myvpn
      - SE_USERNAME=myuser
      - SE_PASSWORD=mypass
      - SE_DEFAULTROUTE=1
    restart: unless-stopped

Start:

docker compose up -d

Required Environment Variables

VariableDescription
SE_SERVERVPN server address (host:port)
SE_HUBVPN hub name
SE_NICNAMEVirtual adapter name
SE_USERNAMEVPN username
SE_PASSWORDVPN password

Optional Environment Variables

VariableDefaultDescription
SE_DEFAULTROUTEunsetForce default route through VPN
LOG_LEVELINFOLog verbosity (INFO or DEBUG)
PING_INTERVAL10Health check interval (seconds)
PING_TIMEOUT3Gateway ping timeout (seconds)
RECONNECT_DELAY5Delay before reconnect attempts (seconds)
MAX_CONNECT_WAIT60VPN connection timeout (seconds)
INITIAL_STABILIZE_TIMEOUT180Tunnel stabilization timeout (seconds)
INITIAL_STABILIZE_INTERVAL10Tunnel stabilization check interval (seconds)
HEALTH_FAILURE_THRESHOLD3Consecutive failures before recovery mode

Health Monitoring

The container continuously validates:

  • VPN session status
  • VPN interface availability
  • DHCP-assigned VPN address
  • VPN gateway reachability
  • VPN default route integrity (when enabled)

Routing issues are repaired automatically whenever possible. Full VPN reconnection occurs only when local recovery is unsuccessful.

Tag summary

Content type

Image

Digest

sha256:62621e064

Size

16.5 MB

Last updated

21 days ago

docker pull arembez/softether-client