socket.io-notify's Introduction

Socket.IO Notify

node >=4.1.1

A simple notification dispatcher written in nodeJS using socket.io

How to use

$ cd socket.io-notify
$ npm install
$ npm start

##Configuration all the configuration can be passed by env variables.

PORT //port to run the dispatcher, default is '3000';
NOTIFICATION_KEY //notification key, that your client will configure to connect in a channel, default is NOTIFICATION_KEY
NOTIFICATION_SECRET //notification secret, your server will use to dispatch notifications, default is NOTIFICATION_SECRET

##SSL(HTTPS)

for ssl configuration you only need to set those two env variables

SSL_KEY="sslkey"
SSL_CERT="path/to/certified"

Client side - Javascript

document.addEventListener("DOMContentLoaded", function(event) {
  var socket = io.connect('127.0.0.1:3000', {
    query: 'notificationKey=NOTIFICATION_KEY'
  });
  socket.on('NEW_NOTIFICATION', function (notification) {
    console.log(notification);
  });

  //to join a channel
  socket.emit('join', 'SOME_CHANNEL');

  //to leave a channel
  socket.emit('leave', 'SOME_CHANNEL');
});

##Sending notifications

bash

$ curl --request POST 'http://localhost:3000/send' --header notification_secret:NOTIFICATION_SECRET --data 'notification=notificationexample&channel=SOME_CHANNEL'

Server side - PHP

<?php

use Guzzle\Http\Client;


$socketio_host = getenv('SOCKETIO_HOST');
$socketio_port = getenv('SOCKETIO_PORT');
$secret = getenv('NOTIFICATION_SECRET');
$channel = 'some_channel';
$client = new Client;
$request = $client->post($socketio_host.':'.$socketio_port. '/send', [], [
    'notification[description]' => $text,
    'channel' => $channel
]);
$request->setHeader('notification_secret', $secret);
$response = $request->send();

Recommend Projects