From 17ea00eacab9948d596947f04f872eaa84ecf65d Mon Sep 17 00:00:00 2001 From: Ryu Ah young Date: Fri, 29 Jan 2016 14:37:45 +0900 Subject: [PATCH 1/7] Fix dead link and add table tab to Zeppelin Configuration section --- docs/install/install.md | 460 ++++++++++++++++++++++++---------------- 1 file changed, 280 insertions(+), 180 deletions(-) diff --git a/docs/install/install.md b/docs/install/install.md index 493a96d96a4..9f41fe6b4c3 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -21,191 +21,291 @@ limitations under the License. -## From binary package - - Download latest binary package from [Download](../download.html). - - -## Build from source - - Check instructions in [README](https://github.com/apache/incubator-zeppelin/blob/master/README.md) to build from source. - - - -## Configure - -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 Installation +Welcome to your first trial to explore Zeppelin ! + +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). + + +## Zeppelin Configuration + +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
+
+
+ +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. + +## 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 From ace7f1efabefcbef3292dbb9e636cc378642742e Mon Sep 17 00:00:00 2001 From: Ryu Ah young Date: Fri, 29 Jan 2016 14:41:03 +0900 Subject: [PATCH 2/7] Fix a dead link and add a table tab to Zeppelin Configuration section --- docs/install/install.md | 462 ++++++++++++++++++++++++---------------- 1 file changed, 281 insertions(+), 181 deletions(-) diff --git a/docs/install/install.md b/docs/install/install.md index 493a96d96a4..15a20f6097f 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 - - Download latest binary package from [Download](../download.html). - - -## Build from source - - Check instructions in [README](https://github.com/apache/incubator-zeppelin/blob/master/README.md) to build from source. - - - -## Configure - -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 Installation +Welcome to your first trial to explore Zeppelin ! + +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). + + +## Zeppelin Configuration + +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
+
+
+ +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. + +## 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 From 8ea5a990d3f7e3562dfa5704ce996f70b5f24795 Mon Sep 17 00:00:00 2001 From: Ryu Ah young Date: Sun, 31 Jan 2016 19:07:47 +0900 Subject: [PATCH 3/7] ZEPPELIN-638: Change the configuration table --- docs/install/install.md | 411 +++++++++++++++------------------------- 1 file changed, 155 insertions(+), 256 deletions(-) diff --git a/docs/install/install.md b/docs/install/install.md index 15a20f6097f..eceb30e3ab5 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -39,262 +39,161 @@ You can also build Zeppelin from the source. Please check instructions of `READM 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
-
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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*Enables 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/A 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.homescreenA notebook id displayed in Zeppelin homescreen
i.e. 2A94M5J1Z
ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDEzeppelin.notebook.homescreen.hidefalseThis value can be "true" when you want to hide notebooks from Zeppelin homescreen.
ZEPPELIN_WAR_TEMPDIRzeppelin.war.tempdirwebappsA location of jetty temporary directory
ZEPPELIN_NOTEBOOK_DIRzeppelin.notebook.dirnotebookA directory path of Zeppelin notebook files
ZEPPELIN_NOTEBOOK_S3_BUCKETzeppelin.notebook.s3.bucketzeppelinS3 Bucket where Zeppelin notebook files will be saved
ZEPPELIN_NOTEBOOK_S3_USERzeppelin.notebook.s3.useruserA user name of S3 bucket
i.e. 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]
The first interpreter will be a default value.
ZEPPELIN_INTERPRETER_DIRzeppelin.interpreter.dirinterpreterZeppelin interpreter directory
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. From a4e68160996b5411095fcab3ce935a8788ea4e55 Mon Sep 17 00:00:00 2001 From: Ryu Ah young Date: Tue, 2 Feb 2016 19:04:53 +0900 Subject: [PATCH 4/7] ZEPPELIN-638: Fix some sentences for a clarifying explanation --- docs/install/install.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/install/install.md b/docs/install/install.md index eceb30e3ab5..42e8bc26321 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -30,9 +30,9 @@ In this documentation, we will guide you how you can install Zeppelin from **Bin 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 +### 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). +You can also build Zeppelin from the source. Please check instructions in `README.md` in [Zeppelin github](https://github.com/apache/incubator-zeppelin/blob/master/README.md). ## Zeppelin Configuration @@ -146,7 +146,7 @@ You can configure Zeppelin with both environment variables in `conf/zeppelin-env ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE zeppelin.notebook.homescreen.hide false - This value can be "true" when you want to hide notebooks from Zeppelin homescreen. + This 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](../manual/notebookashomepage.html). ZEPPELIN_WAR_TEMPDIR @@ -158,7 +158,7 @@ You can configure Zeppelin with both environment variables in `conf/zeppelin-env ZEPPELIN_NOTEBOOK_DIR zeppelin.notebook.dir notebook - A directory path of Zeppelin notebook files + The root directory where Zeppelin notebook directories are saved ZEPPELIN_NOTEBOOK_S3_BUCKET @@ -185,7 +185,7 @@ You can configure Zeppelin with both environment variables in `conf/zeppelin-env org.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 value. + 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. ZEPPELIN_INTERPRETER_DIR @@ -211,5 +211,3 @@ After successful start, visit [http://localhost:8080](http://localhost:8080) wit ``` bin/zeppelin-daemon.sh stop ``` - - From 39da527e9a4e26cac0f019ab53440b6c0c3a2bc9 Mon Sep 17 00:00:00 2001 From: Ryu Ah young Date: Tue, 2 Feb 2016 19:11:45 +0900 Subject: [PATCH 5/7] ZEPPELIN-638: Fix hyperlink --- docs/install/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/install.md b/docs/install/install.md index 42e8bc26321..dd008fc37a3 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -146,7 +146,7 @@ You can configure Zeppelin with both environment variables in `conf/zeppelin-env ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE zeppelin.notebook.homescreen.hide false - This 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](../manual/notebookashomepage.html). + This 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. ZEPPELIN_WAR_TEMPDIR From 686559fde7e958481777ab16f765c8e5f24ecdc6 Mon Sep 17 00:00:00 2001 From: Ryu Ah young Date: Wed, 3 Feb 2016 11:00:30 +0900 Subject: [PATCH 6/7] ZEPPELIN-638: Fix some sentences --- docs/install/install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/install/install.md b/docs/install/install.md index dd008fc37a3..074cb3a0a45 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -24,7 +24,7 @@ limitations under the License. ## Zeppelin Installation Welcome to your first trial to explore Zeppelin ! -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. +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** section below. ### Install with Binary Package @@ -37,7 +37,7 @@ You can also build Zeppelin from the source. Please check instructions in `READM ## Zeppelin Configuration -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. +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. From ec469e70fb2bece917fed353ab1f3c260d5a03c8 Mon Sep 17 00:00:00 2001 From: Ryu Ah young Date: Thu, 4 Feb 2016 10:38:47 +0900 Subject: [PATCH 7/7] ZEPPELIN-638: Modify 'environment variable' -> 'environment variables' --- docs/install/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/install.md b/docs/install/install.md index 074cb3a0a45..8afc244bc0d 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -37,7 +37,7 @@ You can also build Zeppelin from the source. Please check instructions in `READM ## Zeppelin Configuration -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. +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 variables** will be used priorly.