mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
4b6d3e5574
### What is this PR for? Improving documentation page. Please check *TODO* and *Screenshots* sections for detail. The motivation is described in [the JIRA ticket](https://issues.apache.org/jira/browse/ZEPPELIN-2583) and discussion is ongoing on the mailing list. ### What type of PR is it? [Improvement | Documentation] ### Todos * [x] - improved the navbar style * [x] - improved the main page * [x] - re-organized content structure * [x] - added tutorial pages: `spark_with_zeppelin.md`, `python_with_zeppelin.md`, `sql_with_zeppelin.md` for overview * [x] - added `multi_user_support.md` page to provide overview * [x] - added the empty `interpreter_binding_mode` page. This will be handed in the different issue: [ZEPPELIN-2582](https://issues.apache.org/jira/browse/ZEPPELIN-2582) * [x] - added the empty `trouble_shooting` page. This can be filled in the following PRs. * [x] - added the empty `useful_developer_tools` page. This can be filled in the following PRs. ### What is the Jira issue? [ZEPPELIN-2596](https://issues.apache.org/jira/browse/ZEPPELIN-2596) ### How should this be tested? 1. checkout 2. `cd docs` 3. `bundle install` (make sure that you have ruby 2.1.0+ and bundle) 4. `bundle exec jekyll serve --watch` 5. open `localhost:4000` ### Screenshots (if appropriate) #### better navbar: before  #### better navbar: after  #### improved main page: before  #### improved main page: after  #### organized content structure: before  #### organized content structure: after  ### Questions: * Does the licenses files need update? - NO * Is there breaking changes for older versions? - NO * Does this needs documentation? - related with docs Author: 1ambda <1amb4a@gmail.com> Closes #2371 from 1ambda/updating-version-doc and squashes the following commits:eb02fa967[1ambda] fix: navbar focus color applies after folding026379ed6[1ambda] fix: Remove docs/.listen_testa7dd4737b[1ambda] fix: sora's comment 1.218c5058f7[1ambda] fix: resolve description in python_with_zeppelin.mdd3ad67c73[1ambda] fix: sora's comment 4d133dbbcc[1ambda] fix: resolve sora's comment 3513c6ff2c[1ambda] fix: resolve sora's comment 1.14c2946928[1ambda] fix: resovle sora's comment 21c3946ac6[1ambda] fix: sora's comment 14d6e4267f[1ambda] fix: Resolve sola's comment 3d0524cafe[1ambda] fix: Set less shadow for nav5f1f998ba[1ambda] docs: Add useful_develop_tools.md9dfd62c74[1ambda] fix: Typo in installation.md30f7d7e06[1ambda] fix: Typo in helium ctrld6877e792[1ambda] docs: Add python_with_zeppelin.md7027e96c0[1ambda] docs: Improve python conda, docker doc stylee55b50a9d[1ambda] fix: Invalid URLs75ddeeaff[1ambda] docs: replace URIs in interpreter5b43993a4[1ambda] docs: Add sql_with_zeppelin053794e84[1ambda] docs: Add spark_with_zeppelin.mdd4d88b9c7[1ambda] docs: Improve proxy docb46cdd126[1ambda] docs: Add empty interpreter_binding_mode.md06fcb239e[1ambda] docs: Add empty personalized_mode.md4991cf0a7[1ambda] docs: Update upgrading.md53142b7a0[1ambda] fix: Simplify install.md8a5c1e721[1ambda] docs: Add multi_user_support.md34095775e[1ambda] fix: Increase font size to 15pxa03b04b33[1ambda] fix: Remove sample text from trouble_shooting.md199842590[1ambda] fix: Remove docker doc link66a2a7d26[1ambda] docs: Improve impersonation page0a6e3fc1d[1ambda] docs: Improve install docccd999ed5[1ambda] docs: Improve helium docf8d742d08[1ambda] fix: an invalid link in navbarb7aa5f884[1ambda] fix: URLs in development61a175d94[1ambda] docs: Update install.md4c56de5c4[1ambda] fix: URLs in setup0b1d63513[1ambda] fix: URLs in quickstart28970a4fe[1ambda] feat: Add docs/usage735946bca[1ambda] feat: rename /quickstartb351cf237[1ambda] fix: Add missing linksb70770b4f[1ambda] feat: Change URLs in nav, index94e80aef6[1ambda] fix: doens't display navbar version in small6e0cab110[1ambda] feat: Update doc section namesb9ce256ff[1ambda] feat: Hide version in navbar when mdf8bab52be[1ambda] fix: Better image display in index.mdeeb37d5b5[1ambda] fix: Add RL padding for mobile browserceb60b5ee[1ambda] feat: Style collapsed nav for mobile browser4ebafb4b6[1ambda] commit
142 lines
4.4 KiB
Markdown
142 lines
4.4 KiB
Markdown
---
|
|
layout: page
|
|
title: "Install"
|
|
description: "This page will help you get started and will guide you through installing Apache Zeppelin and running it in the command line."
|
|
group: quickstart
|
|
---
|
|
<!--
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
-->
|
|
{% include JB/setup %}
|
|
|
|
# Install
|
|
|
|
<div id="toc"></div>
|
|
|
|
Welcome to Apache Zeppelin! On this page are instructions to help you get started.
|
|
|
|
## Requirements
|
|
|
|
Apache Zeppelin officially supports and is tested on the following environments:
|
|
|
|
<table class="table-configuration">
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Value</th>
|
|
</tr>
|
|
<tr>
|
|
<td>Oracle JDK</td>
|
|
<td>1.7 <br /> (set <code>JAVA_HOME</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>OS</td>
|
|
<td>Mac OSX <br /> Ubuntu 14.X <br /> CentOS 6.X <br /> Windows 7 Pro SP1</td>
|
|
</tr>
|
|
</table>
|
|
|
|
### Downloading Binary Package
|
|
|
|
Two binary packages are available on the [download page](http://zeppelin.apache.org/download.html). Only difference between these two binaries is interpreters are included in the package file.
|
|
|
|
- **all interpreter package**: unpack it in a directory of your choice and you're ready to go.
|
|
- **net-install interpreter package**: unpack and follow [install additional interpreters](../usage/interpreter/installation.html) to install interpreters. If you're unsure, just run `./bin/install-interpreter.sh --all` and install all interpreters.
|
|
|
|
### Building Zeppelin from source
|
|
|
|
follow the instructions [How to Build](../setup/basics/how_to_build.html), If you want to build from source instead of using binary package.
|
|
|
|
## Starting Apache Zeppelin
|
|
|
|
#### Starting Apache Zeppelin from the Command Line
|
|
|
|
On all unix like platforms:
|
|
|
|
```
|
|
bin/zeppelin-daemon.sh start
|
|
```
|
|
|
|
If you are on Windows:
|
|
|
|
```
|
|
bin\zeppelin.cmd
|
|
```
|
|
|
|
After Zeppelin has started successfully, go to [http://localhost:8080](http://localhost:8080) with your web browser.
|
|
|
|
#### Stopping Zeppelin
|
|
|
|
```
|
|
bin/zeppelin-daemon.sh stop
|
|
```
|
|
|
|
## Start Apache Zeppelin with a service manager
|
|
|
|
> **Note :** The below description was written based on Ubuntu.
|
|
|
|
Apache Zeppelin can be auto-started as a service with an init script, using a service manager like **upstart**.
|
|
|
|
This is an example upstart script saved as `/etc/init/zeppelin.conf`
|
|
This allows the service to be managed with commands such as
|
|
|
|
```
|
|
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.
|
|
|
|
```
|
|
bin/zeppelin-daemon.sh upstart
|
|
```
|
|
|
|
**zeppelin.conf**
|
|
|
|
```
|
|
description "zeppelin"
|
|
|
|
start on (local-filesystems and net-device-up IFACE!=lo)
|
|
stop on shutdown
|
|
|
|
# Respawn the process on unexpected termination
|
|
respawn
|
|
|
|
# respawn the job up to 7 times within a 5 second period.
|
|
# If the job exceeds these values, it will be stopped and marked as failed.
|
|
respawn limit 7 5
|
|
|
|
# zeppelin was installed in /usr/share/zeppelin in this example
|
|
chdir /usr/share/zeppelin
|
|
exec bin/zeppelin-daemon.sh upstart
|
|
```
|
|
|
|
|
|
## Next Steps
|
|
|
|
Congratulations, you have successfully installed Apache Zeppelin! Here are few steps you might find useful:
|
|
|
|
#### New to Apache Zeppelin...
|
|
* For an in-depth overview, head to [Explore Zeppelin UI](../quickstart/explore_ui.html).
|
|
* And then, try run [Tutorial Notebook](http://localhost:8080/#/notebook/2A94M5J1Z) in your Zeppelin.
|
|
* And see how to change [configurations](../setup/operation/configuration.html) like port number, etc.
|
|
|
|
#### Spark, Python, SQL, and more
|
|
* [Spark support in Zeppelin](./spark_with_zeppelin.html), to know more about deep integration with [Apache Spark](http://spark.apache.org/).
|
|
* [SQL support in Zeppelin](./sql_with_zeppelin.html) for SQL support
|
|
* [Python support in Zeppelin](./python_with_zeppelin.html), for Matplotlib, Pandas, Conda/Docker integration.
|
|
* [All Available Interpreters](../#available-interpreters)
|
|
|
|
#### Multi-user support ...
|
|
* Check [Multi-user support](../setup/basics/multi_user_support.html)
|
|
|
|
|