AeroGear UnifiedPush Server

The AeroGear UnifiedPush Server is a server that allows sending push notifications to different (mobile) platforms. The initial version of the server supports Apple’s APNs, Google Cloud Messaging and Mozilla’s SimplePush.

Getting started

The following steps are needed to get going!

• Get the latest WAR files
• Setup a database of your choice
• Start the {Wildfly|JBossAS7} server (e.g. $JBOSS/bin/standalone.sh -b 0.0.0.0)
• Deploy the two WAR files to the server

Now go to http://localhost:8080/ag-push and enjoy the UnifiedPush Server. NOTE: the default user/password is admin:123

Documentation

For more details about the current release, please consult our documentation.

Instructions for Keycloak administration console

Note: The instructions below are pretty much based on Keycloak integration with UPS.

• The aerogear security admin (keycloak) http://localhost:8080/auth/admin/aerogear/console/index.html
• The aerogear user account page (keycloak) http://localhost:8080/auth/realms/aerogear/account

SSL by default

The Keycloak directives inside UnifiedPush server will enforce SSL to all external IP addresses, except for localhost and Docker images.

Development

The above Getting started section covers the latest release of the UnifiedPush Server. For development and deploying SNAPSHOT versions, you will find information in this section.

Deployment

For deployment of the master branch to a specific server (Wildfly or JBossAS7), you need to build the WAR files and deploy them to a running and configured server.

First build the entire project:

mvn clean install

Note, this will build the also the WAR files for both, WildFly and JBossAS7. If you are only intereted in building for a specific platform, you can also use the profiles, discussed below.

Deployment to WildFly

For WildFly, invoke the following commands afer the build has been completed. This will deploy both WAR files to a running and configured Wildfly server.

cd servers
mvn wildfly:deploy -Pwildfly

Deployment to JBossAS7

For JBossAS7, invoke the following commands afer the build has been completed. This will deploy both WAR files to a running and configured AS7 server.

cd servers
mvn jboss-as:deploy -Pas7

AdminUI and its release

The sources for administration console UI are placed under admin-ui.

For a build of the admin-ui during release, you can just run a Maven build, the admin-ui will be compiled by frontend-maven-plugin during admin-ui module build.

For instructions how to develop admin-ui, refer to admin-ui/README.md.

These instructions contains also specific instructions how to upgrade NPM package dependencies.

Note that the {{frontend-maven-plugin}} may fail if you killed the build during its work - it may leave the downloaded modules in inconsistent state, see admin-ui/README.md.

Openshift

For our Openshift Online cartridge we enforce HTTPS. This is done with a specific Maven Profile. To build the WAR files for Openshift the following needs to be invoked:

mvn clean install -Popenshift,test

The WAR file can be used to update our Cartridge.

Releasing the UnifiedPush Server

The content of the Release Process is valid for this project as well. However, to build the distribution bundle, you need to include these profiles:

mvn release:GOAL -Pdist,test

Any questions ?

Join our mailing list for any questions and help! We really hope you enjoy our UnifiedPush Server!