Skip to content

Quickstart

Start chatting immediately at chat.conversejs.org.

Log in with any existing XMPP account, or create a new one via the registration form.

To run your own instance, follow the steps below. You’ll need:

  • An XMPP server (or an account on a public server like conversations.im or jabber.de)
  • A web server (or just a local HTML file for testing)

Add these lines to your HTML <head>:

<link rel="stylesheet" href="https://cdn.conversejs.org/dist/converse.min.css">
<script src="https://cdn.conversejs.org/dist/converse.min.js"></script>

You can also pin to a specific version:

<link rel="stylesheet" href="https://cdn.conversejs.org/12.0.0/dist/converse.min.css">
<script src="https://cdn.conversejs.org/12.0.0/dist/converse.min.js"></script>

If you prefer to host the files yourself, either:

Many servers have built-in plugins that serve Converse for you:

Check your server’s documentation — this is often the easiest path.

Add this before your closing </body> tag:

<script>
converse.initialize({
// Replace with your XMPP server's BOSH or WebSocket URL
bosh_service_url: 'https://your-xmpp-server:5280/bosh',
// Or use WebSocket:
// websocket_url: 'wss://your-xmpp-server:5280/ws',
});
</script>
<!DOCTYPE html>
<html>
<head>
<title>My Chat</title>
<link rel="stylesheet" href="https://cdn.conversejs.org/12.0.0/dist/converse.min.css">
<script src="https://cdn.conversejs.org/12.0.0/dist/converse.min.js"></script>
</head>
<body>
<script>
converse.initialize({
bosh_service_url: 'https://conversejs.org/http-bind/',
});
</script>
</body>
</html>

Save this as index.html and open it in your browser. You’ll see a login screen where you can enter any XMPP account.

Converse supports three layouts:

ModeDescriptionBest for
fullscreenChat fills the entire pageStandalone chat apps
overlayChat floats in a corner, toggleableAdding chat to an existing site
embeddedChat lives inside a specific <div>Custom page layouts
converse.initialize({
view_mode: 'fullscreen', // or 'overlay' or 'embedded'
});

See the live demos for examples of each mode.

Thank you to our sponsors

If you'd like to sponsor this project, please visit Github, Patreon, Liberapay or contact us.