usergrid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From snoopd...@apache.org
Subject [16/51] [abbrv] [partial] incubator-usergrid git commit: Switch over to new docs for the website.
Date Wed, 05 Aug 2015 14:58:35 GMT
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/getting-started/using-a-sandbox-app.html
----------------------------------------------------------------------
diff --git a/content/docs/getting-started/using-a-sandbox-app.html b/content/docs/getting-started/using-a-sandbox-app.html
new file mode 100644
index 0000000..a2494dc
--- /dev/null
+++ b/content/docs/getting-started/using-a-sandbox-app.html
@@ -0,0 +1,357 @@
+
+
+<!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>Using a Sandbox Application &mdash; 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="Using the API" href="using-the-api.html"/>
+        <link rel="prev" title="Creating an Usergrid Account" href="creating-account.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 class="current">
+<li class="toctree-l1"><a class="reference internal" href="creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Using a Sandbox Application</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#what-is-the-sandbox-application">What is the sandbox application?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#is-the-sandbox-secure">Is the sandbox secure?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#creating-a-new-sandbox-application">Creating a New Sandbox Application</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="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 &amp; clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators &amp; 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 &amp; Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security &amp; 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 &amp; 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 &amp; Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management &amp; 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 &amp; 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 &amp; Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters &amp; events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating &amp; 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 &amp; Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization &amp; 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 &amp; Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code &amp; Docs</a></li>
+</ul>
+
+          
+        
+      </div>
+      &nbsp;
+    </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> &raquo;</li>
+      
+    <li>Using a Sandbox Application</li>
+      <li class="wy-breadcrumbs-aside">
+        
+          
+            <a href="../_sources/getting-started/using-a-sandbox-app.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="using-a-sandbox-application">
+<h1>Using a Sandbox Application<a class="headerlink" href="#using-a-sandbox-application" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="what-is-the-sandbox-application">
+<h2>What is the sandbox application?<a class="headerlink" href="#what-is-the-sandbox-application" title="Permalink to this headline">¶</a></h2>
+<p>When you create a new Usergrid account (see Creating an Usergrid
+Account) to use services for developers, Usergrid creates a new
+application for you on its servers. With the new application, called
+&#8220;sandbox,&#8221; you can add your own example data and try out API calls that
+do things with the data. Be sure to see Using the API for suggestions.</p>
+</div>
+<div class="section" id="is-the-sandbox-secure">
+<h2>Is the sandbox secure?<a class="headerlink" href="#is-the-sandbox-secure" title="Permalink to this headline">¶</a></h2>
+<p>To keep things simple and make it easier for you to try things out, the
+sandbox application has all authentication disabled. That way, it
+doesn’t require an access token for application-level calls to the API.
+Permissions are so open on the sandbox application because its &#8220;guest&#8221;
+role offers full permissions for all access paths &#8211; that is, GET, POST,
+PUT, and DELETE for /**. Learn more about roles and permissions in
+Managing access by defining permission rules.</p>
+<!-- workaround a Sphinx bug -->
+<div class="admonition warning"><p class="first admonition-title"><p>Warning</p>
+</p><p class="last">
+<p class="last"><p>Never use a sandbox app for production. Keep in mind that the lack of
+authentication means that a sandbox application is not secure enough for
+important or sensitive data. A sandbox is just for experimentation while
+you learn how the services work, and should never be used for a
+production application. As with other Usergrid applications you create,
+a sandbox application is an area of the data store where you can put
+your own data. You can create as many other applications as you like,
+including more sandbox applications. When it comes to production
+(secured) applications, a good rule of thumb is to create one
+application for each mobile app you develop.</p>
+</p>
+</div></div>
+<div class="section" id="creating-a-new-sandbox-application">
+<h2>Creating a New Sandbox Application<a class="headerlink" href="#creating-a-new-sandbox-application" title="Permalink to this headline">¶</a></h2>
+<p>You may want to create (or re-create) a sandbox application. For
+example, you may want to create a sandbox application for another
+organization or you may want to create another application for testing
+purposes.</p>
+<!-- workaround a Sphinx bug -->
+<div class="admonition warning"><p class="first admonition-title"><p>Warning</p>
+</p><p class="last"><p>Guest Role should never be given full permissions. Giving the guest role
+full permissions should be used only for testing and should not be used
+in production. Before you make your app “live”, you should remove the
+guest permissions for /**.</p>
+</p></div><p>Use the following steps to create a sandbox app:</p>
+<ol class="arabic simple">
+<li>Create a new application using the admin portal. You can name the
+application whatever you like (including &#8220;sandbox&#8221;).</li>
+<li>Set full access permissions for the guest role, as follows:<ol class="arabic">
+<li>In the admin portal, click Users, then click Roles.</li>
+<li>On the Roles page, in the list of roles, click Guest.</li>
+<li>For the Guest role, under Permissions, click Add Permission.</li>
+<li>In the New Permission dialog, enter the following in the Path box:
+<code class="docutils literal"><span class="pre">/**</span></code></li>
+<li>Select the following check boxes: get, post, put, and delete.</li>
+<li>Click the Add button.</li>
+<li>If there are other permissions listed, delete them.</li>
+</ol>
+</li>
+</ol>
+</div>
+</div>
+
+
+           </div>
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="using-the-api.html" class="btn btn-neutral float-right" title="Using the API" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="creating-account.html" class="btn btn-neutral" title="Creating an Usergrid Account" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; 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/2a55601f/content/docs/getting-started/using-the-api.html
----------------------------------------------------------------------
diff --git a/content/docs/getting-started/using-the-api.html b/content/docs/getting-started/using-the-api.html
new file mode 100644
index 0000000..d80add6
--- /dev/null
+++ b/content/docs/getting-started/using-the-api.html
@@ -0,0 +1,491 @@
+
+
+<!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>Using the API &mdash; 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="The Usergrid Data Store" href="../data-storage/data-store-dbms.html"/>
+        <link rel="prev" title="Using a Sandbox Application" href="using-a-sandbox-app.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 class="current">
+<li class="toctree-l1"><a class="reference internal" href="creating-a-new-application.html">Creating a new application</a></li>
+<li class="toctree-l1"><a class="reference internal" href="creating-account.html">Creating an Usergrid Account</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using-a-sandbox-app.html">Using a Sandbox Application</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Using the API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#supported-http-methods">Supported HTTP methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#base-url">Base URL</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#request-construction">Request construction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#accessing-collections">Accessing collections</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#accessing-entities">Accessing entities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#issuing-queries">Issuing queries</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#authentication-oauth">Authentication (OAuth)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#response-format">Response format</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#sdks">SDKs</a></li>
+</ul>
+</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 &amp; clauses</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators &amp; 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 &amp; Authentication</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security &amp; 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 &amp; 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 &amp; Social Graph</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management &amp; 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 &amp; 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 &amp; Events</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters &amp; events</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating &amp; 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 &amp; Applications</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization &amp; 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 &amp; Videos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code &amp; Docs</a></li>
+</ul>
+
+          
+        
+      </div>
+      &nbsp;
+    </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> &raquo;</li>
+      
+    <li>Using the API</li>
+      <li class="wy-breadcrumbs-aside">
+        
+          
+            <a href="../_sources/getting-started/using-the-api.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="using-the-api">
+<h1>Using the API<a class="headerlink" href="#using-the-api" title="Permalink to this headline">¶</a></h1>
+<p>Usergrid uses a pure REST (Representational State Transfer) API built as
+a collection of resources. Resource locations are described by paths
+that are related intrinsically to collections and entities in
+collections.</p>
+<p>This section gives several examples of how to construct API requests. To
+focus on what&#8217;s important, the examples use an abbreviated path that
+starts after the application UUID, or application name. For example,
+instead of giving a fully qualified path name as in:</p>
+<div class="highlight-python"><div class="highlight"><pre>https://api.usergrid.com/your-org/your-app/users
+</pre></div>
+</div>
+<p>the example simply lists this:</p>
+<div class="highlight-python"><div class="highlight"><pre>/users
+</pre></div>
+</div>
+<div class="section" id="supported-http-methods">
+<h2>Supported HTTP methods<a class="headerlink" href="#supported-http-methods" title="Permalink to this headline">¶</a></h2>
+<p>When building a REST API, the challenge is to represent the data and the
+action upon the data as a path to a resource that can be created,
+retrieved, updated, or deleted. The HTTP methods POST, GET, PUT, and
+DELETE correspond to the actions that are applied to resources.</p>
+</div>
+<div class="section" id="base-url">
+<h2>Base URL<a class="headerlink" href="#base-url" title="Permalink to this headline">¶</a></h2>
+<p>The base url for all requests made to Usergrid depends on where you have
+Usergrid installed. If you are using Apigee&#8217;s trial Usergrid service,
+the base URL is <code class="docutils literal"><span class="pre">https://api.usergrid.com.</span></code></p>
+</div>
+<div class="section" id="request-construction">
+<h2>Request construction<a class="headerlink" href="#request-construction" title="Permalink to this headline">¶</a></h2>
+<p>Usergrid interprets the URL resource path as a list of names, UUIDs, or
+queries. The basic path format is:</p>
+<div class="highlight-python"><div class="highlight"><pre>https://api.usergrid.com/&lt;org-uuid|org-name&gt;/&lt;app-uuid|app-name&gt;/&lt;collection-name&gt;/&lt;entity-uuid|entity-name&gt;
+</pre></div>
+</div>
+<p>Note: You cannot mix UUIDs and names in the URL resource path. For
+example, the following is incorrect:</p>
+<div class="highlight-python"><div class="highlight"><pre>https://api.usergrid.com/your-org/62de5d97-d28c-11e1-8d5c-12313b01d5c1/users/john.doe
+</pre></div>
+</div>
+</div>
+<div class="section" id="accessing-collections">
+<h2>Accessing collections<a class="headerlink" href="#accessing-collections" title="Permalink to this headline">¶</a></h2>
+<p>To access all entities in a collection, specify the path as follows:</p>
+<div class="highlight-python"><div class="highlight"><pre>/users
+</pre></div>
+</div>
+<p>Such a request retrieves the first 10 entities in the collection /users
+sorted by their entity UUID.</p>
+</div>
+<div class="section" id="accessing-entities">
+<h2>Accessing entities<a class="headerlink" href="#accessing-entities" title="Permalink to this headline">¶</a></h2>
+<p>To access an entity in a collection, specify the path as follows:</p>
+<div class="highlight-python"><div class="highlight"><pre>/&lt;collection&gt;/&lt;uuid|name&gt;
+</pre></div>
+</div>
+<p>where <code class="docutils literal"><span class="pre">&lt;collection&gt;</span></code> is the collection name, and is the entity’s uuid
+or name.</p>
+<p>To access a user in the users collection, specify the path as follows:</p>
+<div class="highlight-python"><div class="highlight"><pre>/users/&lt;uuid|username|email_address&gt;
+</pre></div>
+</div>
+<p>where <code class="docutils literal"><span class="pre">&lt;uuid|username|email_address&gt;</span></code> is the user’s uuid, username, or
+email address.</p>
+<p>For example, the following request retrieves the entity named dino from
+the dogs collection:</p>
+<div class="highlight-python"><div class="highlight"><pre>/dogs/dino
+</pre></div>
+</div>
+</div>
+<div class="section" id="issuing-queries">
+<h2>Issuing queries<a class="headerlink" href="#issuing-queries" title="Permalink to this headline">¶</a></h2>
+<p>You can issue a query in an API request that retrieves items from a
+collection. Here is the typical format for queries:</p>
+<div class="highlight-python"><div class="highlight"><pre>/&lt;collection&gt;?ql=&lt;query&gt;
+</pre></div>
+</div>
+<p>where is a query in the query language.</p>
+<p>For example, this request retrieves users whose Facebook first name is
+john:</p>
+<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where facebook.first_name =&#39;john&#39;
+</pre></div>
+</div>
+<p>For further information about queries, see Queries and parameters.</p>
+</div>
+<div class="section" id="authentication-oauth">
+<h2>Authentication (OAuth)<a class="headerlink" href="#authentication-oauth" title="Permalink to this headline">¶</a></h2>
+<p>Usergrid implements the OAuth 2.0 standard for authenticating users,
+clients and API requests.</p>
+<p>Generally, you will generate a token for every user of your app by
+providing the user&#8217;s username and password. The token can then be sent
+with all API requests to ensure each user is only able to access and
+modify the resources you have granted them rights to.</p>
+<p>Note that by default access tokens are not needed to make requests to
+the default sandbox application in an organization.</p>
+<p>For more information on generating and using access tokens, see
+Authenticating users and application clients and Authenticating API
+requests.</p>
+</div>
+<div class="section" id="response-format">
+<h2>Response format<a class="headerlink" href="#response-format" title="Permalink to this headline">¶</a></h2>
+<p>All API methods return a response object that typically contains an
+array of entities:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+  <span class="s">&quot;entities&quot;</span> <span class="p">:</span> <span class="p">[</span>
+    <span class="o">...</span>
+  <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>Not everything can be included inside the entity, and some of the data
+that gets associated with specific entities isn&#8217;t part of their
+persistent representation. This is metadata, and it can be part of the
+response as well as associated with a specific entity. Metadata is just
+an arbitrary key/value JSON structure.</p>
+<p>For example:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+  <span class="s">&quot;entities&quot;</span> <span class="p">:</span> <span class="p">{</span>
+    <span class="p">{</span>
+      <span class="s">&quot;name&quot;</span> <span class="p">:</span> <span class="s">&quot;ed&quot;</span><span class="p">,</span>
+      <span class="s">&quot;metadata&quot;</span> <span class="p">:</span> <span class="p">{</span>
+        <span class="s">&quot;collections&quot;</span> <span class="p">:</span> <span class="p">[</span><span class="s">&quot;activities&quot;</span><span class="p">,</span> <span class="s">&quot;groups&quot;</span><span class="p">,</span> <span class="s">&quot;followers&quot;</span><span class="p">]</span>
+      <span class="p">}</span>
+    <span class="p">}</span>
+  <span class="p">},</span>
+  <span class="s">&quot;metadata&quot;</span> <span class="p">:</span> <span class="p">{</span>
+    <span class="s">&quot;foo&quot;</span> <span class="p">:</span> <span class="p">[</span><span class="s">&quot;bar&quot;</span><span class="p">,</span> <span class="s">&quot;baz&quot;</span><span class="p">]</span>
+  <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>For example, here is the response to a basic GET for a user entity:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+  <span class="s">&quot;action&quot;</span> <span class="p">:</span> <span class="s">&quot;get&quot;</span><span class="p">,</span>
+  <span class="s">&quot;application&quot;</span> <span class="p">:</span> <span class="s">&quot;f34f4222-a166-11e2-a7f7-02e81adcf3d0&quot;</span><span class="p">,</span>
+  <span class="s">&quot;params&quot;</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
+  <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/users&quot;</span><span class="p">,</span>
+  <span class="s">&quot;uri&quot;</span> <span class="p">:</span> <span class="s">&quot;https://api.usergrid.com/your-org/your-app/users&quot;</span><span class="p">,</span>
+  <span class="s">&quot;entities&quot;</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
+    <span class="s">&quot;uuid&quot;</span> <span class="p">:</span> <span class="s">&quot;503f17da-ec39-11e3-a0dd-a554b7fbd57a&quot;</span><span class="p">,</span>
+    <span class="s">&quot;type&quot;</span> <span class="p">:</span> <span class="s">&quot;user&quot;</span><span class="p">,</span>
+    <span class="s">&quot;created&quot;</span> <span class="p">:</span> <span class="mi">1401921665485</span><span class="p">,</span>
+    <span class="s">&quot;modified&quot;</span> <span class="p">:</span> <span class="mi">1401921665485</span><span class="p">,</span>
+    <span class="s">&quot;username&quot;</span> <span class="p">:</span> <span class="s">&quot;someUser&quot;</span><span class="p">,</span>
+    <span class="s">&quot;email&quot;</span> <span class="p">:</span> <span class="s">&quot;someUser@yourdomain.com&quot;</span><span class="p">,</span>
+    <span class="s">&quot;activated&quot;</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+    <span class="s">&quot;picture&quot;</span> <span class="p">:</span> <span class="s">&quot;http://www.gravatar.com/avatar/dc5d478e9c029853fbd025bed0dc51f8&quot;</span><span class="p">,</span>
+    <span class="s">&quot;metadata&quot;</span> <span class="p">:</span> <span class="p">{</span>
+      <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a&quot;</span><span class="p">,</span>
+      <span class="s">&quot;sets&quot;</span> <span class="p">:</span> <span class="p">{</span>
+        <span class="s">&quot;rolenames&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/roles&quot;</span><span class="p">,</span>
+        <span class="s">&quot;permissions&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/permissions&quot;</span>
+      <span class="p">},</span>
+      <span class="s">&quot;collections&quot;</span> <span class="p">:</span> <span class="p">{</span>
+        <span class="s">&quot;activities&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/activities&quot;</span><span class="p">,</span>
+        <span class="s">&quot;devices&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/devices&quot;</span><span class="p">,</span>
+        <span class="s">&quot;feed&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/feed&quot;</span><span class="p">,</span>
+        <span class="s">&quot;groups&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/groups&quot;</span><span class="p">,</span>
+        <span class="s">&quot;roles&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/roles&quot;</span><span class="p">,</span>
+        <span class="s">&quot;following&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/following&quot;</span><span class="p">,</span>
+        <span class="s">&quot;followers&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/followers&quot;</span>
+      <span class="p">}</span>
+    <span class="p">}</span>
+  <span class="p">}</span> <span class="p">],</span>
+  <span class="s">&quot;timestamp&quot;</span> <span class="p">:</span> <span class="mi">1401921673597</span><span class="p">,</span>
+  <span class="s">&quot;duration&quot;</span> <span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+  <span class="s">&quot;organization&quot;</span> <span class="p">:</span> <span class="s">&quot;your-org&quot;</span><span class="p">,</span>
+  <span class="s">&quot;applicationName&quot;</span> <span class="p">:</span> <span class="s">&quot;your-app&quot;</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+<div class="section" id="sdks">
+<h2>SDKs<a class="headerlink" href="#sdks" title="Permalink to this headline">¶</a></h2>
+<p>To make the integration of Usergrid features into your application code
+quicker and easier, Usegrid offers SDKs in a variety of languages. The
+SDKs contain language-specific methods that allow you to issue API
+requests from your application code in your preferred language. SDKs are
+available for the following languages:</p>
+<ul class="simple">
+<li>iOS</li>
+<li>Android</li>
+<li>JavaScript/HTML5</li>
+<li>Node.js</li>
+<li>Ruby</li>
+<li>.NET</li>
+</ul>
+<p>For more information, see SDKs.</p>
+</div>
+</div>
+
+
+           </div>
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="../data-storage/data-store-dbms.html" class="btn btn-neutral float-right" title="The Usergrid Data Store" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="using-a-sandbox-app.html" class="btn btn-neutral" title="Using a Sandbox Application" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; 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/2a55601f/content/docs/getting-up-and-running-locally/index.html
----------------------------------------------------------------------
diff --git a/content/docs/getting-up-and-running-locally/index.html b/content/docs/getting-up-and-running-locally/index.html
deleted file mode 100644
index 032ebb8..0000000
--- a/content/docs/getting-up-and-running-locally/index.html
+++ /dev/null
@@ -1,309 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-    <meta charset="utf-8">
-    <title>Apache Usergrid (incubating) — Getting Up & Running Locally</title>
-    <meta http-equiv="x-ua-compatible" content="ie=edge" />
-    <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" />
-    <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service">
-    <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
-    <meta property="og:title" content="Apache Usergrid" />
-    <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." />
-    <!-- Loading Typekit -->
-    <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script>
-    <script type="text/javascript">try{Typekit.load();}catch(e){}</script>
-    <!-- Loading Bootstrap -->
-    <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'>
-    <link href="/css/bootflat.css" rel="stylesheet" type='text/css'>
-    <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'>
-    <link href="https://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic" rel="stylesheet" type="text/css">
-    <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'>
-
-    
-
-    <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
-    <!--[if lt IE 9]>
-      <script src="js/html5shiv.js"></script>
-      <script src="js/respond.min.js"></script>
-    <![endif]-->
-</head>
-<body>
-
-    <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner">
-    <div class="container">
-        <div class="navbar-header">
-            <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse">
-                <span class="sr-only">Toggle navigation</span>
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-            </button>
-        </div>
-        <a href="/" class="navbar-brand">
-                <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" />
-            </a>
-        <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
-            <ul class="nav navbar-nav navbar-right">
-                <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li>
-                <li><a href="http://usergrid.readthedocs.org/" target="_blank"><span class="icns icon-book"></span></a></li>
-                <li><a href="http://github.com/apache/incubator-usergrid" target="_blank"><span class="icns icon-github-sign"></span></a></li>
-                <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span class="icns icon-trello"></span></a></li>-->
-                <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible" target="_blank"><span class="icns icon-bug"></span></a></li>
-                <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank"><span class="icns icon-stackexchange"></span></a></li>
-                <li><a href="/community/#live"><span class="icns icon-comments"></span></a></li>
-                <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid" target="_blank"><span class="icns icon-envelope"></span></a></li>-->
-                <li><a href="https://twitter.com/usergrid" target="_blank"><span class="icns icon-twitter"></span></a></li>
-                <li><a href="https://cwiki.apache.org/confluence/display/usergrid/" target="_blank"><span class="icns icon-wiki"></span></a></li>
-                <li><a href="/releases/"><span class="icns icon-releases"></span></a></li>
-            </ul>
-        </nav>
-    </div>
-    </header>
-
-
-
-<div class="container bf-docs-container">    
-    <div class="row">
-        <div class="col-md-3">
-            <div class="bf-sidebar hidden-print" role="complementary">
-                <ul class="nav nav-list">
-                    <li><a href="/docs/getting-up-and-running-locally/">Getting Up &amp; Running Locally</a></li>
-                    <li><a href="/docs/deploy-local/">Deploying to local Tomcat &amp; Cassandra</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/ugc#usergrid-command-line-ugc"><code>ugc</code> — the Command-line Client</a></li>
-
-                    <li class="nav-header"><span>Concepts</span></li>
-                    <li>
-                        <a href="/docs/organizations-admins/">Organizations & Admins</a>
-                        <ul>
-                            <li>
-                                <a href="/docs/applications/">Applications</a>
-                                <ul>
-                                    <li><a href="/docs/roles-and-permissions/">Roles & Permissions</a></li>
-                                    <!--<li><a href="#">Queues</a></li>-->
-                                    <li><a href="/docs/events-and-counters/">Events & Counters</a></li>
-                                    <li><a href="/docs/relationships/">Relationships (Joins)</a></li>
-                                    <li>
-                                        <a href="/docs/collections">Collections</a>
-                                        <ul>
-                                            <li><a href="/docs/query-language/">Query Language</a></li>
-                                            <li><a href="/docs/users-devices/">Users & Devices</a></li>
-                                            <li><a href="/docs/groups/">Groups</a></li>
-                                            <li><a href="/docs/activities/">Activities</a></li>
-                                            <li><a href="/docs/assets/">Assets</a></li>
-                                        </ul>
-                                    </li>
-                                </ul>
-                            </li>
-                        </ul>
-                    </li>
-
-
-                    <li class="nav-header"><span>Usage</span></li>
-                    <!-- <li>REST API — Coming Soon</li> -->
-                    <li><a class="icns-apple" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ios">iOS SDK</a></li>
-                    <li><a class="icns-android" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/android">Android SDK</a></li>
-                    <li><a class="icns-html5" href="">HTML5 / JavaScript SDK</a></li>
-                    <li><a class="icns-windows" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/dotnet">Windows 8 / Windows Phone / .net SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/nodejs">Node.js module</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby">Ruby gem</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby-on-rails">Ruby on Rails gem</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/php">PHP library</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/java">Java library</a></li>
-
-                    <!--<li class="nav-header"><span>Internals</span></li>
-                    <li>Design & Goals — Coming Soon</li>
-                    <li>Java Architecture — Coming Soon</li>
-                    <li>Cassandra Schema — Coming Soon</li>-->
-
-                    <li class="nav-header"><span>Operations</span></li>
-                    <!--<li>Deploying — Coming Soon</li>-->
-                    <!-- <li>Monitoring — Coming Soon</li> -->
-                    <li><a href="/docs/upgrading/">Upgrading</a></li>
-                    <!-- <li>Security — Coming Soon</li> -->
-
-                    <li class="nav-header"><span>Presentations & Videos</span></li>
-                    <li><a href="/docs/presentations/">Presentations</a></li>
-                    <li><a href="/docs/videos/">Videos</a></li>
-
-                    <li class="nav-header"><span>We need your help!</span></li>
-                    <li><a href="/docs/contribute-code/">How to Contribute Code & Docs</a></li>
-                    <!--
-                    <li><a href="/docs/contribute-docs">How to contribute docs</a></li>
-                    -->
-                </ul>
-            </div>
-        </div>
-
-        <div class="col-md-9 main-article" role="main">
-            <div class="page-article">
-                <div class="page-header">
-                    <h1>Getting Up & Running Locally</h1>
-                    <!-- TODO: reenable this when we sync SVN to GitHub
-                  <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/getting-up-and-running-locally.md">contribute to this article on github</a></small>
-                    -->
-                </div>
-                <div class="toc">
-	<ul>
-<li><a href="#requirements">Requirements</a></li>
-<li><a href="#download">Download</a></li>
-<li><a href="#building">Building</a></li>
-<li><a href="#running">Running</a></li>
-<li><a href="#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li>
-</ul>
-</div>
-<h2 id="requirements">Requirements</h2>
-<ul>
-<li><a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">JDK 1.7</a></li>
-<li><a href="http://maven.apache.org/">Maven</a></li>
-</ul>
-<h2 id="download">Download</h2>
-<p>Start by <a href="https://github.com/apache/incubator-usergrid/archive/master.zip">downloading our latest code</a> and extract it.</p>
-<h2 id="building">Building</h2>
-<p>From the command line, navigate to stack directory and type the following:</p>
-<pre><code>mvn clean install -DskipTests=true</code></pre>
-<h2 id="running">Running</h2>
-<p>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.</p>
-<p>You can run Usergrid from the command-line from the jar in the usergrid/standalone project:</p>
-<pre><code>cd launcher; java -jar target/usergrid-launcher-*.jar</code></pre>
-<p>After startup, your instance will be available on localhost, port 8080. To check it’s running properly, you can try loading our status page:</p>
-<pre><code>curl http://localhost:8080/status</code></pre>
-<p>You can also run it as a webapp in Tomcat, by deploying the ROOT.war file generated in the usergrid/rest project.</p>
-<h2 id="getting-started-with-the-http-api">Getting Started with the HTTP API</h2>
-<p>Start by creating an Organization. It’s the top-level structure in Usergrid: all Apps and Administrators must belong to an Organization. Here’s how you create one:</p>
-<pre><code>curl -X POST  \
-     -d 'organization=myfirstorg&amp;username=myadmin&amp;name=Admin&amp;email=admin@example.com&amp;password=password' \
-     http://localhost:8080/management/organizations</code></pre>
-<p>You can see that creating an Organization creates an Administrator in the process. Let’s authenticate as him:</p>
-<pre><code>curl 'http://localhost:8080/management/token?grant_type=password&amp;username=myadmin&amp;password=password'</code></pre>
-<p>This will return an access_token. We’ll use this to authenticate the next two calls. Next, let’s create an Application:</p>
-<pre><code>curl -H "Authorization: Bearer [the management token from above]" \
-     -H "Content-Type: application/json" \
-     -X POST -d '{ "name":"myapp" }' \
-     http://localhost:8080/management/orgs/myfirstorg/apps</code></pre>
-<p>… And a User for the Application:</p>
-<pre><code>curl -H "Authorization: Bearer [the management token from above]" \
-     -X POST "http://localhost:8080/myfirstorg/myapp/users" \
-     -d '{ "username":"myuser", "password":"mypassword", "email":"user@example.com" }'</code></pre>
-<p>Let’s now generate an access token for this Application User:</p>
-<pre><code>curl 'http://localhost:8080/myfirstorg/myapp/token?grant_type=password&amp;username=myuser&amp;password=mypassword'</code></pre>
-<p>This will also send back an access_token, but limited in scope. Let’s use it to create a collection with some data in it:</p>
-<pre><code>curl -H "Authorization: Bearer [the user token]" \
-     -X POST -d '[ { "cat":"fluffy" }, { "fish": { "gold":2, "oscar":1 } } ]' \
-     http://localhost:8080/myfirstorg/myapp/pets</code></pre>
-            </div>
-        </div>
-    </div>
-    <div class="row">
-        <div class="col-md-3"></div>
-        <div class="col-md-9">
-            <div class="github-callout">
-                <strong>Questions?</strong> Please do <a href="/community">ask on the mailing-lists</a>!<br/>
-                <!--
-                <strong>Found an error?</strong> We’d greatly appreciate a pull request about <a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/getting-up-and-running-locally.md">this article on github</a>.</div> 
-                -->
-            </div>
-        </div>
-    </div>
-</div>
-
-
-<footer class="bf-footer" role="contentinfo">
-    <div class="container">
-        <div class="row">
-            <div class="col-md-2">
-                <ul class="nav nav-list">
-                    <li class="nav-header"><a href="/">Home</a></li>
-                    <li class="nav-header"><a href="/community/">Community</a></li>
-                        <li><a href="/community/#events">Events</a></li>
-                        <li><a href="/community/#mailing-lists">Mailing Lists</a></li>
-                        <li><a href="/community/#deployments">Deployments</a></li>
-                        <li><a href="/community/#committers">Commiters</a></li>
-                </ul>
-            </div>
-            <div class="col-md-2">
-                <ul class="nav nav-list">
-                    <li class="nav-header"><a href="https://github.com/apache/incubator-usergrid/" target="_blank">Code</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack" target="_blank">Server Stack</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/portal" target="_blank">Admin Portal</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/ugc" target="_blank">ugc command line</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ios" target="_blank">iOS SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/android" target="_blank">Android SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/html5-javascript" target="_blank">HTML5/JS SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/nodejs" target="_blank">node.js module</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby-on-rails" target="_blank">Ruby on Rails gem</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby" target="_blank">Ruby gem</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/php" target="_blank">PHP SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/java" target="_blank">Java SDK</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/dotnet" target="_blank">.NET / Windows SDK</a></li>
-                </ul>
-            </div>
-            <div class="col-md-2">
-                <ul class="nav nav-list">
-                    <li class="nav-header">Resources</li>
-                    <li><a href="http://github.com/apache/incubator-usergrid" target="_blank">GitHub Code</a></li>
-                    <li><a href="http://usergrid.readthedocs.org/" target="_blank">Docs</a></li>
-                    <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible" target="_blank">JIRA Bug Tracker</a></li>
-                    <li><a href="http://stackoverflow.com/search?q=usergrid" target="_blank">StackOverflow</a></li>
-                    <li><a href="/community/#live">Live Chat</a></li>
-                    <li><a href="https://twitter.com/usergrid" target="_blank">Twitter</a></li>
-                    <li><a href="http://incubator.apache.org/projects/usergrid.html" target="_blank">Podling Listing</a></li>
-                    <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack#requirements" target="_blank">Getting Started</a></li>
-                    <li><a href="https://cwiki.apache.org/confluence/display/usergrid/GitHub+Based+Contribution+Workflow" target="_blank">Contribution Guidelines</a></li>
-                </ul>
-            </div>
-            <div class="col-md-2">
-                <ul class="nav nav-list">
-                    <li class="nav-header">Apache</li>
-                    <li><a href="http://www.apache.org/licenses/" target="_blank">License</a></li>
-                    <li><a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">Sponsorship</a></li>
-                    <li><a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a></li>
-                    <li><a href="http://www.apache.org/security/">Security</a></li>
-                    <li><a href="http://www.apache.org/" target="_blank">Apache Foundation</a></li>
-                </ul>
-            </div>
-            <div class="col-md-4">
-                <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid" data-widget-id="401499136807038976"  data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a>
-                <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
-            </div> 
-        <!--
-            <div class="col-md-4">
-                <div class="input-group form-search">
-                    <input type="text" class="form-control search-query">
-                    <span class="input-group-btn">
-                        <button type="submit" class="btn btn-primary" data-type="last">Search</button>
-                    </span>
-                </div>
-            </div> -->
-        </div> 
-        <div class="row">
-            <div id="copyright">
-                <img src="/img/egg-logo.png" /><br/><br/>
-                <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
-                <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br>
-                Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p>
-                <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee">@ryuneeee</a> + <a href="https://github.com/realbeast">@realbeast</a> + <a href="https://twitter.com/timanglade">@timanglade</a>.</p>
-            </div>
-        </div>
-    </div>
-</footer>
-
-<script type="text/javascript" src="/js/head.js"></script>
-<script type="text/javascript">
-    head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js");
-</script>
-<script>
-  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
-  ga('create', 'UA-45815079-1', 'apache.org');
-  ga('send', 'pageview');
-
-</script>
-
-
-
-</body>
-</html>


Mime
View raw message