diff --git a/docs/install/install.md b/docs/install/install.md index 493a96d96a..15a20f6097 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -1,6 +1,6 @@ --- layout: page -title: "Install Zeppelin" +title: "Zeppelin Installation" description: "" group: install --- @@ -21,191 +21,291 @@ limitations under the License. -## From binary package +## Zeppelin Installation +Welcome to your first trial to explore Zeppelin ! - Download latest binary package from [Download](../download.html). +In this documentation, we will guide you how you can install Zeppelin from **Binary Package** or build from **Source** by yourself. Plus, you can get a specific infomation about Zeppelin configurations at the below **Zeppelin Configuration** section. + +### Install with Binary Package + +If you want to install Zeppelin with latest binary package, please visit [this page](http://zeppelin.incubator.apache.org/download.html). + +### Build from Zeppelin Source + +You can also build Zeppelin from the source. Please check instructions of `README.md` in [Zeppelin github](https://github.com/apache/incubator-zeppelin/blob/master/README.md). -## Build from source +## Zeppelin Configuration - Check instructions in [README](https://github.com/apache/incubator-zeppelin/blob/master/README.md) to build from source. +You can configure Zeppelin with both environment variables in `conf/zeppelin-env.sh` and java properties in `conf/zeppelin-site.xml`. If both are defined, then the environment variable will be used priorly. + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
zepplin-env.shDefault ValueDescription
ZEPPELIN_PORT8080Zeppelin server port
ZEPPELIN_MEM-Xmx1024m -XX:MaxPermSize=512mJVM mem options
ZEPPELIN_INTP_MEMZEPPELIN_MEMJVM mem options for interpreter process
ZEPPELIN_JAVA_OPTSJVM Options
ZEPPELIN_ALLOWED_ORIGINS*Enables a way to specify a ',' separated list of allowed origins for rest and websockets.
i.e. http://localhost:8080
ZEPPELIN_SERVER_CONTEXT_PATH/The context path of the web application
ZEPPELIN_SSLfalse
ZEPPELIN_SSL_CLIENT_AUTHfalse
ZEPPELIN_SSL_KEYSTORE_PATHkeystore
ZEPPELIN_SSL_KEYSTORE_TYPEJKS
ZEPPELIN_SSL_KEYSTORE_PASSWORD
ZEPPELIN_SSL_KEY_MANAGER_PASSWORD
ZEPPELIN_SSL_TRUSTSTORE_PATH
ZEPPELIN_SSL_TRUSTSTORE_TYPE
ZEPPELIN_SSL_TRUSTSTORE_PASSWORD
ZEPPELIN_NOTEBOOK_HOMESCREENA notebook id displayed in homescreen
i.e. 2A94M5J1Z
ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDEfalseThis value can be "true" when you want to hide notebooks from Zeppelin homescreen.
ZEPPELIN_WAR_TEMPDIRwebappsJetty temporary directory location
ZEPPELIN_NOTEBOOK_DIRnotebookA directory path of Zeppelin notebook files
ZEPPELIN_NOTEBOOK_S3_BUCKETzeppelinS3 Bucket where Zeppelin notebook files will be saved
ZEPPELIN_NOTEBOOK_S3_USERuserA user name of S3 bucket
i.e. bucket/user/notebook/2A94M5J1Z/note.json
ZEPPELIN_NOTEBOOK_STORAGEorg.apache.zeppelin.notebook.repo.VFSNotebookRepoComma separated list of notebook storage
ZEPPELIN_INTERPRETERSorg.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,
org.apache.zeppelin.hive.HiveInterpreter
+ ... + 		Comma separated interpreter configurations [Class]
The first interpreter will be a default.
ZEPPELIN_INTERPRETER_DIRinterpreterZeppelin interpreter directory
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
zepplin-site.xmlDefault valueDescription
zeppelin.server.port8080Zeppelin server port
zeppelin.server.allowed.origins*Enables a way to specify a ',' separated list of allowed origins for rest and websockets.
i.e. http://localhost:8080
zeppelin.server.context.path/The context path of the web application
zeppelin.sslfalse
zeppelin.ssl.client.authfalse
zeppelin.ssl.keystore.pathkeystore
zeppelin.ssl.keystore.typeJKS
zeppelin.ssl.keystore.password
zeppelin.ssl.key.manager.password
zeppelin.ssl.truststore.path
zeppelin.ssl.truststore.type
zeppelin.ssl.truststore.password
zeppelin.notebook.homescreenA notebook id displayed in homescreen
i.e. 2A94M5J1Z
zeppelin.notebook.homescreen.hidefalseThis value can be "true" when you want to hide notebooks from Zeppelin homescreen.
zeppelin.war.tempdirwebappsJetty temporary directory location
zeppelin.notebook.dirnotebookA directory path of Zeppelin notebook files
zeppelin.notebook.s3.bucketzeppelinS3 Bucket where Zeppelin notebook files will be saved
zeppelin.notebook.s3.useruserA user name of S3 bucket
i.e. bucket/user/notebook/2A94M5J1Z/note.json
zeppelin.notebook.storageorg.apache.zeppelin.notebook.repo.VFSNotebookRepoComma separated list of notebook storage
zeppelin.interpretersorg.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,
org.apache.zeppelin.hive.HiveInterpreter
+ ... + 		Comma separated interpreter configurations [Class]
The first interpreter will be a default.
zeppelin.interpreter.dirinterpreterZeppelin interpreter directory
+
+
-## Configure +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. -Configuration can be done by both environment variable(conf/zeppelin-env.sh) and java properties(conf/zeppelin-site.xml). If both defined, environment vaiable is used. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
zepplin-env.shzepplin-site.xmlDefault valueDescription
ZEPPELIN_PORTzeppelin.server.port8080Zeppelin server port.
ZEPPELIN_MEMN/A-Xmx1024m -XX:MaxPermSize=512mJVM mem options
ZEPPELIN_INTP_MEMN/AZEPPELIN_MEMJVM mem options for interpreter process
ZEPPELIN_JAVA_OPTSN/AJVM Options
ZEPPELIN_ALLOWED_ORIGINSzeppelin.server.allowed.origins*Allows a way to specify a ',' separated list of allowed origins for rest and websockets. i.e. http://localhost:8080
ZEPPELIN_SERVER_CONTEXT_PATHzeppelin.server.context.path/Context Path of the Web Application
ZEPPELIN_SSLzeppelin.sslfalse
ZEPPELIN_SSL_CLIENT_AUTHzeppelin.ssl.client.authfalse
ZEPPELIN_SSL_KEYSTORE_PATHzeppelin.ssl.keystore.pathkeystore
ZEPPELIN_SSL_KEYSTORE_TYPEzeppelin.ssl.keystore.typeJKS
ZEPPELIN_SSL_KEYSTORE_PASSWORDzeppelin.ssl.keystore.password
ZEPPELIN_SSL_KEY_MANAGER_PASSWORDzeppelin.ssl.key.manager.password
ZEPPELIN_SSL_TRUSTSTORE_PATHzeppelin.ssl.truststore.path
ZEPPELIN_SSL_TRUSTSTORE_TYPEzeppelin.ssl.truststore.type
ZEPPELIN_SSL_TRUSTSTORE_PASSWORDzeppelin.ssl.truststore.password
ZEPPELIN_NOTEBOOK_HOMESCREENzeppelin.notebook.homescreenId of notebook to be displayed in homescreen ex) 2A94M5J1Z
ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDEzeppelin.notebook.homescreen.hidefalsehide homescreen notebook from list when this value set to "true"
ZEPPELIN_WAR_TEMPDIRzeppelin.war.tempdirwebappsThe location of jetty temporary directory.
ZEPPELIN_NOTEBOOK_DIRzeppelin.notebook.dirnotebookWhere notebook file is saved
ZEPPELIN_NOTEBOOK_S3_BUCKETzeppelin.notebook.s3.bucketzeppelinBucket where notebook saved
ZEPPELIN_NOTEBOOK_S3_USERzeppelin.notebook.s3.useruserUser in bucket where notebook saved. For example bucket/user/notebook/2A94M5J1Z/note.json
ZEPPELIN_NOTEBOOK_STORAGEzeppelin.notebook.storageorg.apache.zeppelin.notebook.repo.VFSNotebookRepoComma separated list of notebook storage
ZEPPELIN_INTERPRETERSzeppelin.interpretersorg.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,
org.apache.zeppelin.hive.HiveInterpreter
- ... - 		Comma separated interpreter configurations [Class]. First interpreter become a default
ZEPPELIN_INTERPRETER_DIRzeppelin.interpreter.dirinterpreterZeppelin interpreter directory
- -
-You'll also need to configure individual interpreter. Information can be found in 'Interpreter' section in this documentation. - -For example [Spark](../interpreter/spark.html). - -
-## Start/Stop +## Zeppelin Start / Stop #### Start Zeppelin ``` bin/zeppelin-daemon.sh start ``` -After successful start, visit http://localhost:8080 with your web browser. +After successful start, visit [http://localhost:8080](http://localhost:8080) with your web browser. #### Stop Zeppelin