You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by ah...@apache.org on 2016/09/25 07:10:15 UTC
svn commit: r1762157 -
/zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html
Author: ahyoungryu
Date: Sun Sep 25 07:10:15 2016
New Revision: 1762157
URL: http://svn.apache.org/viewvc?rev=1762157&view=rev
Log: (empty)
Modified:
zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html
Modified: zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html?rev=1762157&r1=1762156&r2=1762157&view=diff
==============================================================================
--- zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html (original)
+++ zeppelin/site/docs/0.7.0-SNAPSHOT/install/install.html Sun Sep 25 07:10:15 2016
@@ -4,7 +4,7 @@
<head>
<meta charset="utf-8">
<title>Apache Zeppelin 0.7.0-SNAPSHOT Documentation: Quick Start</title>
- <meta name="description" content="This page will help you to get started and guide you through installation of Apache Zeppelin, running it in the command line and basic configuration options.">
+ <meta name="description" content="This page will help you get started and will guide you through installing Apache Zeppelin, running it in the command line and configuring options.">
<meta name="author" content="The Apache Software Foundation">
<!-- Enable responsive viewport -->
@@ -201,14 +201,13 @@ limitations under the License.
<h1>Quick Start</h1>
-<p>Welcome to your first trial to explore Apache Zeppelin!
-This page will help you to get started and here is the list of topics covered.</p>
-
<div id="toc"></div>
+<p>Welcome to Apache Zeppelin! On this page are instructions to help you get started.</p>
+
<h2>Installation</h2>
-<p>Apache Zeppelin officially supports and is tested on next environments.</p>
+<p>Apache Zeppelin officially supports and is tested on the following environments:</p>
<table class="table-configuration">
<tr>
@@ -225,22 +224,21 @@ This page will help you to get started a
</tr>
</table>
-<p>There are two options to install Apache Zeppelin on your machine. One is <a href="#downloading-binary-package">downloading pre-built binary package</a> from the archive.
-You can download not only the latest stable version but also the older one if you need.
-The other option is <a href="#building-from-source">building from the source</a>.
-Although it can be unstable somehow since it is on development status, you can explore newly added feature and change it as you want.</p>
+<p>To install Apache Zeppelin, you have two options:
+* You can <a href="#downloading-binary-package">download pre-built binary packages</a> from the archive. This is usually easier than building from source, and you can download the latest stable version (or older versions, if necessary).
+* You can also <a href="#building-from-source">build from source</a>. This gives you a development version of Zeppelin, which is more unstable but has new features.</p>
<h3>Downloading Binary Package</h3>
-<p>If you want to install Apache Zeppelin with a stable binary package, please visit <a href="http://zeppelin.apache.org/download.html">Apache Zeppelin download Page</a>. </p>
+<p>Stable binary packages are available on the <a href="http://zeppelin.apache.org/download.html">Apache Zeppelin Download Page</a>. You can download a default package with all interpreters, or you can download the <em>net-install</em> package, which lets you choose which interpreters to install.</p>
-<p>If you have downloaded <code>netinst</code> binary, <a href="../manual/interpreterinstallation.html">install additional interpreters</a> before you start Zeppelin. Or simply run <code>./bin/install-interpreter.sh --all</code>.</p>
+<p>If you downloaded the default package, just unpack it in a directory of your choice and you're ready to go. If you downloaded the <em>net-install</em> package, you should manually <a href="../manual/interpreterinstallation.html">install additional interpreters</a> first. You can also install everything by running <code>./bin/install-interpreter.sh --all</code>.</p>
-<p>After unpacking, jump to <a href="#starting-apache-zeppelin-with-command-line">Starting Apache Zeppelin with Command Line</a> section.</p>
+<p>After unpacking, jump to the <a href="#starting-apache-zeppelin-with-command-line">Starting Apache Zeppelin with Command Line</a>.</p>
<h3>Building from Source</h3>
-<p>If you want to build from the source, the software below needs to be installed on your system.</p>
+<p>If you want to build from source, you must first install the following dependencies:</p>
<table class="table-configuration">
<tr>
@@ -249,7 +247,7 @@ Although it can be unstable somehow sinc
</tr>
<tr>
<td>Git</td>
- <td></td>
+ <td>(Any Version)</td>
</tr>
<tr>
<td>Maven</td>
@@ -257,17 +255,17 @@ Although it can be unstable somehow sinc
</tr>
</table>
-<p>If you don't have it installed yet, please check <a href="https://github.com/apache/zeppelin/blob/master/README.md#before-build">Before Build</a> section and follow step by step instructions from there.</p>
+<p>If you haven't installed Git and Maven yet, check the <a href="https://github.com/apache/zeppelin/blob/master/README.md#before-build">Before Build</a> section and follow the step by step instructions from there.</p>
-<h4>1. Clone Apache Zeppelin repository</h4>
+<h4>1. Clone the Apache Zeppelin repository</h4>
<div class="highlight"><pre><code class="text language-text" data-lang="text">git clone https://github.com/apache/zeppelin.git
</code></pre></div>
<h4>2. Build source with options</h4>
-<p>Each interpreters requires different build options. For the further information about options, please see <a href="https://github.com/apache/zeppelin#build">Build</a> section.</p>
+<p>Each interpreter requires different build options. For more information about build options, please see the <a href="https://github.com/apache/zeppelin#build">Build</a> section.</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">mvn clean package -DskipTests [Options]
</code></pre></div>
-<p>Here are some examples with several options</p>
+<p>Here are some examples with several options:</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text"># build with spark-2.0, scala-2.11
./dev/change_scala_version.sh 2.11
mvn clean package -Pspark-2.0 -Phadoop-2.4 -Pyarn -Ppyspark -Psparkr -Pscala-2.11
@@ -284,19 +282,21 @@ mvn clean package -Pspark-1.5 -Dhadoop.v
# with MapR
mvn clean package -Pspark-1.5 -Pmapr50 -DskipTests
</code></pre></div>
-<p>For the further information about building with source, please see <a href="https://github.com/apache/zeppelin/blob/master/README.md">README.md</a> in Zeppelin repository.</p>
+<p>For further information about building from source, please see <a href="https://github.com/apache/zeppelin/blob/master/README.md">README.md</a> in the Zeppelin repository.</p>
+
+<h2>Starting Apache Zeppelin from the Command Line</h2>
-<h2>Starting Apache Zeppelin with Command Line</h2>
+<h4>Starting Apache Zeppelin</h4>
-<h4>Start Zeppelin</h4>
+<p>On all platforms except for Windows:</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">bin/zeppelin-daemon.sh start
</code></pre></div>
-<p>If you are using Windows </p>
+<p>If you are using Windows:</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">bin\zeppelin.cmd
</code></pre></div>
-<p>After successful start, visit <a href="http://localhost:8080">http://localhost:8080</a> with your web browser.</p>
+<p>After Zeppelin has started successfully, go to <a href="http://localhost:8080">http://localhost:8080</a> with your web browser.</p>
-<h4>Stop Zeppelin</h4>
+<h4>Stopping Zeppelin</h4>
<div class="highlight"><pre><code class="text language-text" data-lang="text">bin/zeppelin-daemon.sh stop
</code></pre></div>
<h4>(Optional) Start Apache Zeppelin with a service manager</h4>
@@ -305,10 +305,10 @@ mvn clean package -Pspark-1.5 -Pmapr50 -
<p><strong>Note :</strong> The below description was written based on Ubuntu Linux.</p>
</blockquote>
-<p>Apache Zeppelin can be auto started as a service with an init script, such as services managed by <strong>upstart</strong>.</p>
+<p>Apache Zeppelin can be auto-started as a service with an init script, using a service manager like <strong>upstart</strong>.</p>
-<p>The following is an example of upstart script to be saved as <code>/etc/init/zeppelin.conf</code>
-This also allows the service to be managed with commands such as</p>
+<p>This is an example upstart script saved as <code>/etc/init/zeppelin.conf</code>
+This allows the service to be managed with commands such as</p>
<div class="highlight"><pre><code class="text language-text" data-lang="text">sudo service zeppelin start
sudo service zeppelin stop
sudo service zeppelin restart
@@ -333,34 +333,34 @@ respawn limit 7 5
chdir /usr/share/zeppelin
exec bin/zeppelin-daemon.sh upstart
</code></pre></div>
-<h2>What is the next?</h2>
+<h2>Next Steps:</h2>
-<p>Congratulation on your successful Apache Zeppelin installation! Here are two next steps you might need.</p>
+<p>Congratulations, you have successfully installed Apache Zeppelin! Here are two next steps you might find useful:</p>
-<h4>If you are new to Apache Zeppelin</h4>
+<h4>If you are new to Apache Zeppelin...</h4>
<ul>
-<li>For an in-depth overview of Apache Zeppelin UI, head to <a href="../quickstart/explorezeppelinui.html">Explore Apache Zeppelin UI</a>.</li>
-<li>After getting familiar with Apache Zeppelin UI, have fun with a short walk-through <a href="../quickstart/tutorial.html">Tutorial</a> that uses Apache Spark backend.</li>
-<li>If you need more configuration setting for Apache Zeppelin, jump to the next section: <a href="#apache-zeppelin-configuration">Apache Zeppelin Configuration</a>.</li>
+<li>For an in-depth overview of the Apache Zeppelin UI, head to <a href="../quickstart/explorezeppelinui.html">Explore Apache Zeppelin UI</a>.</li>
+<li>After getting familiar with the Apache Zeppelin UI, have fun with a short walk-through <a href="../quickstart/tutorial.html">Tutorial</a> that uses the Apache Spark backend.</li>
+<li>If you need more configuration for Apache Zeppelin, jump to the next section: <a href="#apache-zeppelin-configuration">Apache Zeppelin Configuration</a>.</li>
</ul>
-<h4>If you need more information about Spark or JDBC interpreter setting</h4>
+<h4>If you need more information about Spark or JDBC interpreter settings...</h4>
<ul>
-<li>Apache Zeppelin provides deep integration with <a href="http://spark.apache.org/">Apache Spark</a>. For the further informtation, see <a href="../interpreter/spark.html">Spark Interpreter for Apache Zeppelin</a>. </li>
-<li>Also, you can use generic JDBC connections in Apache Zeppelin. Go to <a href="../interpreter/jdbc.html">Generic JDBC Interpreter for Apache Zeppelin</a>.</li>
+<li>Apache Zeppelin provides deep integration with <a href="http://spark.apache.org/">Apache Spark</a>. For more informtation, see <a href="../interpreter/spark.html">Spark Interpreter for Apache Zeppelin</a>. </li>
+<li>You can also use generic JDBC connections in Apache Zeppelin. Go to <a href="../interpreter/jdbc.html">Generic JDBC Interpreter for Apache Zeppelin</a>.</li>
</ul>
-<h4>If you are in multi-user environment</h4>
+<h4>If you are in a multi-user environment...</h4>
<ul>
-<li>You can set permissions for your notebooks and secure data resource in multi-user environment. Go to <strong>More</strong> -> <strong>Security</strong> section.</li>
+<li>You can set permissions for your notebooks and secure data resource in a multi-user environment. Go to <strong>More</strong> -> <strong>Security</strong> section.</li>
</ul>
<h2>Apache Zeppelin Configuration</h2>
-<p>You can configure Apache Zeppelin with both <strong>environment variables</strong> in <code>conf/zeppelin-env.sh</code> (<code>conf\zeppelin-env.cmd</code> for Windows) and <strong>Java properties</strong> in <code>conf/zeppelin-site.xml</code>. If both are defined, then the <strong>environment variables</strong> will take priority.</p>
+<p>You can configure Apache Zeppelin with either <strong>environment variables</strong> in <code>conf/zeppelin-env.sh</code> (<code>conf\zeppelin-env.cmd</code> for Windows) or <strong>Java properties</strong> in <code>conf/zeppelin-site.xml</code>. If both are defined, then the <strong>environment variables</strong> will take priority.</p>
<table class="table-configuration">
<tr>
@@ -397,19 +397,19 @@ exec bin/zeppelin-daemon.sh upstart
<td>ZEPPELIN_ALLOWED_ORIGINS</td>
<td>zeppelin.server.allowed.origins</td>
<td>*</td>
- <td>Enables a way to specify a ',' separated list of allowed origins for rest and websockets. <br /> i.e. http://localhost:8080 </td>
+ <td>Enables a way to specify a ',' separated list of allowed origins for REST and websockets. <br /> i.e. http://localhost:8080 </td>
</tr>
<tr>
<td>N/A</td>
<td>zeppelin.anonymous.allowed</td>
<td>true</td>
- <td>Anonymous user is allowed by default.</td>
+ <td>The anonymous user is allowed by default.</td>
</tr>
<tr>
<td>ZEPPELIN_SERVER_CONTEXT_PATH</td>
<td>zeppelin.server.context.path</td>
<td>/</td>
- <td>A context path of the web application</td>
+ <td>Context path of the web application</td>
</tr>
<tr>
<td>ZEPPELIN_SSL</td>
@@ -469,19 +469,19 @@ exec bin/zeppelin-daemon.sh upstart
<td>ZEPPELIN_NOTEBOOK_HOMESCREEN</td>
<td>zeppelin.notebook.homescreen</td>
<td></td>
- <td>A notebook id displayed in Apache Zeppelin homescreen <br />i.e. 2A94M5J1Z</td>
+ <td>Display notebook IDs on the Apache Zeppelin homescreen <br />i.e. 2A94M5J1Z</td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE</td>
<td>zeppelin.notebook.homescreen.hide</td>
<td>false</td>
- <td>This value can be "true" when to hide the notebook id set by <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> on the Apache Zeppelin homescreen. <br />For the further information, please read <a href="../manual/notebookashomepage.html">Customize your Zeppelin homepage</a>.</td>
+ <td>Hide the notebook ID set by <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> on the Apache Zeppelin homescreen. <br />For the further information, please read <a href="../manual/notebookashomepage.html">Customize your Zeppelin homepage</a>.</td>
</tr>
<tr>
<td>ZEPPELIN_WAR_TEMPDIR</td>
<td>zeppelin.war.tempdir</td>
<td>webapps</td>
- <td>A location of jetty temporary directory</td>
+ <td>Location of the jetty temporary directory</td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_DIR</td>
@@ -499,7 +499,7 @@ exec bin/zeppelin-daemon.sh upstart
<td>ZEPPELIN_NOTEBOOK_S3_USER</td>
<td>zeppelin.notebook.s3.user</td>
<td>user</td>
- <td>A user name of S3 bucket<br />i.e. <code>bucket/user/notebook/2A94M5J1Z/note.json</code></td>
+ <td>User name of an S3 bucket<br />i.e. <code>bucket/user/notebook/2A94M5J1Z/note.json</code></td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_S3_ENDPOINT</td>
@@ -529,25 +529,25 @@ exec bin/zeppelin-daemon.sh upstart
<td>ZEPPELIN_NOTEBOOK_AZURE_SHARE</td>
<td>zeppelin.notebook.azure.share</td>
<td>zeppelin</td>
- <td>Share where the notebook files will be saved</td>
+ <td>Azure Share where the notebook files will be saved</td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_AZURE_USER</td>
<td>zeppelin.notebook.azure.user</td>
<td>user</td>
- <td>An optional user name of Azure file share<br />i.e. <code>share/user/notebook/2A94M5J1Z/note.json</code></td>
+ <td>Optional user name of an Azure file share<br />i.e. <code>share/user/notebook/2A94M5J1Z/note.json</code></td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_STORAGE</td>
<td>zeppelin.notebook.storage</td>
<td>org.apache.zeppelin.notebook.repo.VFSNotebookRepo</td>
- <td>Comma separated list of notebook storage</td>
+ <td>Comma separated list of notebook storage locations</td>
</tr>
<tr>
<td>ZEPPELIN_NOTEBOOK_ONE_WAY_SYNC</td>
<td>zeppelin.notebook.one.way.sync</td>
<td>false</td>
- <td>If there are multiple notebook storages, should we treat the first one as the only source of truth?</td>
+ <td>If there are multiple notebook storage locations, should we treat the first one as the only source of truth?</td>
</tr>
<tr>
<td>ZEPPELIN_INTERPRETERS</td>
@@ -558,7 +558,7 @@ exec bin/zeppelin-daemon.sh upstart
</td>
<td>
Comma separated interpreter configurations [Class] <br/>
- <span style="font-style:italic">NOTE: This property is deprecated since Zeppelin-0.6.0 and will not be supported from Zeppelin-0.7.0</span>
+ <span style="font-style:italic">NOTE: This property is deprecated since Zeppelin-0.6.0 and will not be supported from Zeppelin-0.7.0 on.</span>
</td>
</tr>
<tr>
@@ -571,7 +571,7 @@ exec bin/zeppelin-daemon.sh upstart
<td>ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE</td>
<td>zeppelin.websocket.max.text.message.size</td>
<td>1024000</td>
- <td>Size in characters of the maximum text message to be received by websocket.</td>
+ <td>Size (in characters) of the maximum text message that can be received by websocket.</td>
</tr>
</table>