You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by to...@apache.org on 2015/11/02 23:56:33 UTC
[42/50] [abbrv] usergrid git commit: Update 2 install docs to point
to 2.1 and to include the correct /system API calls needed to init storage
and indexing.
Update 2 install docs to point to 2.1 and to include the correct /system API calls needed to init storage and indexing.
Project: http://git-wip-us.apache.org/repos/asf/usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/usergrid/commit/9d3cf5b8
Tree: http://git-wip-us.apache.org/repos/asf/usergrid/tree/9d3cf5b8
Diff: http://git-wip-us.apache.org/repos/asf/usergrid/diff/9d3cf5b8
Branch: refs/heads/USERGRID-909
Commit: 9d3cf5b8b0d91170984f948e2d343edb9a0b4953
Parents: 5109952
Author: Dave Johnson <sn...@apache.org>
Authored: Fri Oct 30 14:52:18 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Fri Oct 30 14:52:18 2015 -0400
----------------------------------------------------------------------
.../installation/ug2-deploy-to-tomcat.txt | 42 +++++++++++++-------
.../docs/installation/ug2-deploy-to-tomcat.html | 37 ++++++++++-------
content/docs/searchindex.js | 2 +-
docs/installation/ug2-deploy-to-tomcat.md | 42 +++++++++++++-------
4 files changed, 78 insertions(+), 45 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/usergrid/blob/9d3cf5b8/content/docs/_sources/installation/ug2-deploy-to-tomcat.txt
----------------------------------------------------------------------
diff --git a/content/docs/_sources/installation/ug2-deploy-to-tomcat.txt b/content/docs/_sources/installation/ug2-deploy-to-tomcat.txt
index a07f13a..049b909 100644
--- a/content/docs/_sources/installation/ug2-deploy-to-tomcat.txt
+++ b/content/docs/_sources/installation/ug2-deploy-to-tomcat.txt
@@ -2,6 +2,7 @@
__NOTE__: Beware that Usergrid 2 is UNRELEASED SOFTWARE
+
## Requirements
* [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
@@ -9,44 +10,56 @@ __NOTE__: Beware that Usergrid 2 is UNRELEASED SOFTWARE
* [Tomcat 7+](https://tomcat.apache.org/download-70.cgi)
* [Cassandra 1.2.1*](http://cassandra.apache.org/download/)
* [ElasticSearch 1.4+](https://www.elastic.co/downloads/elasticsearch)
-* [Usergrid 2.0](https://github.com/apache/usergrid/tree/two-dot-o)
-
-##Running
+* [Usergrid 2.1](https://github.com/apache/usergrid/tree/2.1-release)
+## Running
1. Start up Cassandra [^1]
a. To do this you can navigate to the cassandra folder and run ```./bin/cassandra ```
2. Start up Elasticsearch
a. To do this you can navigate to the folder where you extracted elasticsearch and run ```/bin/elasticsearch```
-###Running Usergrid
+### Running Usergrid
-####Build The Java Sdk
+#### Build The Java SDK
1. Navigate to where you cloned the usergrid repo
2. Navigate to the ```sdks/java``` directory
3. Run ```mvn clean install```
-####Build The Stack Itself
+#### Build The Stack Itself
1. Navigate to the ```stack``` directory.
2. Run ```mvn clean install -DskipTests```
3. This will generate a war at ```rest/target/ROOT.war```
-####Deploying the Stack Locally
+#### Deploying the Stack Locally
+
1. Take this war and deploy it on downloaded tomcat.
1. In the lib directory of the tomcat you must also put usergrid-deployment.properties. ( An example file is provided below)
1. Start up Tomcat
a. To do this you can navigate to folder where Tomcat is install and run ```./bin/catalina.sh start```
-1. Go to a web browser and input the following to initilizing the database ```localhost:8080/system/database/setup```.
- a. The credentials it asks for are the admin credentialls and password as defined in the usergrid-deployment.properties.
- b. You can also do a curl call with basic auth to automatically authenticate the call instead of using the web browser.
-1. Then using the same steps as before call ```localhost:8080/system/superuser/setup```
+
+Next, you need to make some API calls to initialize Usergrid's storage and indexing systems. You can make these
+API calls using curl or your favorite HTTP client. These calls can only be done with the superuser credentials
+that appear in your __usergrid-deployment.properties__ file. Here's how to do the calls with curl (and assuming
+your superuser password is 'test'):
+
+ curl -X PUT http://localhost:8080/system/database/setup -u superuser:test
+ curl -X PUT http://localhost:8080/system/database/bootstrap -u superuser:test
+ curl -X GET http://localhost:8080/system/superuser/setup -u superuser:test
-The stack is now ready to be queried against, but to get the most out of it you'll need to initilize and use our portal!
+Once those three calls execute without error, then you are done. If you do see errors the double-check that you
+have Cassandra and ElasticSearch running and that your properties files lists your Cassandra and ElasticSearch
+hostnames correctly. Also check that ElasticSearch cluster name (in elasticsearch.yml) matches the one in the
+Usergrid properties file. If the problem persists come talk to us on the Usergrid mailing list, we might be able to help.
+
+The stack is now ready to be queried against, but to get the most out of it you'll need to initialize and use our portal!
+
+#### Running The Portal Locally
+
+##### Requirments
-####Running The Portal Locally
-#####Requirments
[nodejs 0.10+](https://nodejs.org/download/)
1. Make sure you've installed node.js above. Any version above .10 or .10 should work fine.
@@ -58,7 +71,6 @@ The stack is now ready to be queried against, but to get the most out of it you'
Now usergrid is fully ready to use! Feel free to query against it or use it however you like!
-
Example __usergrid-deployment.properties__ file
---
```
http://git-wip-us.apache.org/repos/asf/usergrid/blob/9d3cf5b8/content/docs/installation/ug2-deploy-to-tomcat.html
----------------------------------------------------------------------
diff --git a/content/docs/installation/ug2-deploy-to-tomcat.html b/content/docs/installation/ug2-deploy-to-tomcat.html
index 915c2a7..4831130 100644
--- a/content/docs/installation/ug2-deploy-to-tomcat.html
+++ b/content/docs/installation/ug2-deploy-to-tomcat.html
@@ -192,7 +192,7 @@
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#running">Running</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#running-usergrid">Running Usergrid</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#build-the-java-sdk">Build The Java Sdk</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#build-the-java-sdk">Build The Java SDK</a></li>
<li class="toctree-l4"><a class="reference internal" href="#build-the-stack-itself">Build The Stack Itself</a></li>
<li class="toctree-l4"><a class="reference internal" href="#deploying-the-stack-locally">Deploying the Stack Locally</a></li>
<li class="toctree-l4"><a class="reference internal" href="#running-the-portal-locally">Running The Portal Locally</a></li>
@@ -259,7 +259,8 @@
<li><a class="reference external" href="http://cassandra.apache.org/download/">Cassandra 1.2.1*</a></li>
<li><a class="reference external" href="https://www.elastic.co/downloads/elasticsearch">ElasticSearch
1.4+</a></li>
-<li><a class="reference external" href="https://github.com/apache/usergrid/tree/two-dot-o">Usergrid 2.0</a></li>
+<li><a class="reference external" href="https://github.com/apache/usergrid/tree/2.1-release">Usergrid
+2.1</a></li>
</ul>
</div>
<div class="section" id="running">
@@ -279,7 +280,7 @@ elasticsearch and run <code class="docutils literal"><span class="pre">/bin/elas
<div class="section" id="running-usergrid">
<h3>Running Usergrid<a class="headerlink" href="#running-usergrid" title="Permalink to this headline">¶</a></h3>
<div class="section" id="build-the-java-sdk">
-<h4>Build The Java Sdk<a class="headerlink" href="#build-the-java-sdk" title="Permalink to this headline">¶</a></h4>
+<h4>Build The Java SDK<a class="headerlink" href="#build-the-java-sdk" title="Permalink to this headline">¶</a></h4>
<ol class="arabic simple">
<li>Navigate to where you cloned the usergrid repo</li>
<li>Navigate to the <code class="docutils literal"><span class="pre">sdks/java</span></code> directory</li>
@@ -305,19 +306,27 @@ usergrid-deployment.properties. ( An example file is provided below)</li>
run <code class="docutils literal"><span class="pre">./bin/catalina.sh</span> <span class="pre">start</span></code></li>
</ol>
</li>
-<li>Go to a web browser and input the following to initilizing the
-database <code class="docutils literal"><span class="pre">localhost:8080/system/database/setup</span></code>.<ol class="loweralpha">
-<li>The credentials it asks for are the admin credentialls and
-password as defined in the usergrid-deployment.properties.</li>
-<li>You can also do a curl call with basic auth to automatically
-authenticate the call instead of using the web browser.</li>
-</ol>
-</li>
-<li>Then using the same steps as before call
-<code class="docutils literal"><span class="pre">localhost:8080/system/superuser/setup</span></code></li>
</ol>
+<p>Next, you need to make some API calls to initialize Usergrid’s storage
+and indexing systems. You can make these API calls using curl or your
+favorite HTTP client. These calls can only be done with the superuser
+credentials that appear in your <strong>usergrid-deployment.properties</strong> file.
+Here’s how to do the calls with curl (and assuming your superuser
+password is ‘test’):</p>
+<div class="highlight-python"><div class="highlight"><pre>curl -X PUT http://localhost:8080/system/database/setup -u superuser:test
+curl -X PUT http://localhost:8080/system/database/bootstrap -u superuser:test
+curl -X GET http://localhost:8080/system/superuser/setup -u superuser:test
+</pre></div>
+</div>
+<p>Once those three calls execute without error, then you are done. If you
+do see errors the double-check that you have Cassandra and ElasticSearch
+running and that your properties files lists your Cassandra and
+ElasticSearch hostnames correctly. Also check that ElasticSearch cluster
+name (in elasticsearch.yml) matches the one in the Usergrid properties
+file. If the problem persists come talk to us on the Usergrid mailing
+list, we might be able to help.</p>
<p>The stack is now ready to be queried against, but to get the most out of
-it you’ll need to initilize and use our portal!</p>
+it you’ll need to initialize and use our portal!</p>
</div>
<div class="section" id="running-the-portal-locally">
<h4>Running The Portal Locally<a class="headerlink" href="#running-the-portal-locally" title="Permalink to this headline">¶</a></h4>