diff --git a/docs/assets/themes/zeppelin/css/style.css b/docs/assets/themes/zeppelin/css/style.css index 7e3449616dd..a5507d31311 100644 --- a/docs/assets/themes/zeppelin/css/style.css +++ b/docs/assets/themes/zeppelin/css/style.css @@ -433,6 +433,8 @@ a.anchor { word-break: keep-all; -webkit-overflow-scrolling: touch; font-size: 90%; + margin-top: 16px; + margin-bottom: 16px; } .content table th { font-weight: bold; diff --git a/docs/index.md b/docs/index.md index 628821760df..fd26c4dd5e5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -124,9 +124,9 @@ Join to our [Mailing list](https://zeppelin.apache.org/community.html) and repor ####Quick Start * Getting Started - * [Quick Start](./install/install.html) for basic instructions on installing Zeppelin - * [Configuration](./install/install.html#zeppelin-configuration) lists for Zeppelin - * [Explore Apache Zeppelin UI](./quickstart/explorezeppelinui.html): basic components of Zeppelin home + * [Quick Start](./install/install.html) for basic instructions on installing Apache Zeppelin + * [Configuration](./install/install.html#apache-zeppelin-configuration) lists for Apache Zeppelin + * [Explore Apache Zeppelin UI](./quickstart/explorezeppelinui.html): basic components of Apache Zeppelin home * [Tutorial](./quickstart/tutorial.html): a short walk-through tutorial that uses Apache Spark backend * Basic Feature Guide * [Dynamic Form](./manual/dynamicform.html): a step by step guide for creating dynamic forms diff --git a/docs/install/install.md b/docs/install/install.md index e3dcd2c0005..93d9febe507 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -19,38 +19,113 @@ limitations under the License. --> {% include JB/setup %} -## Zeppelin Installation -Welcome to your first trial to explore Zeppelin! +# Quick Start +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. -In this documentation, we will explain how you can install Zeppelin from **Binary Package** or build from **Source** by yourself. Plus, you can see all of Zeppelin's configurations in the [Zeppelin Configuration](install.html#zeppelin-configuration) section below. +* [Installation](#installation) + * [Downloading Binary Package](#downloading-binary-package) + * [Building from Source](#building-from-source) +* [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line) + * [Start Zeppelin](#start-zeppelin) + * [Stop Zeppelin](#stop-zeppelin) + * [(Optional) Start Apache Zeppelin with a service manager](#optional-start-apache-zeppelin-with-a-service-manager) +* [What is the next?](#what-is-the-next) +* [Apache Zeppelin Configuration](#apache-zeppelin-configuration) -### Install with Binary Package +## Installation -If you want to install Zeppelin with latest binary package, please visit [this page](http://zeppelin.apache.org/download.html). +Apache Zeppelin officially supports and is tested on next environments. -### Build from Zeppelin Source + + + + + + + + + + + + + +
NameValue
Oracle JDK1.7
(set JAVA_HOME)
OSMac OSX
Ubuntu 14.X
CentOS 6.X
Windows 7 Pro SP1
+ +There are two options to install Apache Zeppelin on your machine. One is [downloading prebuild binary package](#downloading-binary-package) from the archive. +You can download not only the latest stable version but also the older one if you need. +The other option is [building from the source](#building-from-source). +Although it can be unstable somehow since it is on development status, you can explore newly added feature and change it as you want. + +### Downloading Binary Package + +If you want to install Apache Zeppelin with a stable binary package, please visit [Apache Zeppelin download Page](http://zeppelin.apache.org/download.html). +After unpacking, jump to [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line) section. + +### Building from Source +If you want to build from the source, the software below needs to be installed on your system. + + + + + + + + + + + + + + +
NameValue
Git
Maven3.1.x or higher
+ +If you don't have it installed yet, please check [Before Build](https://github.com/apache/zeppelin/blob/master/README.md#before-build) section and follow step by step instructions from there. + +####1. Clone Apache Zeppelin repository -You can also build Zeppelin from the source. +``` +git clone https://github.com/apache/zeppelin.git +``` + +####2. Build source with options +Each interpreters requires different build options. For the further information about options, please see [Build](https://github.com/apache/zeppelin#build) section. + +``` +mvn clean package -DskipTests [Options] +``` -#### Prerequisites for build - * Java 1.7 - * Git - * Maven(3.1.x or higher) - * Node.js Package Manager +Here are some examples with several options -If you don't have requirements prepared, please check instructions in [README.md](https://github.com/apache/zeppelin/blob/master/README.md) for the details. +``` +# basic build +mvn clean package -Pspark-1.6 -Phadoop-2.4 -Pyarn -Ppyspark + +# spark-cassandra integration +mvn clean package -Pcassandra-spark-1.5 -Dhadoop.version=2.6.0 -Phadoop-2.6 -DskipTests +# with CDH +mvn clean package -Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pvendor-repo -DskipTests +# with MapR +mvn clean package -Pspark-1.5 -Pmapr50 -DskipTests +``` -Maybe you need to configure individual interpreter. If so, please check **Interpreter** section in Zeppelin documentation. -[Spark Interpreter for Apache Zeppelin](../interpreter/spark.html) will be a good example. +For the further information about building with source, please see [README.md](https://github.com/apache/zeppelin/blob/master/README.md) in Zeppelin repository. -## Zeppelin Start / Stop +## Starting Apache Zeppelin with Command Line #### Start Zeppelin ``` bin/zeppelin-daemon.sh start ``` + +If you are using Windows + +``` +bin\zeppelin.cmd +``` + After successful start, visit [http://localhost:8080](http://localhost:8080) with your web browser. #### Stop Zeppelin @@ -59,21 +134,28 @@ After successful start, visit [http://localhost:8080](http://localhost:8080) wit bin/zeppelin-daemon.sh stop ``` -#### Start Zeppelin with a service manager such as upstart +#### (Optional) Start Apache Zeppelin with a service manager -Zeppelin can auto start as a service with an init script, such as services managed by upstart. +> **Note :** The below description was written based on Ubuntu Linux. -The following is an example upstart script to be saved as `/etc/init/zeppelin.conf` -This example has been tested with Ubuntu Linux. +Apache Zeppelin can be auto started as a service with an init script, such as services managed by **upstart**. + +The following is an example of upstart script to be saved as `/etc/init/zeppelin.conf` This also allows the service to be managed with commands such as -`sudo service zeppelin start` -`sudo service zeppelin stop` -`sudo service zeppelin restart` +``` +sudo service zeppelin start +sudo service zeppelin stop +sudo service zeppelin restart +``` + +Other service managers could use a similar approach with the `upstart` argument passed to the `zeppelin-daemon.sh` script. -Other service managers could use a similar approach with the `upstart` argument passed to the zeppelin-daemon.sh script: `bin/zeppelin-daemon.sh upstart` +``` +bin/zeppelin-daemon.sh upstart +``` -##### zeppelin.conf +**zeppelin.conf** ``` description "zeppelin" @@ -93,15 +175,16 @@ chdir /usr/share/zeppelin exec bin/zeppelin-daemon.sh upstart ``` -#### Running on Windows +## What is the next? +Congratulation on your successful Apache Zeppelin installation! Here are two next steps you might need. -``` -bin\zeppelin.cmd -``` + * For an in-depth overview of Apache Zeppelin UI, head to [Explore Apache Zeppelin UI](../quickstart/explorezeppelinui.html) + * After getting familiar with Apache Zeppelin UI, have fun with a short walk-through [Tutorial](../quickstart/tutorial.html) that uses Apache Spark backend + * If you need more configuration setting for Apache Zeppelin, jump to the next section: [Apache Zeppelin Configuration](#apache-zeppelin-configuration) -## Zeppelin Configuration +## Apache Zeppelin Configuration -You can configure Zeppelin with both **environment variables** in `conf/zeppelin-env.sh` (`conf\zeppelin-env.cmd` for Windows) and **Java properties** in `conf/zeppelin-site.xml`. If both are defined, then the **environment variables** will take priority. +You can configure Apache Zeppelin with both **environment variables** in `conf/zeppelin-env.sh` (`conf\zeppelin-env.cmd` for Windows) and **Java properties** in `conf/zeppelin-site.xml`. If both are defined, then the **environment variables** will take priority. @@ -210,13 +293,13 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin - + - + @@ -228,13 +311,13 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin - + - + @@ -270,7 +353,7 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin - + @@ -291,13 +374,13 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin - + - +
ZEPPELIN_NOTEBOOK_HOMESCREEN zeppelin.notebook.homescreen A notebook id displayed in Zeppelin homescreen
i.e. 2A94M5J1Z		A notebook id displayed in Apache Zeppelin homescreen
i.e. 2A94M5J1Z
ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE zeppelin.notebook.homescreen.hide falseThis value can be "true" when to hide the notebook id set by ZEPPELIN_NOTEBOOK_HOMESCREEN on the Zeppelin homescreen.
For the further information, please read Customize your Zeppelin homepage.		This value can be "true" when to hide the notebook id set by ZEPPELIN_NOTEBOOK_HOMESCREEN on the Apache Zeppelin homescreen.
For the further information, please read Customize your Zeppelin homepage.
ZEPPELIN_WAR_TEMPDIRZEPPELIN_NOTEBOOK_DIR zeppelin.notebook.dir notebookThe root directory where Zeppelin notebook directories are savedThe root directory where notebook directories are saved
ZEPPELIN_NOTEBOOK_S3_BUCKET zeppelin.notebook.s3.bucket zeppelinS3 Bucket where Zeppelin notebook files will be savedS3 Bucket where notebook files will be saved
ZEPPELIN_NOTEBOOK_S3_USERZEPPELIN_NOTEBOOK_AZURE_SHARE zeppelin.notebook.azure.share zeppelinShare where the Zeppelin notebook files will be savedShare where the notebook files will be saved
ZEPPELIN_NOTEBOOK_AZURE_USERorg.apache.zeppelin.spark.SparkInterpreter,
org.apache.zeppelin.spark.PySparkInterpreter,
org.apache.zeppelin.spark.SparkSqlInterpreter,
org.apache.zeppelin.spark.DepInterpreter,
org.apache.zeppelin.markdown.Markdown,
org.apache.zeppelin.shell.ShellInterpreter,
... 		Comma separated interpreter configurations [Class]
The first interpreter will be a default value.
It means only the first interpreter in this list can be available without %interpreter_name annotation in Zeppelin notebook paragraph. 		Comma separated interpreter configurations [Class]
The first interpreter will be a default value.
It means only the first interpreter in this list can be available without %interpreter_name annotation in notebook paragraph.
ZEPPELIN_INTERPRETER_DIR zeppelin.interpreter.dir interpreterZeppelin interpreter directoryInterpreter directory
ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE