PHPackages clue/solusvm-api-react - 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. [Queues & Workers](/categories/queues) 4. / 5. clue/solusvm-api-react ActiveLibrary[Queues & Workers](/categories/queues) clue/solusvm-api-react ====================== A simple, async PHP library to manage your VPS through the SolusVM Client API v0.1.1(10y ago)7354MITPHPPHP >=5.3 Since Jul 9Pushed 10y ago3 watchersCompare [ Source](https://github.com/clue/php-solusvm-api-react)[ Packagist](https://packagist.org/packages/clue/solusvm-api-react)[ Docs](https://github.com/clue/php-solusvm-api-react)[ RSS](/packages/clue-solusvm-api-react/feed)WikiDiscussions master Synced 1w ago READMEChangelog (2)Dependencies (1)Versions (3)Used By (0) clue/solusvm-api-react [![Build Status](https://camo.githubusercontent.com/73c32284b16ffcbf9a2a5489abebd5ec529fe974725ec0b2444b5ca5379bc7d9/68747470733a2f2f7472617669732d63692e6f72672f636c75652f7068702d736f6c7573766d2d6170692d72656163742e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/clue/php-solusvm-api-react) ==================================================================================================================================================================================================================================================================================================================================== [](#cluesolusvm-api-react-) Simple async access to your VPS box through the SolusVM API, built on top of [React PHP](http://reactphp.org/) Solus Virtual Manager ([SolusVM](http://solusvm.com/)) is a popular commercial control panel (CP) for virtual private servers (VPS). Its web interface can be used to control your VPS, see its details or boot, reboot or shutdown. Using SolusVM is pretty common for smaller VPS hosting companies, in particular for those listed on [Low End Box](http://lowendbox.com/). As a user (customer) you get full root access to a VPS (usually via SSH) and use the SolusVM web interface to manage your VPS. This project uses the [SolusVM Client API](http://docs.solusvm.com/client_api)so that you can manage your VPS programatically without having to log in to the web interface to check your bandwidth usage or reboot your VPS. > Note: This project is in beta stage! Feel free to report any issues you encounter. Quickstart example ------------------ [](#quickstart-example) Once [installed](#install), you can use the following code to fetch the info for your VPS from your SolusVM provider: ``` $loop = React\EventLoop\Factory::create(); $factory = new Factory($loop); $client = $factory->createClient(array( 'user' => '147492ddec07231c2de7e5865880fd0191955916', 'pass' => 'Y4WNA-TZS6J-15YMB', 'host' => 'manage.myhost.local' )); $client->info()->then(function ($result) { var_dump($result); }); $loop->run(); ``` See also the [examples](examples). Usage ----- [](#usage) ### Factory [](#factory) The `Factory` class is responsible for constructing the [`Client`](#client) instance. It also registers everything with the main [`EventLoop`](https://github.com/reactphp/event-loop#usage). ``` $loop = React\EventLoop\Factory::create(); $factory = new Factory($loop); ``` If you need custom DNS or proxy settings, you can explicitly pass a custom [`Browser`](https://github.com/clue/php-buzz-react#browser) instance: ``` $browser = new Clue\React\Buzz\Browser($loop); $factory = new Factory($loop, $browser); ``` #### createClient() [](#createclient) The `createClient($address)` method can be used to create a new [`Client`](#client) instance. You have to pass an address as either of the following: - string `{scheme}://{hash/user}:{key/pass}@{host}/{path}`, for example `https://147492ddec07231c2de7e5865880fd0191955916:Y4WNA-TZS6J-15YMB@manage.myhost.local` - array containing the keys `scheme`, `user` (hash), `pass` (key), `host`, `port`, `path`, as per the above [quickstart example](#quickstart-example) Only `user` and `pass` have to be set explicitly, the `Factory` assumes defaults from the URL `https://localhost:5656/api/client/command.php` for the other parts. ### Client [](#client) The `Client` class is responsible for communication with the remote SolusVM API. #### Actions [](#actions) All public methods resemble their respective SolusVM Client API actions. ``` $client->reboot(); $client->boot(); $client->shutdown(); $client->status(); $client->info($ipaddr = true, $hdd = true, $mem = true, $bw = true); ``` Listing all available actions is out of scope here, please refer to the [class outline](src/Client.php). #### Processing [](#processing) Issuing actions is async (non-blocking), so you can actually send multiple action requests in parallel. The SolusVM API service will respond to each request with a response value. The order is not guaranteed. Sending requests uses a [Promise](https://github.com/reactphp/promise)-based interface that makes it easy to react to when a request is *fulfilled*(i.e. either successfully resolved or rejected with an error): ``` $client->status()->then( function ($result) { // response received for status action }, function (Exception $e) { // an error occured while executing the status action } }); ``` Install ------- [](#install) The recommended way to install this library is [through composer](http://getcomposer.org). [New to composer?](http://getcomposer.org/doc/00-intro.md) ``` { "require": { "clue/solusvm-api-react": "~0.1.0" } } ``` License ------- [](#license) MIT ### Health Score 26 — LowBetter than 43% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity15 Limited adoption so far Community11 Small or concentrated contributor base Maturity49 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 ~422 days Total 2 Last Release 3908d 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 (15 commits)") --- Tags asyncreactphpvpscontrol panelSolusVMSolus Virtual Manager ### Embed Badge ![Health badge](/badges/clue-solusvm-api-react/health.svg) ``` [![Health](https://phpackages.com/badges/clue-solusvm-api-react/health.svg)](https://phpackages.com/packages/clue-solusvm-api-react) ``` ### Alternatives [react/socket Async, streaming plaintext TCP/IP and secure TLS socket server and client connections for ReactPHP 1.3k116.9M402](/packages/react-socket)[react/dns Async DNS resolver for ReactPHP 535114.1M100](/packages/react-dns)[react/promise-timer A trivial implementation of timeouts for Promises, built on top of ReactPHP. 34141.9M96](/packages/react-promise-timer)[react/async Async utilities and fibers for ReactPHP 2238.8M171](/packages/react-async)[react/promise-stream The missing link between Promise-land and Stream-land for ReactPHP 11512.9M45](/packages/react-promise-stream)[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. 1171.1M33](/packages/clue-socks-react) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)