zeppelin/docs/install/install.md
Mina Lee f0383c6995 [Zeppelin 537] Improve behavior of reloading notebooks from storage
### What is this PR for?
Improve behavior of reloading notebooks from storage

### What type of PR is it?
Improvement

### Is there a relevant Jira issue?
[ZEPPELIN-537](https://issues.apache.org/jira/browse/ZEPPELIN-537?jql=project%20%3D%20ZEPPELIN)

### How should this be tested?
1. Add new `notebookId/note.json` under `ZEPPELIN_HOME/notebook`
2. Click reload button next to 'Notebook'
3. Check if the new added note is loaded

### Screenshots (if appropriate)
![reload fig](https://cloud.githubusercontent.com/assets/8503346/12011889/283c8e9c-ac96-11e5-81f6-4cdb305020d3.gif)

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No

Author: Mina Lee <minalee@nflabs.com>

Closes #573 from minahlee/ZEPPELIN-537 and squashes the following commits:

64e1a28 [Mina Lee] Rework sync with secondary storage when reload notebooks  - Address @khalidhuseynov comment
5423e3c [Mina Lee] Revert "Sync with secondary storage when reload notebooks"
1f83f15 [Mina Lee] Modify test
b03cde2 [Mina Lee] Sync with secondary storage when reload notebooks
b26dabf [Mina Lee] Remove ZEPPELIN_NOTEBOOK_RELOAD_FROM_STORAGE env variable
3fc9ad0 [Mina Lee] Revert "ZEPPELIN-367 Sync with secondary storage when listing notebooks"
6a80304 [Mina Lee] Reload notebooks from repository with reload button click event
2016-01-03 07:54:38 -08:00

5.6 KiB

layout title description group
page Install Zeppelin install

{% include JB/setup %}

From binary package

Download latest binary package from Download.

Build from source

Check instructions in README 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.sh zepplin-site.xml Default value Description
ZEPPELIN_PORT zeppelin.server.port 8080 Zeppelin server port.
ZEPPELIN_MEM N/A -Xmx1024m -XX:MaxPermSize=512m JVM mem options
ZEPPELIN_INTP_MEM N/A ZEPPELIN_MEM JVM mem options for interpreter process
ZEPPELIN_JAVA_OPTS N/A JVM Options
ZEPPELIN_ALLOWED_ORIGINS zeppelin.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_PATH zeppelin.server.context.path / Context Path of the Web Application
ZEPPELIN_SSL zeppelin.ssl false
ZEPPELIN_SSL_CLIENT_AUTH zeppelin.ssl.client.auth false
ZEPPELIN_SSL_KEYSTORE_PATH zeppelin.ssl.keystore.path keystore
ZEPPELIN_SSL_KEYSTORE_TYPE zeppelin.ssl.keystore.type JKS
ZEPPELIN_SSL_KEYSTORE_PASSWORD zeppelin.ssl.keystore.password
ZEPPELIN_SSL_KEY_MANAGER_PASSWORD zeppelin.ssl.key.manager.password
ZEPPELIN_SSL_TRUSTSTORE_PATH zeppelin.ssl.truststore.path
ZEPPELIN_SSL_TRUSTSTORE_TYPE zeppelin.ssl.truststore.type
ZEPPELIN_SSL_TRUSTSTORE_PASSWORD zeppelin.ssl.truststore.password
ZEPPELIN_NOTEBOOK_HOMESCREEN zeppelin.notebook.homescreen Id of notebook to be displayed in homescreen ex) 2A94M5J1Z
ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE zeppelin.notebook.homescreen.hide false hide homescreen notebook from list when this value set to "true"
ZEPPELIN_WAR_TEMPDIR zeppelin.war.tempdir webapps The location of jetty temporary directory.
ZEPPELIN_NOTEBOOK_DIR zeppelin.notebook.dir notebook Where notebook file is saved
ZEPPELIN_NOTEBOOK_S3_BUCKET zeppelin.notebook.s3.bucket zeppelin Bucket where notebook saved
ZEPPELIN_NOTEBOOK_S3_USER zeppelin.notebook.s3.user user User in bucket where notebook saved. For example bucket/user/notebook/2A94M5J1Z/note.json
ZEPPELIN_NOTEBOOK_STORAGE zeppelin.notebook.storage org.apache.zeppelin.notebook.repo.VFSNotebookRepo Comma separated list of notebook storage
ZEPPELIN_INTERPRETERS zeppelin.interpreters 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]. First interpreter become a default
ZEPPELIN_INTERPRETER_DIR zeppelin.interpreter.dir interpreter Zeppelin interpreter directory

You'll also need to configure individual interpreter. Information can be found in 'Interpreter' section in this documentation.

For example Spark.


## Start/Stop #### Start Zeppelin
bin/zeppelin-daemon.sh start

After successful start, visit http://localhost:8080 with your web browser.

Stop Zeppelin

bin/zeppelin-daemon.sh stop