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/06/25 22:49:40 UTC
[11/51] [partial] incubator-usergrid git commit: Website directory
MUST be named "content"
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/a46faae1/content/publish/docs/facebook-sign/index.html
----------------------------------------------------------------------
diff --git a/content/publish/docs/facebook-sign/index.html b/content/publish/docs/facebook-sign/index.html
new file mode 100644
index 0000000..e8e4488
--- /dev/null
+++ b/content/publish/docs/facebook-sign/index.html
@@ -0,0 +1,400 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) — Facebook sign in</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 & Running Locally</a></li>
+ <li><a href="/docs/deploy-local/">Deploying to local Tomcat & 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>Facebook sign in</h1>
+ <!-- TODO: reenable this when we sync SVN to GitHub
+ <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/facebook-sign.md">contribute to this article on github</a></small>
+ -->
+ </div>
+ <div class="toc">
+ <ul>
+<li>
+<a href="#facebook-sign-in">Facebook sign in</a><ul>
+<li>
+<a href="#facebook-login-example">Facebook login example</a><ul>
+<li><a href="#step-1-create-a-facebook-app">Step 1: Create a Facebook app</a></li>
+<li><a href="#step-2-invoke-the-facebook-oauth-dialog">Step 2: Invoke the Facebook OAuth dialog</a></li>
+<li><a href="#step-3-add-the-javascript-sdk-for-facebook">Step 3: Add the JavaScript SDK for Facebook</a></li>
+<li><a href="#step-4.-setup-fb.login">Step 4. Setup FB.login</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<h1 id="facebook-sign-in">Facebook sign in</h1>
+<p>You can authenticate your Apache Usergrid requests by logging into Facebook. To access Apache Usergrid resources, you need to provide an access token with each request (unless you use the sandbox app). You can get an access token by connecting to an appropriate web service endpoint and providing the correct client credentials — this is further described in <a href="/authenticating-users-and-application-clients">Authenticating users and application clients</a>. However, you can also obtain an access token by logging into Facebook.</p>
+<p>To enable authentication to Apache Usergrid through Facebook, do the following in your app:</p>
+<ol style="list-style-type: decimal">
+<li>Make a login call to the Facebook API (do this using the <a href="https://developers.facebook.com/docs/sdks/">Facebook SDK</a> or <a href="https://developers.facebook.com/docs/facebook-login/">API</a>). If the login succeeds, a Facebook access token is returned.</li>
+<li>
+<p>Send the Facebook access token to Apache Usergrid. If the Facebook access token is valid and the user does not already exist in App Services, Apache Usergrid provisions a new Apache Usergrid user. It also returns an Apache Usergrid access token, which you can use for subsequent Apache Usergrid API calls. Behind the scenes, Apache Usergrid uses the Facebook access token to retrieve the user’s profile information from Facebook.</p>
+<p>If the Facebook access token is invalid, Facebook returns an OAuth authentication error, and the login does not succeed.</p>
+</li>
+</ol>
+<p>The request to authenticate to Apache Usergrid using a Facebook access token is:</p>
+<pre><code>GET https://api.usergrid.com/{my_org}/{my_app}/auth/facebook?fb_access_token={fb_access_token}</code></pre>
+<p>where:</p>
+<p>{my_org} is the organization UUID or organization name.<br>{my_app} is the application UUID or application name.<br>{fb_access_token} is the Facebook access token.</p>
+<h2 id="facebook-login-example">Facebook login example</h2>
+<p>The <a href="https://developers.facebook.com/docs/technical-guides/login/">Facebook technical guides for login</a> present detailed information on how to add Facebook login to your app. Instructions are provided for JavaScript, iOS, and Android.</p>
+<p>In brief, here are the steps for JavaScript. You can see these steps implemented in the Facebook login example packaged with the JavaScript SDK for Apache Usergrid (which you can download in <a href="https://github.com/apigee/usergrid-javascript-sdk/archive/master.zip">ZIP</a> format or <a href="https://github.com/apigee/usergrid-javascript-sdk/archive/master.tar.gz">tar.gz</a> format). The Facebook login example is in the /examples/facebook directory of the extracted download. The code example snippets shown below are taken from the Facebook login example.</p>
+<h3 id="step-1-create-a-facebook-app">Step 1: Create a Facebook app</h3>
+<p>Create a new app on the <a href="https://developers.facebook.com/apps/">Facebook App Dashboard</a>. Enter your app’s basic information. Once created, note the app ID shown at the top of the dashboard page.</p>
+<h3 id="step-2-invoke-the-facebook-oauth-dialog">Step 2: Invoke the Facebook OAuth dialog</h3>
+<p>Invoke the Facebook OAuth Dialog. To do that, redirect the user’s browser to a URL by inserting the following Javascript code after the opening <body> tag in your app’s HTML file:</p>
+<pre><code>https://www.facebook.com/dialog/oauth/?
+ client_id={YOUR_APP_ID}
+ &redirect_uri={YOUR_REDIRECT_URL}
+ &state={YOUR_STATE_VALUE}
+ &scope={COMMA_SEPARATED_LIST_OF_PERMISSION_NAMES}
+ &response_type={YOUR_RESPONSE_TYPE}</code></pre>
+<p>where:</p>
+<p>{YOUR_APP_ID} is the app ID.<br>{YOUR_REDIRECT_URL} is the application UUID or application name.<br>{YOUR_STATE_VALUE} is a unique string used to maintain application state between the request and callback.<br>{COMMA_SEPARATED_LIST_OF_PERMISSION_NAMES} is a comma separated list of permission names which you would like the user to grant your application.<br>{YOUR_RESPONSE_TYPE}is the requested response type, either code or token. Defaults to code. Set the response type to token. With the response type set to token, the Dialog’s response will include an OAuth user access token in the fragment of the URL the user is redirected to, as per the client-side authentication flow.</p>
+<p>Here is how it’s done in the Facebook login example:</p>
+<pre><code>var apiKey = $("#api-key").val();
+var location = window.location.protocol + '//' + window.location.host;
+var path = window.location.pathname;
+
+var link = "https://www.facebook.com/dialog/oauth?client_id=";
+link += apiKey;
+link += "&redirect_uri=";
+link += location+path
+link += "&scope&COMMA_SEPARATED_LIST_OF_PERMISSION_NAMES&response_type=token";
+
+//now forward the user to facebook
+window.location = link;</code></pre>
+<p>Notice that the response type is set to token. As a result, a Facebook access token will be appended to the URL to which the user is redirected.</p>
+<h3 id="step-3-add-the-javascript-sdk-for-facebook">Step 3: Add the JavaScript SDK for Facebook</h3>
+<p>Add the following Javascript SDK initialization code after the code that invokes the Facebook OAuth Dialog. The code will load and initialize the JavaScript SDK in your HTML page. Replace YOUR_APP_ID with the App ID noted in Step 1, and WWW.YOUR_DOMAIN.COM with your own domain.</p>
+<pre><code>window.fbAsyncInit = function() {
+ FB.init({
+ appId : 'YOUR_APP_ID', // App ID
+ channelUrl : '//WWW.YOUR_DOMAIN.COM/channel.html', // Channel File
+ status : true, // check login status
+ cookie : true, // enable cookies to allow the server to access the session
+ xfbml : true // parse XFBML
+ });</code></pre>
+<p>Here is how the window.fbAsynchInit() function is implemented in the Facebook login example:</p>
+<pre><code>//load up the facebook api sdk
+ window.fbAsyncInit = function() {
+ FB.init({
+ appId : '308790195893570', // App ID
+ channelUrl : '//usergridsdk.dev//examples/channel.html', // Channel File
+ status : true, // check login status
+ cookie : true, // enable cookies to allow the server to access the session
+ xfbml : true // parse XFBML
+ });
+ };</code></pre>
+<h3 id="step-4.-setup-fb.login">Step 4. Setup FB.login</h3>
+<p>Whenever a user is either not logged into Facebook or not authorized for an app, it is useful to prompt them with the relevant dialog. The FB.login() Javascript SDK function automatically displays the correct one to the user.</p>
+<p>To integrate FB.login()Fwindow.fbAsyncInit() function in your existing code:</p>
+<pre><code>function login() {
+ FB.login(function(response) {
+ if (response.authResponse) {
+ // connected
+ } else {
+ // cancelled
+ }
+ });
+}</code></pre>
+<p>Here is how window.fbAsynchInit()FB.login() is implemented in the Facebook login example:</p>
+<pre><code>function login(facebookAccessToken) {
+ client.loginFacebook(facebookAccessToken, function(err, response){
+ var output = JSON.stringify(response, null, 2);
+ if (err) {
+ var html = '<pre>Oops! There was an error logging you in. \r\n\r\n';
+ html += 'Error: \r\n' + output+'</pre>';
+ } else {
+ var html = '<pre>Hurray! You have been logged in. \r\n\r\n';
+ html += 'Facebook Token: ' + '\r\n' + facebookAccessToken + '\r\n\r\n';
+ html += 'Facebook Profile data stored in Usergrid: \r\n' + output+'</pre>';
+ }
+ $('#facebook-status').html(html);
+ })
+ }</code></pre>
+<p>The client.loginFacebook() function is provided by the Apache Usergrid JavaScript SDK. It uses the Facebook auth token to obtain an App Services auth token. If the Facebook access token is valid and the user does not already exist in Apache Usergrid, the function creates a user entity for the user. It also uses the Facebook access token to retrieve the user’s profile information from Facebook.</p>
+<p>Here is what the client.loginFacebook() function looks like:</p>
+<pre><code>Usergrid.Client.prototype.loginFacebook = function (facebookToken, callback) {
+ var self = this;
+ var options = {
+ method:'GET',
+ endpoint:'auth/facebook',
+ qs:{
+ fb_access_token: facebookToken
+ }
+ };
+ this.request(options, function(err, data) {
+ var user = {};
+ if (err && self.logging) {
+ console.log('error trying to log user in');
+ } else {
+ user = new Usergrid.Entity('users', data.user);
+ self.setToken(data.access_token);
+ }
+ if (typeof(callback) === 'function') {
+ callback(err, data, user);
+ }
+ });
+}</code></pre>
+<p>Notice that the function also returns an Apache Usergrid access token, which you can use for subsequent Apache Usergrid API calls.</p>
+<p>Remember to create a client for your app, which is the main entry point to the JavaScript SDK for Apache Usergrid. You need to do this before you can use the SDK. Here’s the code to create a client:</p>
+<pre><code>var client = new Usergrid.Client({
+ orgName:'yourorgname',
+ appName:'yourappname',
+ logging: true, //optional - turn on logging, off by default
+ buildCurl: true //optional - turn on curl commands, off by default
+});</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/facebook-sign.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>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/a46faae1/content/publish/docs/features/index.html
----------------------------------------------------------------------
diff --git a/content/publish/docs/features/index.html b/content/publish/docs/features/index.html
new file mode 100644
index 0000000..b1d657e
--- /dev/null
+++ b/content/publish/docs/features/index.html
@@ -0,0 +1,342 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) — Apache Usergrid Features</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 & Running Locally</a></li>
+ <li><a href="/docs/deploy-local/">Deploying to local Tomcat & 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>Apache Usergrid Features</h1>
+ <!-- TODO: reenable this when we sync SVN to GitHub
+ <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/features.md">contribute to this article on github</a></small>
+ -->
+ </div>
+ <div class="toc">
+ <ul>
+<li>
+<a href="#apache-usergrid-features">Apache Usergrid Features</a><ul>
+<li>
+<a href="#data-storage-management">Data storage & management</a><ul>
+<li><a href="#application-data">Application data</a></li>
+<li><a href="#files-assets">Files & assets</a></li>
+<li><a href="#flexible-data-querying">Flexible data querying</a></li>
+</ul>
+</li>
+<li>
+<a href="#social">Social</a><ul>
+<li><a href="#entity-relationships">Entity relationships</a></li>
+<li><a href="#activity-streams">Activity streams</a></li>
+</ul>
+</li>
+<li>
+<a href="#user-management">User management</a><ul>
+<li><a href="#registration-and-login">Registration and login</a></li>
+<li><a href="#roles-permissions">Roles & permissions</a></li>
+<li><a href="#groups">Groups</a></li>
+<li><a href="#third-party-authentication">Third-party authentication</a></li>
+</ul>
+</li>
+<li><a href="#geolocation">Geolocation</a></li>
+<li><a href="#push-notifications">Push notifications</a></li>
+<li><a href="#configuration-management">Configuration management</a></li>
+<li><a href="#error-performance-monitoring">Error & performance monitoring</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<h1 id="apache-usergrid-features">Apache Usergrid Features</h1>
+<p>Apache Usergrid is a backend-as-a-service (BaaS) solution that enables you to quickly integrate valuable features into your app, including social graphs, user management, data storage, push notifications, performance monitoring, and more.</p>
+<p>Using Apache Usergrid, you can set up your own cloud-based data platform in minutes instead of months – no server-side coding or back-end development needed. This allows your team to focus on developing the rich features and user experience that truly differentiate your app, rather than the time-consuming details of implementing core back-end services and infrastructure.</p>
+<h2 id="data-storage-management">Data storage & management</h2>
+<h3 id="application-data">Application data</h3>
+<p>At the core of Apache Usergrid is a flexible platform that can store any type of application data, from simple records like a catalog of books to complex associations like user relationships. No matter what type of data drives your app, you can store it in Apache Usergrid infrastructure as collections of data entities and immediately perform complex queries or full-text searches on any field. You can also create custom entities with custom properties, giving you the ability to store data and context in a way that makes sense for your app.</p>
+<p>To learn more about entities and collections, see <a href="/app-services-data-model-1">Apache Usergrid Data model</a>.</p>
+<p>For a complete list of default data entities available in Apache Usergrid, see <a href="/default-data-entities">Default Data Entities</a>.</p>
+<h3 id="files-assets">Files & assets</h3>
+<p>Images, video, and audio are key components of a great app experience. With Apache Usergrid, you can upload and retrieve binary objects from the same data store as the rest of your application data, eliminating the need to set up content delivery networks (CDNs) and easing implementation. We handle all the back-end details that keep your content quickly accessible.</p>
+<p>To learn more about files and asset storage, see <a href="/uploading-files-and-assets">Uploading files and assets</a>.</p>
+<h3 id="flexible-data-querying">Flexible data querying</h3>
+<p>One of Apache Usergrid’ most powerful features is the ability to perform SQL-style queries and full-text searches on data entities, as well as their properties. This lets you quickly retrieve specific data entities based on multiple criteria, then utilize that data to power social features, target push notifications, perform user analysis, and more.</p>
+<p>Learn more about querying app data, see <a href="/app-services-data-query-overview">Apache Usergrid data query overview</a>.</p>
+<h2 id="social">Social</h2>
+<h3 id="entity-relationships">Entity relationships</h3>
+<p>With Apache Usergrid you can create relationships between data entities to help build features, improve user experience, and contextualize data. For example, you might associate a user with their devices to capture valuable geolocation data, create relationships between users to build social graphs, or implement popular features such as activity streams.</p>
+<p>To learn more about entity relationships, see <a href="/entity-relationships">Entity relationships</a>.</p>
+<h3 id="activity-streams">Activity streams</h3>
+<p>A key aspect of social networking apps is the ability to provide and publish data streams of user actions, such as ongoing lists of comments, activities, and tweets. Apache Usergrid simplifies management and routing of these data streams by providing an activity entity that is specifically designed to automatically create a relationship between activities and the user who created them.</p>
+<p>To learn more about activities and activity feeds, see <a href="/activity">Activity</a>.</p>
+<h2 id="user-management">User management</h2>
+<h3 id="registration-and-login">Registration and login</h3>
+<p>Apache Usergrid makes it easy to add and manage users by providing the core services necessary to handle secure registration and log in, including OAuth 2.0-compliant client authentication. In addition, any number of default or custom data entities and properties can be associated with a user entity to create complete user profiles.</p>
+<p>To learn more about user management, see <a href="/user">User</a>.</p>
+<p>To learn more about authentication, see <a href="/authenticating-users-and-application-clients">Authenticating users and application clients</a>.</p>
+<h3 id="roles-permissions">Roles & permissions</h3>
+<p>Applications often require the ability to configure fine-grain control of user access to data, features and functionality. Apache Usergrid solves the implementation details of user access with roles and permissions. Simply create roles that represent user types or access levels, such as Administrator, then assign the necessary permissions to that role. With a single API call, you can then associate your roles with any user or group of users.</p>
+<p>To learn more about user roles and permissions, see <a href="/managing-access-defining-permission-rules">Managing access by defining permission rules</a>.</p>
+<h3 id="groups">Groups</h3>
+<p>Groups are a flexible way to organize your users based on any number of criteria. For example, you might group users based on interests or location to more effectively deliver relevant content, target offers, or customize campaigns. You can also take advantage of the groups entity to enable group-based social networking activities, such as allowing your users to create private information feeds or circles of friends.</p>
+<p>To learn more about groups, see <a href="/group">Group</a>.</p>
+<h3 id="third-party-authentication">Third-party authentication</h3>
+<p>In addition to supporting user management and OAuth-based login for your app, Apache Usergrid also makes it easy to integrate third-party authentication through such popular services as Facebook, Twitter and other OAuth-enabled accounts. Providing third-party sign-in can improve user experience, while increasing adoption, giving you access to valuable information from social networks and services.</p>
+<p>To learn more about using third-party sign-in, see <a href="/facebook-sign">Facebook sign in</a>.</p>
+<h2 id="geolocation">Geolocation</h2>
+<p>The Apache Usergrid device entity allows you to capture geolocation data from your users’ GPS-enabled devices to more effectively target campaigns, push notifications, offers and more. Geolocation also gives you an important data point for contextualizing and analyzing trends and user behavior.</p>
+<p>To learn more about geolocation, see <a href="/geolocation">Geolocation</a>.</p>
+<h2 id="push-notifications">Push notifications</h2>
+<p>Push notifications are the most effective way to engage your users with relevant content, and thanks to Apache Usergrid, implementing them can be done in minutes. Simply register your app and your user’s devices with a notification provider, such as Apple Push Notification Service or Google Cloud Messaging, then use the Apache Usergrid notification entity to send millions of push notifications a month at no cost. When used in conjunction with queries of user and application data, push notifications become a powerful tool for leveraging user data, ensuring relevancy and driving engagement.</p>
+<p>To learn more about push notifications, see <a href="/push-notifications-overview">Push notifications overview</a>.</p>
+<h2 id="configuration-management">Configuration management</h2>
+<p>By giving you the ability to push configuration changes directly to users’ devices, Apache Usergrid lets you test and deliver bug fixes and performance improvements in real time. Remote configuration management can even be used to push changes to a subset of all users, enabling A/B testing of fixes, so that you can monitor and collect data to ensure your updates perform as intended before they are pushed to your entire user base.</p>
+<p>To learn more about configuration management, see <a href="/configure-your-app">Configure your app</a>.</p>
+<h2 id="error-performance-monitoring">Error & performance monitoring</h2>
+<p>One of the largest barriers to the success of an app can be the ability of developers to respond quickly and precisely to performance issues and bugs. Apache Usergrid includes data logging and visualization tools that let you monitor and analyze network performance, usage patterns, crash statistics and other key metrics, giving you the data necessary to quickly manage performance issues as they arise.</p>
+<p>To learn more about usage monitoring, see <a href="/monitor-your-app%E2%80%99s-use">Monitor your app’s use</a></p>
+<p>To learn more about error monitoring, see <a href="/get-alerted-crashes-and-critical-errors">Get alerted to crashes and critical errors</a></p>
+ </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/features.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>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/a46faae1/content/publish/docs/folder/index.html
----------------------------------------------------------------------
diff --git a/content/publish/docs/folder/index.html b/content/publish/docs/folder/index.html
new file mode 100644
index 0000000..7c9a90c
--- /dev/null
+++ b/content/publish/docs/folder/index.html
@@ -0,0 +1,341 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) — Folder</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 & Running Locally</a></li>
+ <li><a href="/docs/deploy-local/">Deploying to local Tomcat & 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>Folder</h1>
+ <!-- TODO: reenable this when we sync SVN to GitHub
+ <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/folder.md">contribute to this article on github</a></small>
+ -->
+ </div>
+ <div class="toc">
+ <ul>
+<li>
+<a href="#folder">Folder</a><ul>
+<li><a href="#folder-properties">Folder properties</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<h1 id="folder">Folder</h1>
+<p>Folder entities are used primarily to organize content into a structure. For example, you can create a folders collection for media content, and within it have a ‘music’ folder for music content, and a ‘video’ folder for video content.</p>
+<p>Using Apache Usergrid APIs you can create, retrieve, update, delete, and query folder entities. See You do not have access to view this node for descriptions of these APIs.</p>
+<h2 id="folder-properties">Folder properties</h2>
+<p>The following are the system-defined properties for foldetr entities. You can create application-specific properties for a folder entity in addition to the system-defined properties. The system-defined properties are reserved. You cannot use these names to create other properties for a folder entity. In addition the folders name is reserved for the folders collection — you can’t use it to name another collection.</p>
+<table>
+<thead>
+<tr class="header">
+<th align="left">Property</th>
+<th align="left">Type</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td align="left">uuid</td>
+<td align="left">UUID</td>
+<td align="left">the folder’s unique entity ID</td>
+</tr>
+<tr class="even">
+<td align="left">type</td>
+<td align="left">string</td>
+<td align="left">“folder”</td>
+</tr>
+<tr class="odd">
+<td align="left">name</td>
+<td align="left">string</td>
+<td align="left">Folder name (mandatory)</td>
+</tr>
+<tr class="even">
+<td align="left">created</td>
+<td align="left">long</td>
+<td align="left">
+<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity creation</td>
+</tr>
+<tr class="odd">
+<td align="left">modified</td>
+<td align="left">long</td>
+<td align="left">
+<a href="http://en.wikipedia.org/wiki/Unix_time">UNIX timestamp</a> of entity modification</td>
+</tr>
+<tr class="even">
+<td align="left">owner</td>
+<td align="left">UUID</td>
+<td align="left">UUID of the folder’s owner (mandatory)</td>
+</tr>
+<tr class="odd">
+<td align="left">path</td>
+<td align="left">string</td>
+<td align="left">Relative path to the folder (mandatory)</td>
+</tr>
+</tbody>
+</table>
+<p>Folders have the following set properties.</p>
+<table>
+<thead>
+<tr class="header">
+<th align="left">Set</th>
+<th align="left">Type</th>
+<th align="left">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td align="left">connections</td>
+<td align="left">string</td>
+<td align="left">set of connections for the folder</td>
+</tr>
+</tbody>
+</table>
+<p> </p>
+ </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/folder.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>