You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2015/08/12 19:14:12 UTC
[17/60] [abbrv] incubator-usergrid git commit: cherry picking docs
from master
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/index.html
----------------------------------------------------------------------
diff --git a/content/docs/index.html b/content/docs/index.html
new file mode 100644
index 0000000..81812d4
--- /dev/null
+++ b/content/docs/index.html
@@ -0,0 +1,732 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Apache Usergrid Documentation — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="#"/>
+ <link rel="next" title="Usergrid Features" href="introduction/usergrid-features.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="#" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="#">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="#">Docs</a> »</li>
+
+ <li>Apache Usergrid Documentation</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="_sources/index.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="apache-usergrid-documentation">
+<h1>Apache Usergrid Documentation<a class="headerlink" href="#apache-usergrid-documentation" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound" id="introduction">
+<p class="caption"><span class="caption-text">Introduction</span><a class="headerlink" href="#introduction" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#data-storage-management">Data storage & management</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#flexible-data-querying">Flexible data querying</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#social">Social</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#user-management">User management</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#geolocation">Geolocation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/usergrid-features.html#push-notifications">Push notifications</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#organizations">Organizations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#applications">Applications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#collections">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#entities">Entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#default-entities">Default entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#properties">Properties</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/data-model.html#default-properties">Default properties</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction/async-vs-sync.html#synchronous">Synchronous</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction/async-vs-sync.html#asynchronous">Asynchronous</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="id1">
+<span id="getting-started"></span><p class="caption"><span class="caption-text">Getting Started</span><a class="headerlink" href="#id1" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-a-new-application.html#creating-an-application">Creating an application</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-a-new-application.html#securing-an-application">Securing an application</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/creating-account.html#next-steps">Next steps</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-a-sandbox-app.html#what-is-the-sandbox-application">What is the sandbox application?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-a-sandbox-app.html#is-the-sandbox-secure">Is the sandbox secure?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-a-sandbox-app.html#creating-a-new-sandbox-application">Creating a New Sandbox Application</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="getting-started/using-the-api.html">Using the API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#supported-http-methods">Supported HTTP methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#base-url">Base URL</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#request-construction">Request construction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#accessing-collections">Accessing collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#accessing-entities">Accessing entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#issuing-queries">Issuing queries</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#authentication-oauth">Authentication (OAuth)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#response-format">Response format</a></li>
+<li class="toctree-l2"><a class="reference internal" href="getting-started/using-the-api.html#sdks">SDKs</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="id2">
+<span id="data-storage"></span><p class="caption"><span class="caption-text">Data Storage</span><a class="headerlink" href="#id2" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/optimizing-access.html">Data Store Best Practices</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/optimizing-access.html#put-your-data-in-as-you-ll-want-to-get-it-out">Put your data in as you’ll want to get it out</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/optimizing-access.html#best-practice-denormalize-for-pre-computed-query-results">Best practice: Denormalize for pre-computed query results</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/collections.html">Collections</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/collections.html#creating-collections">Creating Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/collections.html#retrieving-collections">Retrieving Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/collections.html#updating-collections">Updating Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/collections.html#deleting-collections">Deleting Collections</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-storage/entities.html">Entities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#creating-custom-data-entities">Creating Custom Data Entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#creating-multiple-custom-entities">Creating multiple custom entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#retrieving-data-entities">Retrieving Data Entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#updating-data-entities">Updating Data Entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-storage/entities.html#deleting-data-entities">Deleting Data Entities</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="id3">
+<span id="data-queries"></span><p class="caption"><span class="caption-text">Data Queries</span><a class="headerlink" href="#id3" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/querying-your-data.html">Querying your data</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/querying-your-data.html#basic-query-usage">Basic query usage</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/query-parameters.html">Query parameters & clauses</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#contains">Contains</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#location">Location</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#order-by">Order by</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#limit">Limit</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/query-parameters.html#cursor">Cursor</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/operators-and-types.html">Query operators & data types</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/operators-and-types.html#operators">Operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/operators-and-types.html#data-types">Data types</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="data-queries/advanced-query-usage.html">Advanced query usage</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="data-queries/advanced-query-usage.html#attaching-a-query-to-all-api-calls">Attaching a query to all API calls</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="id4">
+<span id="entity-connections"></span><p class="caption"><span class="caption-text">Entity Connections</span><a class="headerlink" href="#id4" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="entity-connections/connecting-entities.html">Connecting entities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/connecting-entities.html#request-syntax">Request syntax</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="entity-connections/retrieving-entities.html">Retrieving connections</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/retrieving-entities.html#request-syntax">Request syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/retrieving-entities.html#retrieve-all-connected-entities">Retrieve all connected entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/retrieving-entities.html#retrieve-all-connecting-entities-by-type">Retrieve all connecting entities by type</a></li>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/retrieving-entities.html#retrieve-all-connecting-entities">Retrieve all connecting entities</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="entity-connections/disconnecting-entities.html">Disconnecting entities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="entity-connections/disconnecting-entities.html#request-syntax">Request syntax</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="security-authentication">
+<span id="security-and-authentication"></span><p class="caption"><span class="caption-text">Security & Authentication</span><a class="headerlink" href="#security-authentication" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-permissions.html#permissions-syntax">Permissions syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-permissions.html#complex-paths">Complex paths</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-permissions.html#assigning-permissions">Assigning permissions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/using-permissions.html#removing-permissions">Removing permissions</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#authentication-levels">Authentication levels</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#application-user-authentication-user-login">Application user authentication (user login)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#application-client-authentication">Application client authentication</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#admin-user-authentication">Admin user authentication</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html#organization-client-authentication">Organization client authentication</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/user-authentication-types.html#configuring-authentication-levels">Configuring authentication levels</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/user-authentication-types.html#user-authentication-level">User authentication level</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/user-authentication-types.html#admin-authentication-levels">Admin authentication levels</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html#default-ttl">Default ttl</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html#changing-the-default-ttl">Changing the default ttl</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html#changing-ttl-when-a-token-is-created">Changing ttl when a token is created</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-api-requests.html">Authenticating API requests</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-api-requests.html#authenticating-with-access-tokens">Authenticating with access tokens</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/authenticating-api-requests.html#authenticating-with-client-id-and-client-secret">Authenticating with client ID and client secret</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/revoking-tokens-logout.html#revoking-tokens-user-logout">Revoking tokens (user logout)</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/facebook-sign.html">Facebook sign in</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/facebook-sign.html#facebook-login-example">Facebook login example</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="security-and-auth/securing-your-app.html">Security best practices</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#never-use-the-sandbox-for-a-production-app">Never use the ‘sandbox’ for a production app</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#review-permissions-in-your-apps">Review permissions in your apps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#edit-the-default-role">Edit the ‘default’ role</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#use-https">Use https</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#acquire-access-tokens-in-a-secure-way">Acquire access tokens in a secure way</a></li>
+<li class="toctree-l2"><a class="reference internal" href="security-and-auth/securing-your-app.html#treat-mobile-clients-as-untrustworthy">Treat mobile clients as untrustworthy</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="user-management-social-graph">
+<span id="user-management-and-social-graph"></span><p class="caption"><span class="caption-text">User Management & Social Graph</span><a class="headerlink" href="#user-management-social-graph" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="user-management/user-management.html">User management & social graph</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-management.html#user-management">User management</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-management.html#group-management">Group management</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-management.html#social-connections">Social connections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-management.html#activity-feeds">Activity feeds</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/working-user-data.html">Working with User Data</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#creating-users">Creating users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#retrieving-user-data">Retrieving user data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#updating-deleting-user-data">Updating & deleting user data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#changing-a-user-password">Changing a user password</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/working-user-data.html#resetting-a-user-password">Resetting a user password</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/group.html">Working with group data</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#creating-groups">Creating groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#retrieving-groups">Retrieving groups</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#parameter-description">Parameter Description</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#retrieving-a-group-s-users">Retrieving a group’s users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#deleting-a-group">Deleting a group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#adding-a-user-to-a-group">Adding a user to a group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/group.html#removing-a-user-from-a-group">Removing a user from a group</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/activity.html">Activity</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#posting-activities">Posting activities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#posting-an-activity-to-a-group">Posting an activity to a group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#creating-an-activity-for-a-user-s-followers-in-a-group">Creating an activity for a user’s followers in a group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#retrieving-activity-feeds">Retrieving activity feeds</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/activity.html#retrieving-a-group-s-activity-feed">Retrieving a group’s activity feed</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/user-connections.html">Social Graph Connections</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-connections.html#following-followers">Following/followers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/user-connections.html#creating-a-following-followers-connection">Creating a following/followers connection</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user-management/messagee-example.html">App Example - Messagee</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#creating-a-user-account-in-usergrid">Creating a user account in Usergrid</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#creating-an-app-and-users">Creating an app and users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#ios-client">iOS client</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#ios-sdk">iOS SDK</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#android-client-and-sdk">Android client and SDK</a></li>
+<li class="toctree-l2"><a class="reference internal" href="user-management/messagee-example.html#javascript-html5-client-and-sdk">Javascript/HTML5 client and SDK</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="geo-location">
+<span id="geolocation"></span><p class="caption"><span class="caption-text">Geo-location</span><a class="headerlink" href="#geo-location" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="geolocation/geolocation.html">Geolocating your Entities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="geolocation/geolocation.html#saving-location-data-in-an-entity">Saving location data in an entity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="geolocation/geolocation.html#querying-location-data">Querying location data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="geolocation/geolocation.html#enrich-your-app-with-location-data">Enrich your app with location data</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="assets-files">
+<span id="asset-and-file-management"></span><p class="caption"><span class="caption-text">Assets & Files</span><a class="headerlink" href="#assets-files" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/uploading-assets.html#id1">Uploading assets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/uploading-assets.html#updating-assets">Updating assets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/retrieving-assets.html#retrieving-asset-data">Retrieving asset data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/retrieving-assets.html#retrieving-an-asset-entity">Retrieving an asset entity</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/folders.html#linking-a-folder-to-an-asset">Linking a folder to an asset</a></li>
+<li class="toctree-l2"><a class="reference internal" href="asset-and-files/folders.html#retrieve-list-of-folder-assets">Retrieve list of folder assets</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="counters-events">
+<span id="counters-and-events"></span><p class="caption"><span class="caption-text">Counters & Events</span><a class="headerlink" href="#counters-events" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#request-syntax">Request syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#example-request">Example request</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#example-response">Example response</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="counters-and-events/retrieving-counters.html">Retrieving counters</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#request-syntax">Request syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#example-request">Example request</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#example-response">Example response</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#retrieving-counters-by-time-interval">Retrieving counters by time interval</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#id1">Request syntax</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#id2">Example request</a></li>
+<li class="toctree-l2"><a class="reference internal" href="counters-and-events/retrieving-counters.html#id3">Example response</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="organizations-applications">
+<p class="caption"><span class="caption-text">Organizations & Applications</span><a class="headerlink" href="#organizations-applications" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#creating-an-organization">Creating an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#getting-an-organization">Getting an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#activating-an-organization">Activating an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#reactivating-an-organization">Reactivating an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#generating-organization-client-credentials">Generating organization client credentials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#retrieving-organization-client-credentials">Retrieving organization client credentials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#getting-an-organization-s-activity-feed">Getting an organization’s activity feed</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#getting-the-applications-in-an-organization">Getting the applications in an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#adding-an-admin-user-to-an-organization">Adding an admin user to an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#getting-the-admin-users-in-an-organization">Getting the admin users in an organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/organization.html#removing-an-admin-user-from-an-organization">Removing an admin user from an organization</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/application.html#creating-an-application">Creating an application</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/application.html#generating-application-credentials">Generating application credentials</a></li>
+<li class="toctree-l2"><a class="reference internal" href="orgs-and-apps/application.html#getting-application-credentials">Getting application credentials</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="api-reference">
+<span id="rest-endpoints"></span><p class="caption"><span class="caption-text">API Reference</span><a class="headerlink" href="#api-reference" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html">Methods</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#action-methods">Action Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#activityfeed-methods">ActivityFeed Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#appdata-methods">AppData Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#credential-methods">Credential Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#devices-methods">Devices Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#entity-methods">Entity Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#event-methods">Event Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#group-methods">Group Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#notification-methods">Notification Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#organization-methods">Organization Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#permission-methods">Permission Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#receipt-methods">Receipt Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#role-methods">Role Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#user-methods">User Methods</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html#models">Models</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#action">Action</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#activityfeed">ActivityFeed</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#actor">Actor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#addpermission">AddPermission</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#addrole">AddRole</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#adminuserupdate">AdminUserUpdate</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#appdata">AppData</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#cancelmsg">CancelMSG</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#collections">Collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createactivity">CreateActivity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createadminuser">CreateAdminUser</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createapp">CreateApp</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createentities">CreateEntities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createentity">CreateEntity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createevent">CreateEvent</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#creategroup">CreateGroup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createnotification">CreateNotification</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createnotifications">CreateNotifications</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createorg">CreateOrg</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#createuser">CreateUser</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#credential">Credential</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#device">Device</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#entity">Entity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#error">Error</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#event">Event</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#group">Group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#imagemodel">ImageModel</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#metadata">Metadata</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#notification">Notification</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#notifier">Notifier</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#object">Object</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#organization">Organization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#permission">Permission</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#receipt">Receipt</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#resetpw">ResetPW</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#resetpwmsg">ResetPWMsg</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#role">Role</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#schedulenotification">ScheduleNotification</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#setexpiration">SetExpiration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#sets">Sets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="rest-endpoints/api-docs.html#user">User</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="client-sdks">
+<span id="sdks"></span><p class="caption"><span class="caption-text">Client SDKs</span><a class="headerlink" href="#client-sdks" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="installing-the-stack">
+<span id="installation"></span><p class="caption"><span class="caption-text">Installing the Stack</span><a class="headerlink" href="#installing-the-stack" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#build-the-usergrid-console">Build the Usergrid Console</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html#example-usergrid-custom-properties-file">Example <strong>usergrid-custom.properties</strong> file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-launcher-quick-start.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-launcher-quick-start.html#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-launcher-quick-start.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug1-launcher-quick-start.html#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html#running">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html#example-usergrid-deployment-properties-file">Example <strong>usergrid-deployment.properties</strong> file</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound" id="more-about-usergrid">
+<span id="about"></span><p class="caption"><span class="caption-text">More about Usergrid</span><a class="headerlink" href="#more-about-usergrid" title="Permalink to this toctree">¶</a></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="reference/presos-and-videos.html">Presentations & Videos</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#building-mobile-apps-with-apache-usergrid">Building Mobile Apps with Apache Usergrid</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#how-to-contribute-to-apache-usergrid">How to Contribute to Apache Usergrid</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#apache-usergrid-internals">Apache Usergrid Internals</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#open-source-mobile-backend-on-cassandra">Open Source Mobile Backend on Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/presos-and-videos.html#usergrid-overview">Usergrid Overview</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="reference/contribute-code.html">How to Contribute Code & Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="reference/contribute-code.html#code-contributions">Code Contributions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/contribute-code.html#website-and-documentation-contributions">Website and Documentation Contributions</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="introduction/usergrid-features.html" class="btn btn-neutral float-right" title="Usergrid Features" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'./',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/installation/ug1-deploy-to-tomcat.html
----------------------------------------------------------------------
diff --git a/content/docs/installation/ug1-deploy-to-tomcat.html b/content/docs/installation/ug1-deploy-to-tomcat.html
new file mode 100644
index 0000000..5a13447
--- /dev/null
+++ b/content/docs/installation/ug1-deploy-to-tomcat.html
@@ -0,0 +1,506 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Usegrid 1: Deploying to Tomcat — Apache Usergrid 1.0 documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+ <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
+ <link rel="next" title="Usegrid 1: Launcher Quick-start" href="ug1-launcher-quick-start.html"/>
+ <link rel="prev" title="COMING SOON..." href="../sdks/tbd.html"/>
+
+
+ <script src="../_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="../index.html" class="icon icon-home"> Apache Usergrid
+
+
+
+ </a>
+
+
+
+
+ <div class="version">
+ 1.0
+ </div>
+
+
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <p class="caption"><span class="caption-text">Introduction</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Storage</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Data Queries</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Entity Connections</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Security & Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
+</ul>
+<p class="caption"><span class="caption-text">User Management & Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Geo-location</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Assets & Files</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Counters & Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Organizations & Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Client SDKs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Installing the Stack</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="">Usegrid 1: Deploying to Tomcat</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#download">Download</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#building">Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#install-and-configure-cassandra">Install and configure Cassandra</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#install-and-configure-tomcat">Install and configure Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#build-the-usergrid-console">Build the Usergrid Console</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#example-usergrid-custom-properties-file">Example <strong>usergrid-custom.properties</strong> file</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
+<li class="toctree-l1"><a class="reference internal" href="ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li>
+</ul>
+<p class="caption"><span class="caption-text">More about Usergrid</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Apache Usergrid</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Docs</a> »</li>
+
+ <li>Usegrid 1: Deploying to Tomcat</li>
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/installation/ug1-deploy-to-tomcat.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="usegrid-1-deploying-to-tomcat">
+<h1>Usegrid 1: Deploying to Tomcat<a class="headerlink" href="#usegrid-1-deploying-to-tomcat" title="Permalink to this headline">¶</a></h1>
+<p>This is a guide that explains how to install and run Usergrid using
+stock Tomcat and Cassandra on a single computer.</p>
+<p>NOTE: running Cassandra on a single computer is something you should do
+ONLY for testing purposes. You don’t want to run one node in production
+even just to start out. To get the benefit of Cassandra’s architecture,
+which is designed to support linear scalability. You should be running a
+Cassandra cluster with at least three nodes.</p>
+<p>For more information:</p>
+<ul class="simple">
+<li><a class="reference external" href="http://planetcassandra.org/blog/post/cassandra-faq-can-i-start-with-a-single-node/">Cassandra FAQ: Can I Start With a Single
+Node?</a></li>
+<li><a class="reference external" href="http://stackoverflow.com/questions/18462530/why-dont-you-start-off-with-a-single-small-cassandra-server-as-you-usually">Why don’t you start off with a “single & small” Cassandra
+server</a></li>
+</ul>
+<div class="section" id="requirements">
+<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">JDK
+1.7</a></li>
+<li><a class="reference external" href="http://maven.apache.org/">Maven</a></li>
+</ul>
+</div>
+<div class="section" id="download">
+<h2>Download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2>
+<p>Use GitHub to clone the
+<a class="reference external" href="https://github.com/apache/incubator-usergrid">apache/incubator-usergrid</a>
+repo.</p>
+<p>Or you can start by <a class="reference external" href="https://github.com/apache/incubator-usergrid/archive/master.zip">downloading our latest
+code</a>
+and extract it.</p>
+</div>
+<div class="section" id="building">
+<h2>Building<a class="headerlink" href="#building" title="Permalink to this headline">¶</a></h2>
+<p>From the command line, navigate to <code class="docutils literal"><span class="pre">stack</span></code> directory and type the
+following:</p>
+<div class="highlight-python"><div class="highlight"><pre>mvn clean package -DskipTests=true
+</pre></div>
+</div>
+<p>Once you are done the Usergrid application will be package as a Java EE
+WAR file at the location <strong>stack/rest/target/ROOT.war</strong>.</p>
+</div>
+<div class="section" id="install-and-configure-cassandra">
+<h2>Install and configure Cassandra<a class="headerlink" href="#install-and-configure-cassandra" title="Permalink to this headline">¶</a></h2>
+<p>Install Cassandra, don’t edit configuration files as we just want
+default values for this simple setup. Here are the <a class="reference external" href="http://wiki.apache.org/cassandra/GettingStarted">instructions for
+installing
+Cassandra</a></p>
+</div>
+<div class="section" id="install-and-configure-tomcat">
+<h2>Install and configure Tomcat<a class="headerlink" href="#install-and-configure-tomcat" title="Permalink to this headline">¶</a></h2>
+<p>Follow instructions, don’t edit configuration files as we just want
+default values for this simple setup. Here are the <a class="reference external" href="http://tomcat.apache.org/tomcat-7.0-doc/setup.html">instructions for
+installing Tomcat
+7</a></p>
+</div>
+<div class="section" id="add-usergrid-war-to-tomcat">
+<h2>Add Usergrid WAR to Tomcat<a class="headerlink" href="#add-usergrid-war-to-tomcat" title="Permalink to this headline">¶</a></h2>
+<p>Remove the existing <code class="docutils literal"><span class="pre">tomcat/webapps/ROOT</span></code> directory.</p>
+<p>Place the Usergrid <code class="docutils literal"><span class="pre">ROOT.war</span></code> file into the <code class="docutils literal"><span class="pre">tomcat/webapps</span></code>
+directory</p>
+</div>
+<div class="section" id="add-usergrid-configuration-file-to-tomcat">
+<h2>Add Usergrid configuration file to Tomcat<a class="headerlink" href="#add-usergrid-configuration-file-to-tomcat" title="Permalink to this headline">¶</a></h2>
+<p>Create a ____usergrid-custom.properties____ file and place it in
+Tomcat’s <strong>lib</strong> directory. You can find an example properties file
+below that should work well for a local Tomcat & Cassandra setup. You
+will probably only need to change the properties below to use your email
+address and preferred password for the install.</p>
+<div class="highlight-python"><div class="highlight"><pre>usergrid.sysadmin.login.allowed=true
+usergrid.sysadmin.login.name=superuser
+usergrid.sysadmin.login.password=pw123
+usergrid.sysadmin.email=me@example.com
+usergrid.sysadmin.login.email=myself@example.com
+usergrid.management.mailer=Myself<myself@example.com>
+usergrid.test-account.admin-user.email=myself@example.com
+usergrid.test-account.admin-user.password=test
+</pre></div>
+</div>
+</div>
+<div class="section" id="run-usergrid-database-super-user-setup">
+<h2>Run Usergrid Database & Super User Setup<a class="headerlink" href="#run-usergrid-database-super-user-setup" title="Permalink to this headline">¶</a></h2>
+<p>Start Tomcat and use your web browser to visit the URLs below. While you
+do this you might want to watch the logs under tomcat/logs for clues,
+just in case anything goes wrong.</p>
+<p>Database setup URL - <a class="reference external" href="http://localhost:8080/system/database/setup">http://localhost:8080/system/database/setup</a></p>
+<p>When prompted to login use the sysadmin credentials that you specified
+in your <strong>usergrid-custom.properties</strong> file. Based on the example above
+that would be superuser and pw123. If the operation is successful you
+should a message like the one below in your browser. If not, check your
+logs for clues about what went wrong.</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"cassandra setup"</span><span class="p">,</span>
+ <span class="s">"status"</span> <span class="p">:</span> <span class="s">"ok"</span><span class="p">,</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1379424622947</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">76</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>Superuser setup URL - <a class="reference external" href="http://localhost:8080/system/superuser/setup">http://localhost:8080/system/superuser/setup</a></p>
+<p>You should not be prompted for login because you already logged into for
+the Database Setup. If setup works, you should see a message like this:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"action"</span> <span class="p">:</span> <span class="s">"superuser setup"</span><span class="p">,</span>
+ <span class="s">"status"</span> <span class="p">:</span> <span class="s">"ok"</span><span class="p">,</span>
+ <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1379424667936</span><span class="p">,</span>
+ <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">2</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="build-the-usergrid-console">
+<h2>Build the Usergrid Console<a class="headerlink" href="#build-the-usergrid-console" title="Permalink to this headline">¶</a></h2>
+<p>The Usergrid Console is an admin interface written in JavaScript that
+connects to your running Usergrid instance. For evaluation purposes, you
+can run it within Tomcat. Build it by following the steps
+<a class="reference external" href="https://github.com/apache/incubator-usergrid/blob/master/portal/README.md">here</a>.
+Once built, copy the directory <em>portal/build/usergrid-portal</em> to
+<em>tomcat/webapps</em>.</p>
+</div>
+<div class="section" id="login-to-the-usergrid-console-get-started">
+<h2>Login to the Usergrid Console & get started<a class="headerlink" href="#login-to-the-usergrid-console-get-started" title="Permalink to this headline">¶</a></h2>
+<p>You should now be able to login to the Usergrid console and start
+configuring applications, users and more.</p>
+<p>You can use an static version of the portal to get started:</p>
+<p><a class="reference external" href="http://localhost:8080/usergrid-portal/(http://localhost:8080/usergrid-portal">http://localhost:8080/usergrid-portal/(http://localhost:8080/usergrid-portal</a>)</p>
+</div>
+<div class="section" id="example-usergrid-custom-properties-file">
+<h2>Example <strong>usergrid-custom.properties</strong> file<a class="headerlink" href="#example-usergrid-custom-properties-file" title="Permalink to this headline">¶</a></h2>
+<p>Here’s a complete example properties file to get you started.</p>
+<div class="highlight-python"><div class="highlight"><pre># Minimal Usergrid configuration properties for local Tomcat and Cassandra
+#
+# The cassandra configuration options.
+
+# The cassandra host to use
+cassandra.url=localhost:9160
+
+# if your cassandra instance requires username/password
+cassandra.username=someuser
+cassandra.password=somepassword
+
+# The strategy to use when creating the keyspace. This is the default.
+# We recommend creating the keyspace with this default, then editing it
+# via the cassandra CLI to meet the client's needs.
+cassandra.keyspace.strategy=org.apache.cassandra.locator.SimpleStrategy
+
+# The default replication factor for the simple strategy. Again, leave the
+# default, create the app, then use the cassandra cli to set the replication
+# factor options. This can become complicated with different topologies and
+# is more a Cassandra administration issue than a UG issue.
+cassandra.keyspace.strategy.options.replication_factor=1
+
+######################################################
+# Custom mail transport. Not usually used for local testing
+
+#mail.transport.protocol=smtps
+#mail.smtps.host=email-smtp.us-east-1.amazonaws.com
+#mail.smtps.port=465
+#mail.smtps.auth=true
+#mail.smtps.quitwait=false
+#mail.smtps.username=
+#mail.smtps.password=
+
+######################################################
+# Admin and test user setup (change these to be their super user
+
+usergrid.sysadmin.login.name=superuser
+usergrid.sysadmin.login.email=myself@example.com <--- Change this
+usergrid.sysadmin.login.password=pw123 <--- Change this
+usergrid.sysadmin.login.allowed=true
+usergrid.sysadmin.email=myself@example.com <--- Change this
+
+# Enable or disable this to require superadmin approval of users
+usergrid.sysadmin.approve.users=false
+
+######################################################
+# Auto-confirm and sign-up notifications settings
+
+usergrid.management.admin_users_require_confirmation=false
+usergrid.management.admin_users_require_activation=false
+usergrid.management.organizations_require_activation=false
+usergrid.management.notify_sysadmin_of_new_organizations=false
+usergrid.management.notify_sysadmin_of_new_admin_users=false
+
+######################################################
+# URLs
+# Redirect path when request come in for TLD
+
+usergrid.redirect_root=https://localhost:8080/status
+usergrid.view.management.organizations.organization.activate=https://localhost:8080/accounts/welcome
+usergrid.view.management.organizations.organization.confirm=https://localhost:8080/accounts/welcome
+usergrid.view.management.users.user.activate=https://localhost:8080/accounts/welcome
+usergrid.view.management.users.user.confirm=https://localhost:8080/accounts/welcome
+usergrid.organization.activation.url=https://localhost:8080/management/organizations/%s/activate
+usergrid.admin.activation.url=https://localhost:8080/management/users/%s/activate
+usergrid.admin.resetpw.url=https://localhost:8080/management/users/%s/resetpw
+usergrid.admin.confirmation.url=https://localhost:8080/management/users/%s/confirm
+usergrid.user.activation.url=https://localhost:8080%s/%s/users/%s/activate
+usergrid.user.confirmation.url=https://localhost:8080/%s/%s/users/%s/confirm
+usergrid.user.resetpw.url=https://localhost:8080/%s/%s/users/%s/resetpw
+</pre></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="ug1-launcher-quick-start.html" class="btn btn-neutral float-right" title="Usegrid 1: Launcher Quick-start" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../sdks/tbd.html" class="btn btn-neutral" title="COMING SOON..." accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ © Copyright 2013-2015, Apache Usergrid.
+
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'1.0',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file