Download the PHP package magnusjt/socketty without Composer
On this page you can find all versions of the php package magnusjt/socketty. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download magnusjt/socketty
More information about magnusjt/socketty
Files in magnusjt/socketty
Package socketty
Short Description SSH terminal over web sockets
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package socketty
socketty
Interactive terminals over websockets with a php backend. It can for instance be used to create interactive SSH sessions, but should work with any command. At the same time, an existing php backend can be used to perform authorization and authentication.
Uses the following tech:
- ratchet - Websockets with PHP
- reactphp - Async IO in PHP through an event loop
- term.js - Terminal emulation in the browser
- reactjs - For the rest of the UI
- python's pty module - For emulating a pty which php can interact with using normal pipes
Usage
The project consists of a PHP backend which manages the client connections, and a frontend which
emulates the terminal. In order to run the backend server, create a composer dependency on this project,
and follow the example in ./server.php:
`
Here you can customize:
- Authentication - Implement the AuthenticatorInterface. If you want to reuse sessions from an existing site, you will need to do this through memcached
- Authorization - Same as Authentication, but in this case you may also authorize the command and command arguments.
- Port to use for websockets
- Allowed hosts
- Logging - The project uses the psr LoggerInterface, so anything goes (Monolog is a nice option)
- Spawner - Generates a command string to be executed. Commands can be enabled and disabled here.
Backend example:
See ./server.php
Frontend:
Install by adding the following to npm dependencies:
"socketty": "git://github.com/magnusjt/socketty.git#master"
Frontend example (needs to be compiled with browserify and babelify): `
Development
- Install frontend dependencies with
npm install. - Install backend dependencies with
composer install - Copy and rename a Vagrantfile and vagrant_bootstrap.sh file
- Start virtual server with
vagrant up - Start websocket server with
php server.php - Open browser and go to https://localhost:5678/login.php to pretend to login
- Open browser and go to https://localhost:5678 and spawn some terminals into the virtual server
- Build frontend stuff with
gulp buildandgulp watchify -
NB: apache and haproxy may need to be started manually after a reboot:
`
About SSL
In order to have secure web sockets, the vagrant install includes haproxy which terminates all ssl requests.
How it works
First of all, reactphp is used together with an event loop to acheive async calls with PHP. A sub component of reactphp called child-processes uses PHP's proc_open to connect to a child process and its pipes. For programs that require a tty (such as ssh and its interactive password prompt), we would really like to use PHP's pty pipes, but these are sadly not available on most systems. To get around this, all comands are opened through a python script, which uses the pty module to simulate a pty.
