Giter Club home page Giter Club logo

mercurius's Introduction

mercurius

Cross-platform web push center. Site allows to proxy a POST request to a full featured push notification. Especially useful for services without web presence, originally came out as an IRSSI notification system.

Secure, as no data is stored except of generated token, machine id with an endpoint and connected client names.

We're currently running a publicly available development server under Heroku.

Check the post on Mozilla's hacks page to see a real live usecase.

Build Status dependencies devdependencies

API

POST /notify

Send a notification to a user.

The body of the request is a JSON object containing:

  • token;
  • client - the client sending the notification (e.g. 'Irssi');
  • payload;
  • (optional) TTL (Time-To-Live of the notification).

The payload is a JSON object containing the parameters of the nofication to be shown to the user:

  • title: the title of the notification;
  • body: the body of the notification.

Example:

{
    "token": "aToken",
    "client": "someClient",
    "payload": {
        "title": "IRSSI",
        "body": "a message"
    }
}

VARIABLES

Mandatory :

  • REDISCLOUD_URL (Ex. redis://localhost:6379)

Optional

  • GCM_API_KEY : Your Google API Key to send notification to Chrome.
  • DISABLE_SSL_REDIRECT : Disable the built-in SSL redirection.

INSTALL

Install Redis database and set REDISCLOUD_URL environment variable to its host (redis://localhost:6379)

DOCKER

  • clone this repo
cd mercurius && docker build -t="mercurius" .
docker run --publish 4000:4000 -e REDISCLOUD_URL="redis://localhost:6379" -e GCM_API_KEY="" -e DISABLE_SSL_REDIRECT="1" mercurius

mercurius's People

Contributors

marco-c avatar zalun avatar c4software avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.