XPUSH, Quick-start guide

Updated: April 25, 2014.

You can download and run the image file of XPUSH at the docker repository. it is possible to install and run and, in this way, you can be most easily and quickly experience the XPUSH.

XPUSH Docker image files is shared in docker hub, You can download the image to your server or personal PC, and then you can install and run the xpush with it.

1. Docker Installation

Docker Installation By referring to the link, install the Docker.

2. Downloading XPUSH Docker image

XPUSH Docker image which we provide is the already configured completely. You can download the XPUSH image file as follows.

docker pull stalk/xpush:standalone

MongoDB and Redis and Zookeeper are installed in the downloaded image, and You can run the session server and channel server as a stand-alone.

3. Execution of XPUSH server

Now, you can run the image that you downloaded in Docker environment.

docker run -d –name xpush -p 8000:8000 -p 9000:9000 stalk/xpush:standalone /bin/bash xpush-stand-alone.sh

8000 port is a port number that Session server uses, 9000 port is the port number that Channel server uses. Xpush server that have been executed is accessible to

To access to XPUSH server that you run in docker in OSX, you can obtain an IP address by using the following command. More info

boot2docker ip

4. Sample JavaScript Source

Include the XPUSH client library

<script type="text/javascript" charset="utf-8" src="xpush.min.js"></script>

Create the xpush Object

// parameter : server to connect, applicationId
var xpush = new XPush('', 'sample');

When you create a XPUSH instance, The first argument, it is session server address of XPUSH. The server address to be used in the code is only session server. As a result, XPUSH library will let you automatically connect to find the Channel server internally.

Now, I will generate a channel for the message received.

xpush.createSimpleChannel('channel01', function(){
  console.log( 'create simple channel success' );

      // Output the data to the screen that comes in  `message` event.
  xpush.on( 'message', function(channel, name, data){
    console.log( channel, name, data );

Create a channel named channel01. Channels are used as the address to send and receive messages, can be thought of as chat room in chatting program. Register a function to be called when it is created after the event occurred.

When the event named message occurs, the will be printed at the console.

Now, We can send the string “Hello World” to message events in channel01 channel. String as well, JSON type is also available.

xpush.send( 'channel01', 'message', 'Hello World' );

5. Live Demo

We will implement a simple chat in such a way as described above.

Full source can be found in here.

The XPUSH server that was used in the demo below is a server for temporary test provided by the XPUSH development team, can not operate temporarily, it is not possible to guarantee the performance. So, please use the XPUSH on your own.

Demo complete source

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>

<!-- xpush -->
<script src="http://xpush.github.io/lib/dist/xpush.js"></script>

<script type="text/javascript">
// Create new xpush instance
var xpush = new XPush('http://demo.stalk.io:8000', 'demo');

$(document).ready( function(){
// Generate channel named `channel01`
  xpush.createSimpleChannel('channel01', function(){
    // Display success message after creation.
    var html =  '<strong>Well done!</strong> Create simple channel success';
    $( "#success" ).html(html);
    $( "#success" ).show();

      // Output the data to the screen that comes in  `message` event.
    xpush.on( 'message', function(channel, name, data){
     data = decodeURIComponent( data );
      $( "#success" ).html( '<strong>Received success</strong> : ' + data );

      // Generate a new DOM object by copying the template.
      var newMessage = $( "#template" ).clone();

      // Change the DOM object that was the newly created.
      newMessage.attr( "id", "template_"+ Date.now() );
      newMessage.html( data );

      // Add the DOM object that was the newly created to the ul DOM object
      newMessage.appendTo( "#list" )

      // Add css class to the DOM object that was the newly created
      $( ".list-group-item-success" ).each(function(){
        $(this).removeClass( "list-group-item-success" );
      newMessage.addClass( "list-group-item-success" );

var send = function( ){
  var msg = $( "#message" ).val();
xpush.send( 'channel01', 'message', encodeURIComponent( msg ) );
  $( "#message" ).val('');


<div class="row" style="margin-top:20px;">
  <div class="col-sm-12">
    <div class="jumbotron">
      <h1>Simple Channel Example</h1>
      <p class="lead">Send a message with simple channel</p>
        <a href="https://github.com/xpush/lib-xpush-web/blob/master/example/simple.html" class="btn btn-primary btn-lg" role="button"
          View source from github
    <div id="success" class="alert alert-success" role="alert" style="display:none">

    <div style="display:flex;">
      <input class="form-control" placeholder="Input message" name="message" id="message" type="text" value=""/>
      <button type="submit" id="form-button" class="btn btn-primary" style="margin-left:10px;" onclick="send();">
    <span class="help-block">Input message to send. The message will be displayed in under area</span>

    <div class="row">
     <div class="col-sm-8">
        <h2>Received message</h2>
        <ul id="list" class="list-group">
          <li id="template" class="list-group-item" style="display:none;">There is no message</li>

Code Result

Simple Channel Example

Send a message with simple channel

View source from github

Input message to send. The message will be displayed in under area

Received message


XPUSH is an opensource realtime communication platform for quickly, easily adding scalable functionality to web and mobile environment.
It lets you develop faster, deploy easier and scale bigger.

Source Link

- Opensource Project from github

Code licensed under MIT License
Documentation licensed under CC BY 3.0