pxyd
v1.0.1
Published
Lightweight HTTP, HTTPS, and SOCKS proxy server
Downloads
232
Maintainers
Readme
pxyd
Lightweight HTTP, HTTPS, and SOCKS proxy server
Features
- Support HTTP and SOCKS proxy protocols
- Optional upstream proxy chaining (HTTP / SOCKS)
- Built-in CONNECT tunneling (HTTPS support)
- TLS (HTTPS) server support
- Configurable timeouts (TCP connect, request, tunnel)
- Optional Basic Authentication
Installation
npm install -g pxydUsage
pxyd start [options]Options
Network
| Option | Description | Default |
| --------------- | -------------- | --------- |
| --host <host> | Bind address | 0.0.0.0 |
| --port <port> | Port to listen | 8080 |
Protocol
| Option | Description |
| ----------------------- | ----------------- |
| --protocol <protocol> | http or socks |
Authentication
| Option | Description |
| ----------------------- | ------------------- |
| --username <username> | Basic auth username |
| --password <password> | Basic auth password |
Upstream Proxy
| Option | Description |
| ------------------ | ----------------------------------- |
| --upstream <url> | Forward requests via upstream proxy |
Examples:
--upstream http://127.0.0.1:8080
--upstream socks5://127.0.0.1:1080TLS (HTTPS Server)
| Option | Description |
| -------------------- | -------------------- |
| --cert-file <path> | TLS certificate file |
| --key-file <path> | TLS private key file |
Both must be provided together.
Timeouts
| Option | Description |
| ----------------------------- | ----------------------------------- |
| --tcp-connect-timeout <ms> | Timeout for upstream TCP connection |
| --http-request-timeout <ms> | Timeout waiting for HTTP response |
| --tunnel-timeout <ms> | Tunnel inactivity timeout |
Examples
Start HTTP proxy
pxyd start --port 8080Start SOCKS proxy
pxyd start --protocol socks --port 1080Use upstream proxy
pxyd start \
--upstream http://127.0.0.1:8081Enable authentication
pxyd start \
--username admin \
--password secretStart HTTPS proxy
pxyd start \
--protocol http \
--cert-file ./cert.pem \
--key-file ./key.pemLicense
MIT
