ReadMe Docs

This commit is contained in:
Chris Boden 2013-01-22 22:51:14 -05:00
parent 019b23c8ac
commit 9ef566cdcf

View File

@ -8,14 +8,14 @@ Build up your application through simple interfaces and re-use your application
##WebSocket Compliance ##WebSocket Compliance
* Supports the RFC6455, HyBi-10+, and Hixie76 protocol versions (at the same time) * Supports the RFC6455, HyBi-10+, and Hixie76 protocol versions (at the same time)
* Tested on Chrome 13 - 23, Firefox 6 - 17, Safari 5.0.1 - 6, iOS 4.2 - 6 * Tested on Chrome 13 - 24, Firefox 6 - 18, Safari 5.0.1 - 6, iOS 4.2 - 6
* Ratchet [passes](http://socketo.me/reports/ab/) the [Autobahn Testsuite](http://autobahn.ws/testsuite) (non-binary messages) * Ratchet [passes](http://socketo.me/reports/ab/) the [Autobahn Testsuite](http://autobahn.ws/testsuite) (non-binary messages)
##Requirements ##Requirements
Shell access is required and a dedicated machine with root access is recommended. Shell access is required and root access is recommended.
To avoid proxy/firewall blockage it's recommended WebSockets are run on port 80, which requires root access. To avoid proxy/firewall blockage it's recommended WebSockets are run on port 80, which requires root access.
Note that you can not run two applications (Apache and Ratchet) on the same port, thus the suggestion for a separate machine (unless you have a reverse proxy). In order to do this, along with your sync web stack, you can either use a proxy or two separate machines. You can find more details in the [server conf docs](http://socketo.me/docs/deploy#sconf).
PHP 5.3.3 (or higher) is required. If you have access, PHP 5.4 is *highly* recommended for its performance improvements. PHP 5.3.3 (or higher) is required. If you have access, PHP 5.4 is *highly* recommended for its performance improvements.
@ -75,8 +75,8 @@ class Chat implements MessageComponentInterface {
} }
} }
// Run the server application through the WebSocket protocol on port 8000 // Run the server application through the WebSocket protocol on port 8080
$server = IoServer::factory(new WsServer(new Chat), 8000); $server = IoServer::factory(new WsServer(new Chat), 8080);
$server->run(); $server->run();
``` ```