RustSocks

SOCKS5 PROXY PLATFORM

RustSocks Documentation

High-performance SOCKS5 proxy with ACLs, session tracking, QoS, metrics, and a modern web dashboard.

What RustSocks Is

RustSocks is a production-ready SOCKS5 proxy server written in Rust. It focuses on performance, observability, and operator control, including:

• Granular ACLs with hot reload
• Real-time session tracking and history
• QoS rate limiting with fair sharing
• Prometheus metrics and diagnostics APIs
• Web dashboard with live monitoring and configuration

Secure by Design

Multiple auth methods (none, user/pass, PAM, GSSAPI) with optional dashboard auth.

Operational Visibility

Session history, metrics snapshots, telemetry feed, and system health checks.

Control and Automation

Runtime settings editor in the UI and API endpoints for management.

Flexible Deployment

Build from source or run via Docker with ready-to-use configuration examples.

Quick Links

• Quick Start
• Dashboard Overview
• Configuration Reference
• ACL Rules
• Usage Examples

Documentation Map

• Getting Started: build, run, and first-time setup
• UI & Dashboard: pages, workflows, and UI settings
• Configuration: full TOML reference for rustsocks.toml and acl.toml
• Guides: advanced setups (dashboard auth, base path, LDAP/AD)
• Technical: internal architecture and design notes

If you are new, start with the Quick Start and the dashboard overview.