Openfire Logo

StanzaJS: A Minimal Working Example (in Javascript/Typescript)


This document provides a minimal working example of a client implementation using the StanzaJS library, making it connect to a running Openfire server.

Topics that are covered in this document:


StanzaJS is a JavaScript/TypeScript library for using modern XMPP, and it does that by exposing everything as JSON. Unless you insist, you have no need to ever see or touch any XML when using StanzaJS.

This guide describes how to use StanzaJS to connect to Openfire. It provides nothing more than a minimal working example, intended as a stepping stone to for client developers that get started with a new project.


In this example, a client connection will be made against a running Openfire server. For ease of configuration, the 'demoboot' setup of Openfire is used.

The 'demoboot' setup of Openfire allows one to start a fresh installation of Openfire into a certain provisioned state, without running any of the setup steps. When running in 'demoboot' mode:

To start Openfire in 'demoboot' mode, you can invoke the Openfire executable using the -demoboot argument, as shown below.

Starting Openfire in 'demoboot' mode.
$ ./bin/ -demoboot


Copy the following code in a fresh project.

Echo client example
import * as XMPP from 'stanza';

const client = XMPP.createClient({
    jid: '',
    password: 'secret',

    transports: {
        websocket: 'ws://'

client.on('session:started', () => {

client.on('chat', msg => {
        to: msg.from,
        body: 'You sent: ' + msg.body


When this project is running, have a look at the Openfire Administrative Console: you should notice that the user named 'john' is online! Use any other XMPP client to log in with the user 'jane', and send a message to John. The code above will cause John to echo back the message that you have sent.

Note that this example disables important security features. You should not use this for anything important!

Further Reading

Please use the links below to find more information.