Getting Started

AeroGear provides a suite of Mobile Services across a range of native and hybrid client SDKs, leveraging OpenShift's Container technology to provide a secure, scalable backend platform. The workflow for connecting your mobile app to mobile services is outlined here.



  • MacOS or Linux
  • Docker version 17.09.1
  • Ansible 2.4 or later
  • OpenShift client tools 3.9 or later (see this guide)

Once OpenShift is installed, you need to install an add-on which will enable the AeroGear suite of Mobile Services on top of OpenShift.

The installation process is straightforward when using the installation script provided in the mobile core repo:

git clone && cd mobile-core
git checkout 1.0.0-alpha

Once the installation is complete, open a browser and (accepting the self-signed certificate) navigate to:

The developer login credentials are:

username: developer
password: password

For a full list of options and troubleshooting the install script, see the complete installation guide.

Creating your first App

AeroGear contains support for multiple different platforms: iOS, Android, Cordova and Xamarin. There are a few simple steps for getting started with AeroGear services within your Mobile app.

Note: If you do not have an application, there are a variety of different sample applications that you get up and running with quickly. See more about our showcase applications here.

Getting Started

  1. Set up a representation of your application in OpenShift. You need to create a represenation of your Mobile application in OpenShift by creating a Mobile Client. Follow the guide here for doing this.
  2. Provision a Mobile Service. There are a variety of different Mobile Services you can plug in to your application. Follow the guide here for provisiong a Mobile Service and binding it to your Mobile Client.
  3. Configure your application. Now that you've created the desired structure for your application on OpenShift, you're ready to incorporate it into your code. To do this, you need to configure your application with the JSON config file from your Mobile Client on OpenShift and any SDK components you may need for communicating with the Mobile Service.

That's it! Head to the AeroGear docs for many more examples and in depth instructions on getting started with our Mobile offering.