xmpp.chapril.org-conversejs/index.html

168 lines
8.4 KiB
HTML
Raw Normal View History

2013-03-28 16:42:49 +01:00
<!DOCTYPE html>
<html>
2013-03-28 17:52:07 +01:00
<head>
2013-03-28 16:42:49 +01:00
<meta charset='utf-8' />
<meta http-equiv="X-UA-Compatible" content="chrome=1" />
2013-04-14 00:03:43 +02:00
<meta name="description" content="Converse.js: Open Source Browser-Based Instant Messaging" />
2013-03-28 16:42:49 +01:00
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<link rel="stylesheet" type="text/css" media="screen" href="converse.css">
<!-- <script src="converse.min.js"></script> -->
<script data-main="main" src="Libraries/require-jquery.js"></script>
2013-03-28 16:42:49 +01:00
<title>Converse.js</title>
2013-03-28 17:52:07 +01:00
</head>
2013-03-28 16:42:49 +01:00
2013-03-28 17:52:07 +01:00
<body>
2013-03-28 16:42:49 +01:00
<!-- HEADER -->
<div id="header_wrap" class="outer">
2013-05-21 17:05:20 +02:00
<header class="inner">
<a id="forkme_banner" href="https://github.com/jcbrand/converse.js">View on GitHub</a>
<h1 id="project_title"><a href="http://conversejs.org">Converse.js</a></h1>
<h2 id="project_tagline">An XMPP chat client for your website</h2>
2013-05-21 17:05:20 +02:00
<section id="downloads">
2013-06-03 22:59:18 +02:00
<a class="zip_download_link" href="https://github.com/jcbrand/converse.js/archive/v0.4.zip">Download the latest release as a .zip file</a>
<a class="tar_download_link" href="https://github.com/jcbrand/converse.js/archive/v0.4.tar.gz">Download the latest release as a tar.gz file</a>
2013-05-21 17:05:20 +02:00
</section>
</header>
2013-03-28 16:42:49 +01:00
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
2013-04-01 18:41:46 +02:00
<section id="main_content" class="inner">
2013-04-25 00:23:59 +02:00
2013-06-02 22:33:29 +02:00
<p><strong>Converse.js</strong> is an open source, webchat client, that
runs in the browser and can be integrated into any website.</p>
2013-04-25 00:23:59 +02:00
2013-06-02 22:33:29 +02:00
<p>It's similar to <a href="https://www.facebook.com/sitetour/chat.php" target="_blank">Facebook chat</a>, but also supports multi-user chatrooms.</p>
2013-06-02 22:33:29 +02:00
<p><em>Converse.js</em> can connect to any accessible <a href="http://xmpp.org" target="_blank">XMPP/Jabber</a> server, either from a public provider such as
<a href="http://jabber.org">jabber.org</a>, or to one you have set up
yourself.</a>
<p>It's possible to enable single-site login, whereby users already authenticated in your website will also automatically be logged in on the chat server,
but you will have to pre-authenticate them on your server. You can refer to the <a href="/docs/html/index.html">documentation</a> for more
info.</p>
<p>An <a href="http://github.com/collective/collective.xmpp.chat" target="_blank">add-on product</a> that does exactly this,
already exists for the <a href="http://plone.org" target="_blank">Plone</a> CMS. Hopefully in the future more such add-ons will
be created for other platforms.
</p>
2013-06-02 22:33:29 +02:00
<p>If you have integrated <em>Converse.js</em> into any other CMS or framework,
2013-07-24 12:21:36 +02:00
<a href="http://opkode.com/contact.html" target="_blank">please let me know</a> and I'll mention it on this page.</p>
2013-03-28 16:42:49 +01:00
2013-04-01 18:41:46 +02:00
<h2>Features</h2>
<ul>
<li>Single-user chat</li>
<li>Multi-user chat in chatrooms (<a href="http://xmpp.org/extensions/xep-0045.html">XEP 45</a>)</li>
<li>vCard support (<a href="http://xmpp.org/extensions/xep-0054.html">XEP 54</a>)</li>
<li>Service discovery (<a href="http://xmpp.org/extensions/xep-0030.html">XEP 30</a>)</li>
2013-04-25 00:23:59 +02:00
<li>Contact rosters</li>
<li>Manually or automically subscribe to other contacts</li>
2013-04-01 18:41:46 +02:00
<li>Accept or decline contact requests</li>
<li>Roster item exchange (<a href="http://xmpp.org/extensions/tmp/xep-0144-1.1.html">XEP 144</a>)</li>
<li>Chat statuses (online, busy, away, offline)</li>
2013-04-01 18:41:46 +02:00
<li>Custom status messages</li>
<li>Typing notifications</li>
<li>Third person messages (/me )</li>
2013-06-02 00:42:22 +02:00
<li>i18n aware</li>
2013-04-01 18:41:46 +02:00
</ul>
2013-03-28 16:42:49 +01:00
<h2>Screencasts</h2>
<ul>
2013-04-19 00:09:04 +02:00
<li><a href="http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp" target="_blank">Screencast 1</a>:
Integrated into a Plone site via <strong>collective.xmpp.chat</strong>.
</li>
2013-04-19 00:09:04 +02:00
<li><a href="http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript" target="_blank">Screencast 2</a>:
A static HTML page with <em>Converse.js</em>. Here we chat to external XMPP accounts on Jabber.org and Gmail.
</li>
</ul>
2013-03-28 16:42:49 +01:00
2013-04-19 00:09:04 +02:00
<h2>Demo</h2>
2013-06-02 22:33:29 +02:00
<p>You can log in with any existing XMPP account. There is also a list of public XMPP providers on <a href="http://xmpp.net" target="_blank">xmpp.net</a>.</p>
<p><em><strong>Note:</strong> currently the demo doesn't work in Internet Explorer older
than 10. This is due to lacking support for <a href="https://en.wikipedia.org/wiki/Cross-origin_resource_sharing">CORS</a>,
a standard which enables cross-domain XmlHttpRequests. There are ways
around this, but it hasn't been a priority for me to implement them for
this demo.
2013-04-19 00:09:04 +02:00
</p>
<p>
2013-06-02 22:33:29 +02:00
See <a href="/docs/html/index.html#overcoming-cross-domain-request-restrictions" target="_blank">here</a> for more information.
</p>
2013-06-02 22:33:29 +02:00
</em>
2013-04-25 01:05:34 +02:00
<h3>Is it secure?</h3>
2013-06-02 22:33:29 +02:00
<p>Yes. In this demo <em>Converse.js</em> makes an
2013-04-25 01:05:34 +02:00
<a href="https://en.wikipedia.org/wiki/Secure_Sockets_Layer" target="_blank">SSL</a> encrypted connection to a secure connection manager.
The connection manager then uses SSL and <a href="https://en.wikipedia.org/wiki/Transport_Layer_Security">TLS</a> to connect to an XMPP server.</p>
That said, the developers don't assume any liability for any loss or damages as a result of using this software or demo. Use this demo at your own risk.
<h3>Session support</h3>
2013-04-25 00:23:59 +02:00
<p>
The chat client will disconnect whenever you reload the page. If you
want the user's session to persist across page reloads, you can
establish an authenticated connection on the server side and then attach to
this connection in your browser.
</p>
2013-06-02 22:33:29 +02:00
<p><em>Converse.js</em> already supports this usecase, but you'll have to do some integration work yourself.</p>
2013-04-25 01:05:34 +02:00
<h2>Documentation</h2>
<p>
The documentation is still a bit sparse and a work in progress.
Nevertheless, you can read what's already written <a href="/docs/html/index.html" target="_blank">here</a>.
</p>
2013-04-19 00:39:40 +02:00
<h2>Tests</h2>
2013-05-09 22:27:03 +02:00
<p>
2013-04-19 00:39:40 +02:00
We use the <a href="http://pivotal.github.io/jasmine"
target="_blank">Jasmine</a> testing framework to write tests.
The tests can be run in the browser and can be viewed <a href="http://conversejs.org/tests.html" target="_blank">here</a>.
2013-05-09 22:27:03 +02:00
</p>
2013-04-19 00:39:40 +02:00
2013-05-09 22:27:03 +02:00
<h2>Credits and Dependencies</h2>
2013-04-01 18:41:46 +02:00
<p><strong>Converse.js</strong> depends on a few third party libraries, including:
<ul>
2013-05-31 12:04:31 +02:00
<li><a href="http://jquery.com" target="_blank">JQuery</a></li>
2013-04-19 00:09:04 +02:00
<li><a href="http://strophe.im/strophejs" target="_blank">strophe.js</a></li>
2013-04-19 17:12:35 +02:00
<li><a href="http://backbonejs.org" target="_blank">backbone.js</a></li>
2013-05-31 12:04:31 +02:00
<li><a href="http://requirejs.org" target="_blank">require.js</a> (optional dependency)</li>
2013-04-01 18:41:46 +02:00
</ul>
</p>
2013-05-09 22:27:03 +02:00
<p>Some images were taken from <a href="http://plone.org" target="_blank">Plone</a> and the
<a href="http://openiconlibrary.sourceforge.net" target="_blank">Open Icon Library</a>.
2013-03-28 16:42:49 +01:00
2013-04-01 18:41:46 +02:00
<h2>Licence</h2>
2013-04-19 00:09:04 +02:00
<p><strong>Converse.js</strong> is released under both the <a href="http://opensource.org/licenses/mit-license.php" target="_blank">MIT</a>
and <a href="http://opensource.org/licenses/GPL-2.0" target="_blank">GPL</a> licenses.</p>
2013-05-31 12:04:31 +02:00
<h2>Contact</h2>
<p>My XMPP username is <strong>jc@opkode.im</strong>.</p>
<p>You can send me an email via this <a href="http://opkode.com/contact" target="_blank">contact form</a>.</p>
2013-04-18 23:05:25 +02:00
</section>
2013-05-31 12:04:31 +02:00
2013-04-18 23:05:25 +02:00
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">Converse.js created by <a href="http://opkode.com" target="_blank">jcbrand</a></p>
2013-04-18 23:05:25 +02:00
</footer>
</div>
2013-03-28 16:42:49 +01:00
2013-04-18 23:05:25 +02:00
<div id="chatpanel">
<div id="collective-xmpp-chat-data"></div>
<div id="toggle-controlbox">
2013-04-19 00:09:04 +02:00
<a href="#" class="chat toggle-online-users">
<strong class="conn-feedback">Toggle chat</strong> <strong style="display: none" id="online-count">(0)</strong>
2013-04-18 23:05:25 +02:00
</a>
2013-03-28 16:42:49 +01:00
</div>
2013-04-18 23:05:25 +02:00
</div>
2013-04-01 23:44:49 +02:00
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">try { var pageTracker = _gat._getTracker("UA-2128260-8"); pageTracker._trackPageview(); } catch(err) {}</script>
</body>
2013-03-28 16:42:49 +01:00
</html>