Uniqush is a free and open source software system which provides a unified push service for server side notification to apps on mobile devices.
Go Shell
Latest commit f5d0070 Nov 1, 2016 @TysonAndre TysonAndre committed on GitHub Add /previewpush endpoint to preview payloads sent to push services. (#…
…140)

`/previewpush` accepts the same payload query params as `push`.

However, it does not accept subscribers or services.
Instead, it requires the pushservicetype param (apns, gcm, or adm)
Being able to see what Uniqush is sending is useful for
debugging iOS,Android,etc. client issues handling/parsing notifications.
(Note: Fields such as TTL are outside of the JSON payload for APNS)

Subscriber data, if part of the "payload", is replaced with dummy
subscriber data in the returned result.

Add tests, update mocks to implement Preview.

Use reflect.DeepEqual for a unit test - The order of keys is not
guaranteed.
Permalink
Failed to load latest commit information.
build Update the installation script, for #128 Aug 3, 2016
conf Commit /subscriptions, /services and /rebuildserviceset API endpoints Mar 7, 2016
db Migrate the redis implementation to redis.v3, Remove invalid PSPs (#132) Aug 10, 2016
push Add /previewpush endpoint to preview payloads sent to push services. (#… Oct 31, 2016
scripts Add basic Dockerfile and run script for it Jun 3, 2015
srv Add /previewpush endpoint to preview payloads sent to push services. (#… Oct 31, 2016
.gitignore add .gitignore Aug 31, 2011
.travis.yml Add .travis.yml to run go unit tests on latest version of go, add REA… Aug 3, 2016
AUTHORS Changed the license from LGPL to Apache 2.0. Sep 14, 2011
Dockerfile Woops, this should be /usr/bin/uniqush-push not ./bin/uniqush-push Jun 3, 2015
INSTALL.md Changed the url of install page to the actual url May 14, 2013
LICENSE Changed the license from LGPL to Apache 2.0. Sep 14, 2011
README.md Add .travis.yml to run go unit tests on latest version of go, add REA… Aug 3, 2016
TODO.md [Mod] Change the file name of TODO list so that we can read it on github Mar 8, 2013
configparser.go Add /previewpush endpoint to preview payloads sent to push services. (#… Oct 31, 2016
main.go Bump version to 2.2.0 Aug 28, 2016
pushbackend.go Add /previewpush endpoint to preview payloads sent to push services. (#… Oct 31, 2016
restapi.go Add /previewpush endpoint to preview payloads sent to push services. (#… Oct 31, 2016
restapi_pushresponse.go Change the response format from logger output to a structured JSON re… Feb 17, 2016
restapi_response.go Add /previewpush endpoint to preview payloads sent to push services. (#… Oct 31, 2016
restapi_simpleresponse.go Change the response format from logger output to a structured JSON re… Feb 17, 2016
restapi_unix.go [Add] SIGTERM in unix Mar 8, 2013
restapi_windows.go [Add] stop on os kill on windows Mar 8, 2013

README.md

Introduction

Uniqush (\ˈyü-nə-ku̇sh\ "uni" pronounced as in "unified", and "qush" pronounced as in "cushion") is a free and open source software system which provides a unified push service for server side notification to apps on mobile devices. The uniqush-push API abstracts the APIs of the various push services used to send push notifications to those devices. By running uniqush-push on the server side, you can send push notifications to any supported mobile platform.

Build Status

Supported Platforms

  • GCM from Google for the Android platform
  • APNS from Apple for the iOS platform
  • ADM from Amazon for Kindle tablets

FAQ

  • Q: Is this a general push notification platform for all types of devices? How does this differ from services such as Urban Airship?
  • A: Urban Airship is a great service, and there are other similar services available, like OpenPush, Notificare, etc. All of them are wonderful services. However, Uniqush is different from them. Uniqush is not a service. Instead, Uniqush is a system, which runs on your own server. In fact, if you wish, you can use Uniqush to setup a service similar to Urban Airship.

  • Q: OK. Then is it a library? Like java-apns?

  • A: Well.. Not actually. I mean, it is a program, like Apache HTTP Server. You download it, you run it. It does require a Redis server, but, other than that, you don't need to worry about which language to use, package dependencies, etc.

  • Q: But wait, how can I use it anyway? I mean, if my program wants to send a push notification, I need to tell Uniqush about this action. How can I communicate with Uniqush? There must be some library so that I can use it in my program to talk with Uniqush, right?

  • A: We are trying to make it easier. uniqush-push provides RESTful APIs. In other words, you talk with uniqush-push through HTTP protocol. As long as there's an HTTP client library for your language, you can use it and talk with uniqush-push. For details about the our RESTful APIs, see our API documentation.

  • Q: Then that's cool. But I noticed that you are using Go programming language. Do I need to install Go compiler and other stuff to run uniqush-push?

  • A: No. There are no installation dependencies. All you need to do is to download the binary file from the download page and install it. But you do need to set up a Redis server running somewhere, preferably with persistence, so that uniqush-push can store the user data in Redis. For more details, see the installation guide

  • Q: This is nice. I want to give it a try. But you are keep talking about uniqush-push, and I'm talking about Uniqush, are they the same thing?

  • A: Thank you for your support! Uniqush is intended to be the name of a system which provides a full stack solution for communication between mobile devices and the app's server. uniqush-push is one piece of the system. However, right now, uniqush-push is the only piece and others are under active development. If you want to know more details about the Uniqush system's plan, you can read the blog post. If you want to find out about the latest progress with Uniqush, please check out our blog. And, if you are really impatient, there's always our our GitHub account which could have brand new stuff that hasn't been released yet.

Setting Up Redis

Redis persistence describes the details of how Redis saves data on shutdown, as well as how one might back up that data. Make sure that the Redis server you use has persistence enabled - your redis.conf should have contents similar to the section **PERSISTENCE** of redis.conf in the example config files linked in http://redis.io/topics/config

Contributing

You're encouraged to contribute to the uniqush-push project. There are two ways you can contribute.

Issues

If you encounter an issue while using uniqush-push, please report it at the project's issues tracker. Feature suggestions are also welcome.

Pull request

Code contributions to uniqush-push can be made using pull requests. To submit a pull request:

  1. Fork this project.
  2. Make and commit your changes.
  3. Submit your changes as a pull request.

Related Links