You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install/install.md
+55-51Lines changed: 55 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
layout: page
3
3
title: "Quick Start"
4
-
description: "This page will help you to get started and guide you through installation of Apache Zeppelin, running it in the command line and basic configuration options."
4
+
description: "This page will help you get started and will guide you through installing Apache Zeppelin, running it in the command line and configuring options."
5
5
group: install
6
6
---
7
7
<!--
@@ -20,14 +20,14 @@ limitations under the License.
20
20
{% include JB/setup %}
21
21
22
22
# Quick Start
23
-
Welcome to your first trial to explore Apache Zeppelin!
24
-
This page will help you to get started and here is the list of topics covered.
25
23
26
24
<divid="toc"></div>
27
25
26
+
Welcome to Apache Zeppelin! On this page are instructions to help you get started.
27
+
28
28
## Installation
29
29
30
-
Apache Zeppelin officially supports and is tested on next environments.
30
+
Apache Zeppelin officially supports and is tested on the following environments:
31
31
32
32
<tableclass="table-configuration">
33
33
<tr>
@@ -44,21 +44,21 @@ Apache Zeppelin officially supports and is tested on next environments.
44
44
</tr>
45
45
</table>
46
46
47
-
There are two options to install Apache Zeppelin on your machine. One is [downloading pre-built binary package](#downloading-binary-package) from the archive.
48
-
You can download not only the latest stable version but also the older one if you need.
49
-
The other option is [building from the source](#building-from-source).
50
-
Although it can be unstable somehow since it is on development status, you can explore newly added feature and change it as you want.
47
+
To install Apache Zeppelin, you have two options:
48
+
* You can [download pre-built binary packages](#downloading-binary-package) from the archive. This is usually easier than building from source, and you can download the latest stable version (or older versions, if necessary).
49
+
* You can also [build from source](#building-from-source). This gives you a development version of Zeppelin, which is more unstable but has new features.
51
50
52
51
### Downloading Binary Package
53
52
54
-
If you want to install Apache Zeppelin with a stable binary package, please visit [Apache Zeppelin download Page](http://zeppelin.apache.org/download.html).
53
+
Stable binary packages are available on the [Apache Zeppelin Download Page](http://zeppelin.apache.org/download.html). You can download a default package with all interpreters, or you can download the *net-install* package, which lets you choose which interpreters to install.
55
54
56
-
If you have downloaded `netinst` binary, [install additional interpreters](../manual/interpreterinstallation.html)before you start Zeppelin. Or simply run`./bin/install-interpreter.sh --all`.
55
+
If you downloaded the default package, just unpack it in a directory of your choice and you're ready to go. If you downloaded the *net-install* package, you should manually [install additional interpreters](../manual/interpreterinstallation.html)first. You can also install everything by running`./bin/install-interpreter.sh --all`.
57
56
58
-
After unpacking, jump to [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line) section.
57
+
After unpacking, jump to the [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line).
59
58
60
59
### Building from Source
61
-
If you want to build from the source, the software below needs to be installed on your system.
60
+
61
+
If you want to build from source, you must first install the following dependencies:
62
62
63
63
<tableclass="table-configuration">
64
64
<tr>
@@ -67,30 +67,31 @@ If you want to build from the source, the software below needs to be installed o
67
67
</tr>
68
68
<tr>
69
69
<td>Git</td>
70
-
<td></td>
70
+
<td>(Any Version)</td>
71
71
</tr>
72
72
<tr>
73
73
<td>Maven</td>
74
74
<td>3.1.x or higher</td>
75
75
</tr>
76
76
</table>
77
77
78
-
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.
78
+
If you haven't installed Git and Maven yet, check the [Before Build](https://github.com/apache/zeppelin/blob/master/README.md#before-build) section and follow the step by step instructions from there.
Each interpreters requires different build options. For the further information about options, please see [Build](https://github.com/apache/zeppelin#build) section.
88
+
Each interpreter requires different build options. For more information about build options, please see the[Build](https://github.com/apache/zeppelin#build) section.
For the further information about building with source, please see [README.md](https://github.com/apache/zeppelin/blob/master/README.md) in Zeppelin repository.
114
+
For further information about building from source, please see [README.md](https://github.com/apache/zeppelin/blob/master/README.md) in the Zeppelin repository.
115
+
116
+
## Starting Apache Zeppelin from the Command Line
117
+
#### Starting Apache Zeppelin
114
118
115
-
## Starting Apache Zeppelin with Command Line
116
-
#### Start Zeppelin
119
+
On all platforms except for Windows:
117
120
118
121
```
119
122
bin/zeppelin-daemon.sh start
120
123
```
121
124
122
-
If you are using Windows
125
+
If you are using Windows:
123
126
124
127
```
125
128
bin\zeppelin.cmd
126
129
```
127
130
128
-
After successful start, visit[http://localhost:8080](http://localhost:8080) with your web browser.
131
+
After Zeppelin has started successfully, go to[http://localhost:8080](http://localhost:8080) with your web browser.
129
132
130
-
#### Stop Zeppelin
133
+
#### Stopping Zeppelin
131
134
132
135
```
133
136
bin/zeppelin-daemon.sh stop
@@ -137,10 +140,10 @@ bin/zeppelin-daemon.sh stop
137
140
138
141
> **Note :** The below description was written based on Ubuntu Linux.
139
142
140
-
Apache Zeppelin can be autostarted as a service with an init script, such as services managed by**upstart**.
143
+
Apache Zeppelin can be auto-started as a service with an init script, using a service manager like**upstart**.
141
144
142
-
The following is an example of upstart script to be saved as `/etc/init/zeppelin.conf`
143
-
This also allows the service to be managed with commands such as
145
+
This is an example upstart script saved as `/etc/init/zeppelin.conf`
146
+
This allows the service to be managed with commands such as
144
147
145
148
```
146
149
sudo service zeppelin start
@@ -174,24 +177,25 @@ chdir /usr/share/zeppelin
174
177
exec bin/zeppelin-daemon.sh upstart
175
178
```
176
179
177
-
## What is the next?
178
-
Congratulation on your successful Apache Zeppelin installation! Here are two next steps you might need.
180
+
## Next Steps:
181
+
182
+
Congratulations, you have successfully installed Apache Zeppelin! Here are two next steps you might find useful:
179
183
180
-
#### If you are new to Apache Zeppelin
181
-
* For an in-depth overview of Apache Zeppelin UI, head to [Explore Apache Zeppelin UI](../quickstart/explorezeppelinui.html).
182
-
* After getting familiar with Apache Zeppelin UI, have fun with a short walk-through [Tutorial](../quickstart/tutorial.html) that uses Apache Spark backend.
183
-
* If you need more configuration setting for Apache Zeppelin, jump to the next section: [Apache Zeppelin Configuration](#apache-zeppelin-configuration).
184
+
#### If you are new to Apache Zeppelin...
185
+
* For an in-depth overview of the Apache Zeppelin UI, head to [Explore Apache Zeppelin UI](../quickstart/explorezeppelinui.html).
186
+
* After getting familiar with the Apache Zeppelin UI, have fun with a short walk-through [Tutorial](../quickstart/tutorial.html) that uses the Apache Spark backend.
187
+
* If you need more configuration for Apache Zeppelin, jump to the next section: [Apache Zeppelin Configuration](#apache-zeppelin-configuration).
184
188
185
-
#### If you need more information about Spark or JDBC interpreter setting
186
-
* Apache Zeppelin provides deep integration with [Apache Spark](http://spark.apache.org/). For the further informtation, see [Spark Interpreter for Apache Zeppelin](../interpreter/spark.html).
187
-
*Also, you can use generic JDBC connections in Apache Zeppelin. Go to [Generic JDBC Interpreter for Apache Zeppelin](../interpreter/jdbc.html).
189
+
#### If you need more information about Spark or JDBC interpreter settings...
190
+
* Apache Zeppelin provides deep integration with [Apache Spark](http://spark.apache.org/). For more informtation, see [Spark Interpreter for Apache Zeppelin](../interpreter/spark.html).
191
+
*You can also use generic JDBC connections in Apache Zeppelin. Go to [Generic JDBC Interpreter for Apache Zeppelin](../interpreter/jdbc.html).
188
192
189
-
#### If you are in multi-user environment
190
-
* You can set permissions for your notebooks and secure data resource in multi-user environment. Go to **More** -> **Security** section.
193
+
#### If you are in a multi-user environment...
194
+
* You can set permissions for your notebooks and secure data resource in a multi-user environment. Go to **More** -> **Security** section.
191
195
192
196
## Apache Zeppelin Configuration
193
197
194
-
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.
198
+
You can configure Apache Zeppelin with either**environment variables** in `conf/zeppelin-env.sh` (`conf\zeppelin-env.cmd` for Windows) or**Java properties** in `conf/zeppelin-site.xml`. If both are defined, then the **environment variables** will take priority.
195
199
196
200
<tableclass="table-configuration">
197
201
<tr>
@@ -228,19 +232,19 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
228
232
<td>ZEPPELIN_ALLOWED_ORIGINS</td>
229
233
<td>zeppelin.server.allowed.origins</td>
230
234
<td>*</td>
231
-
<td>Enables a way to specify a ',' separated list of allowed origins for rest and websockets. <br /> i.e. http://localhost:8080 </td>
235
+
<td>Enables a way to specify a ',' separated list of allowed origins for REST and websockets. <br /> i.e. http://localhost:8080 </td>
232
236
</tr>
233
237
<tr>
234
238
<td>N/A</td>
235
239
<td>zeppelin.anonymous.allowed</td>
236
240
<td>true</td>
237
-
<td>Anonymous user is allowed by default.</td>
241
+
<td>The anonymous user is allowed by default.</td>
238
242
</tr>
239
243
<tr>
240
244
<td>ZEPPELIN_SERVER_CONTEXT_PATH</td>
241
245
<td>zeppelin.server.context.path</td>
242
246
<td>/</td>
243
-
<td>A context path of the web application</td>
247
+
<td>Context path of the web application</td>
244
248
</tr>
245
249
<tr>
246
250
<td>ZEPPELIN_SSL</td>
@@ -300,19 +304,19 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
300
304
<td>ZEPPELIN_NOTEBOOK_HOMESCREEN</td>
301
305
<td>zeppelin.notebook.homescreen</td>
302
306
<td></td>
303
-
<td>A notebook id displayed in Apache Zeppelin homescreen <br />i.e. 2A94M5J1Z</td>
307
+
<td>Display notebook IDs on the Apache Zeppelin homescreen <br />i.e. 2A94M5J1Z</td>
304
308
</tr>
305
309
<tr>
306
310
<td>ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE</td>
307
311
<td>zeppelin.notebook.homescreen.hide</td>
308
312
<td>false</td>
309
-
<td>This value can be "true" when to hide the notebook id set by <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> on the Apache Zeppelin homescreen. <br />For the further information, please read <a href="../manual/notebookashomepage.html">Customize your Zeppelin homepage</a>.</td>
313
+
<td>Hide the notebook ID set by <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> on the Apache Zeppelin homescreen. <br />For the further information, please read <a href="../manual/notebookashomepage.html">Customize your Zeppelin homepage</a>.</td>
310
314
</tr>
311
315
<tr>
312
316
<td>ZEPPELIN_WAR_TEMPDIR</td>
313
317
<td>zeppelin.war.tempdir</td>
314
318
<td>webapps</td>
315
-
<td>A location of jetty temporary directory</td>
319
+
<td>Location of the jetty temporary directory</td>
316
320
</tr>
317
321
<tr>
318
322
<td>ZEPPELIN_NOTEBOOK_DIR</td>
@@ -330,7 +334,7 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
330
334
<td>ZEPPELIN_NOTEBOOK_S3_USER</td>
331
335
<td>zeppelin.notebook.s3.user</td>
332
336
<td>user</td>
333
-
<td>A user name of S3 bucket<br />i.e. <code>bucket/user/notebook/2A94M5J1Z/note.json</code></td>
337
+
<td>User name of an S3 bucket<br />i.e. <code>bucket/user/notebook/2A94M5J1Z/note.json</code></td>
334
338
</tr>
335
339
<tr>
336
340
<td>ZEPPELIN_NOTEBOOK_S3_ENDPOINT</td>
@@ -360,25 +364,25 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
360
364
<td>ZEPPELIN_NOTEBOOK_AZURE_SHARE</td>
361
365
<td>zeppelin.notebook.azure.share</td>
362
366
<td>zeppelin</td>
363
-
<td>Share where the notebook files will be saved</td>
367
+
<td>Azure Share where the notebook files will be saved</td>
364
368
</tr>
365
369
<tr>
366
370
<td>ZEPPELIN_NOTEBOOK_AZURE_USER</td>
367
371
<td>zeppelin.notebook.azure.user</td>
368
372
<td>user</td>
369
-
<td>An optional user name of Azure file share<br />i.e. <code>share/user/notebook/2A94M5J1Z/note.json</code></td>
373
+
<td>Optional user name of an Azure file share<br />i.e. <code>share/user/notebook/2A94M5J1Z/note.json</code></td>
0 commit comments