Skip to main content
# socks5

A socks5 server in Python using asyncio.

Works with python >= 3.6

# Installation

This package is available on [pypi](https://pypi.org/project/socks5server/)

Install it with pip:

```sh
$ pip install socks5server
```

Requires: click, kaviar

# Usage

```
$ socks5.server --help
Usage: socks5.server [OPTIONS]

Runs a SOCK5 server.

Options:
--host TEXT The interfaces to listen on
--port INTEGER The port to listen on
--allow-no-auth Whether to allow clients that do not use
authentication
--basic-auth-file PATH File containing username/password combinations
--help Show this message and exit.
```

# Authentication

The only method currently supported is basic auth, which can be configured
using the --basic-auth-file option. This should point to a file storing
credentials in the format:

```txt
<username>:<password>[:<comment>]
```

Release files for socks5server 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for socks5server 0.1.0
File Size Uploaded
socks5server-0.1.0.tar.gz 5.0 kB Details

Release files / socks5server-0.1.0.tar.gz

Download URL socks5server-0.1.0.tar.gz
Size 5.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1a4a27cf374cecb24ef3c43fa39882bf507b876cbde524e1d535835d355793a3
BLAKE2b-256 checksum
How to use checksums
6e1f431096f3fe0648be2c9f2be99f8be0989b2948ee426ff7940e3f4141e22c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.0 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page