From c3b3f17b2085738ed3b2a96641c25b09ce4a1999 Mon Sep 17 00:00:00 2001 From: Lance Stout Date: Tue, 31 Dec 2013 11:24:13 -0800 Subject: [PATCH] Add installation steps to README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 602e22b..c8d071f 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,17 @@ Otalk is an open source chat client powered by [XMPP](http://xmpp.org), [stanza. While we have a version hosted at https://otalk.im, you can still run your own private instance. +## Installing + + git clone https://github.com/andyet/otalk.git + cd otalk + npm install + node server + +You can also run your own [XMPP server](https://github.com/andyet/otalk-server). + +*Note:* If you're running your own XMPP server, and aren't using something like HAProxy to terminate SSL, then you might get errors in certain browsers trying to establish a WebSocket connection because the XMPP server is requesting an optional client certificate which makes the browser terminate the socket. To resolve that, visit the XMPP over Websocket URL directly (eg, example.com:5281/xmpp-websocket for Prosody) so that a client cert choice can be made. After that, the Otalk client should connect fine. + ## What's included? Otalk comes with support for: