PHPackages clue/psocksd - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [HTTP & Networking](/categories/http) 4. / 5. clue/psocksd ActiveProject[HTTP & Networking](/categories/http) clue/psocksd ============ The SOCKS tunnel / proxy server daemon written in PHP v0.4.0(9y ago)5619712[1 issues](https://github.com/clue/psocksd/issues)MITPHPPHP >=5.3 Since Dec 23Pushed 9y ago9 watchersCompare [ Source](https://github.com/clue/psocksd)[ Packagist](https://packagist.org/packages/clue/psocksd)[ Docs](https://github.com/clue/psocksd)[ RSS](/packages/clue-psocksd/feed)WikiDiscussions master Synced yesterday READMEChangelog (9)Dependencies (10)Versions (10)Used By (0) psocksd ======= [](#psocksd) The SOCKS tunnel / proxy server daemon written in PHP Features -------- [](#features) The SOCKS protocol family can be used to easily tunnel TCP connections independent of the actual application level protocol, such as HTTP, SMTP, IMAP, Telnet, etc. In this mode, a SOCKS server acts as a generic proxy allowing higher level application protocols to work through it. - SOCKS proxy server with support for SOCKS4, SOCKS4a and SOCKS5 protocol versions (all at the same time) - Optionally require username / password authentication (SOCKS5 only) - Zero configuration, easy to use command line interface (CLI) to change settings without restarting server - Incoming SOCKS requests can be forwarded to another SOCKS server to act as a tunnel gateway, perform transparent protocol translation or add SOCKS authentication for clients not capable of doing it themselves. - Tunnel endpoint can be changed during runtime (`via` CLI command). - Particularly useful when used as an intermediary server and using ever-changing public SOCKS tunnel end points. - Using an async event-loop, it is capable of handling multiple concurrent connections in a non-blocking fashion - Built upon the shoulders of [reactphp/react](https://github.com/reactphp/react) and [clue/socks](https://github.com/clue/socks), it uses well-tested dependencies instead of reinventing the wheel. Usage ----- [](#usage) Once [installed](#install), you can start `psocksd` and listen for incoming SOCKS connections by running: ``` $ php psocksd.phar ``` Using this command, `psocksd` will start listening on the default adress `localhost:9050`. ### Listen address [](#listen-address) If you want to listen on another address, you can supply an explicit listen address like this: ``` # start SOCKS daemon on port 9051 instead $ php psocksd.phar 9051 # explicitly listen on the given interface $ php psocksd.phar 192.168.1.2:9050 # listen on all interfaces (allow access to SOCKS server from the outside) $ php psocksd.phar *:9050 # explicitly only support SOCKS5 and reject other protocol versions $ php psocksd.phar socks5://localhost:9050 # require client to send the given authentication information $ php psocksd.phar socks5://username:password@localhost:9051 ``` ### Interactive CLI [](#interactive-cli) By default, `psocksd` will run an interactive command line interface. This means that it keeps running in the foreground and accepts commands from `STDIN`. You can pass the `--no-interaction` argument to disable this interactive mode so that it does not accept any commands from `STDIN`. The interactive mode is always disabled on Windows, because it's impossible to read from `STDIN` without blocking the whole daemon. You can run the `help` command in order to see all available commands and their usage: ``` > help psocksd help: […] ``` You can run the `ping` command in order to test creating a TCP/IP connection through the given SOCKS server: ``` > ping 192.168.1.200:1080 ping www.google.com:80 ping test OK (⌚ 0.378s) ``` You can run the `exit` or `quit` command (or hit `CTRL+D` or `CTRL-C`) in order to exit the program: ``` > exit exiting... ``` ### Client configuration [](#client-configuration) Once `psocksd` is started, it accepts incoming SOCKS client connections. Therefor, you have to configure your client program (webbrowser, email client etc.) to actually use the SOCKS server. The exact configuration depends on your program, but quite a few programs allow you to use a SOCKS proxy. So depending on the above list address, supply the following information: ``` Proxy-Type: SOCKS4 or SOCKS5 Socks-Host: localhost Socks-Port: 9050 ``` Install ------- [](#install) You can grab a copy of clue/psocksd in either of the following ways. ### As a phar (recommended) [](#as-a-phar-recommended) You can simply download a pre-compiled and ready-to-use version as a Phar to any directory. Simply download the latest `psocksd.phar` file from our [releases page](https://github.com/clue/psocksd/releases): [Latest release](https://github.com/clue/psocksd/releases/latest) That's it already. You can now verify everything works by running this: ``` $ cd ~/Downloads $ php psocksd.phar ``` > If you prefer a global (system-wide) installation without having to type the `.phar` extension each time, you may invoke: > > ``` > $ chmod 0755 psocksd.phar > $ sudo mv psocksd.phar /usr/local/bin/psocksd > ``` > > > > You can verify everything works by running: > > ``` > $ psocksd > ``` #### Updating phar [](#updating-phar) There's no separate `update` procedure, simply overwrite the existing phar with the new version downloaded. ### Manual Installation from Source [](#manual-installation-from-source) The manual way to install `psocksd` is to clone (or download) this repository and use [composer](http://getcomposer.org) to download its dependencies. Obviously, for this to work, you'll need PHP, git and curl installed: ``` $ sudo apt-get install php5-cli git curl $ git clone https://github.com/clue/psocksd.git $ curl -s https://getcomposer.org/installer | php $ php composer.phar install ``` > If you want to build the above mentioned `psocksd.phar` yourself, you have to install [clue/phar-composer](https://github.com/clue/phar-composer#install)and can simply invoke: > > ``` > $ php phar-composer.phar build ~/workspace/psocksd > ``` #### Updating manually [](#updating-manually) If you have followed the above install instructions, you can update `psocksd` by issuing the following two commands: ``` $ git pull $ php composer.phar install ``` ### Docker [](#docker) This project is also available as a [docker](https://www.docker.com/) image. Using the [clue/psocksd](https://registry.hub.docker.com/u/clue/psocksd/) image is as easy as running this: ``` $ docker run -d -p 9050:9050 clue/psocksd ``` License ------- [](#license) MIT-licensed ### Health Score 31 — LowBetter than 66% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community14 Small or concentrated contributor base Maturity54 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~177 days Recently: every ~236 days Total 9 Last Release 3523d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/776829?v=4)[Christian Lück](/maintainers/clue)[@clue](https://github.com/clue) --- Top Contributors [![clue](https://avatars.githubusercontent.com/u/776829?v=4)](https://github.com/clue "clue (84 commits)") --- Tags reactphptcp tunnelproxy serversocks-proxyforwardingserver daemon ### Embed Badge ![Health badge](/badges/clue-psocksd/health.svg) ``` [![Health](https://phpackages.com/badges/clue-psocksd/health.svg)](https://phpackages.com/packages/clue-psocksd) ``` ### Alternatives [friendsofphp/php-cs-fixer A tool to automatically fix PHP code style 13.5k251.2M24.6k](/packages/friendsofphp-php-cs-fixer)[react/http Event-driven, streaming HTTP client and server implementation for ReactPHP 78127.7M460](/packages/react-http)[react/react ReactPHP: Event-driven, non-blocking I/O with PHP. 9.1k3.7M65](/packages/react-react)[rector/rector-src Instant Upgrade and Automated Refactoring of any PHP code 136406.3k14](/packages/rector-rector-src)[clue/socks-react Async SOCKS proxy connector client and server implementation, tunnel any TCP/IP-based protocol through a SOCKS5 or SOCKS4(a) proxy server, built on top of ReactPHP. 1191.1M33](/packages/clue-socks-react)[clue/stdio-react Async, event-driven console input & output (STDIN, STDOUT) for truly interactive CLI applications, built on top of ReactPHP 20011.0M27](/packages/clue-stdio-react) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)