Skip to content
Turnkey Platform Stack For Mobile & Rich Client Applications
Find file
Pull request Compare This branch is 672 commits ahead of vaske:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


A highly-scalable data platform for mobile applications.

Getting Started

Note: The easiest way to run Usergrid is to download our latest nightly, pre-built jar:

curl -O$usergrid-launcher/artifact/org.usergrid/usergrid-launcher/0.0.1-SNAPSHOT/usergrid-launcher-0.0.1-SNAPSHOT.jar

Then start Usergrid with:

cd launcher; java -jar target/usergrid-launcher-*.jar

It should pop up an admin window. Press play to spin up Usergrid; it’ll run locally on http://localhost:8080/.

You can use our admin UI on it by visiting



From the command line, go to the usergrid directory and type the following:

mvn clean install -DskipTests=true

If you don't want to do a full build, you can download a pre-built version of the launcher app from our Cloudbees nightlies.


Usergrid-core contains the persistence layer and shared utilities for powering the Usergrid service. The services layer is contained in usergrid-services and exposes a higher-level API that's used by the usergrid-rest web services tier.

You can run Usergrid from the command-line from the jar in the usergrid/standalone project:

cd launcher; java -jar target/usergrid-launcher-*.jar

After startup, your instance will be available on localhost, port 8080. To check it’s running properly, you can try loading our status page:

curl http://localhost:8080/status

You can also run it as a webapp in Tomcat, by deploying the ROOT.war file generated in the usergrid/rest project.

Using the Admin Portal

By default, the Usergrid admin portal points to our production servers at However, by specifying an api_url argument in the query string, you can have it point to your local instance instead. For example, you could reuse the version of the admin portal we host on github and have that point to your local cluster by opening the following URL in your browser:

The same trick would work if you used a local copy of the portal code served from your own machine or servers.


We welcome all contributions! If you want to submit code, please submit a pull request to apigee/usergrid-stack, using a topic branch.

We’d prefer if your commit messages referenced the issue at hand (if applicable). We don’t have particular guidelines for commit messages but we appreciate branch names that observe the following format: issue#-singleworddescription (i.e. 325-twitter) or just a single word if no issue exists on the topic. Thanks!


Usergrid is licensed under the Apache License, Version 2.

Something went wrong with that request. Please try again.