Elgato_dark/zeppelin
1
0
Fork 0
mirror of https://github.com/apache/zeppelin synced 2026-05-24 09:38:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

[ZEPPELIN-3092] Add documentation about GitHub integration

Browse source
This commit is contained in:
Mohamed Magdy 2017-12-08 18:40:40 +01:00
parent 843e42a273
commit 2b093b2056
2 changed files with 62 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/setup/operation/configuration.md
View file

@ -329,6 +329,30 @@ If both are defined, then the **environment variables** will take priority.
<td>false</td>
<td>Enable directory listings on server.</td>
</tr>
<tr>
<td><h6 class="properties">ZEPPELIN_NOTEBOOK_GIT_REMOTE_URL</h6></td>
<td><h6 class="properties">zeppelin.notebook.git.remote.url</h6></td>
<td></td>
<td>GitHub's repository URL. It could be either the HTTP URL or the SSH URL. For example git@github.com:apache/zeppelin.git</td>
</tr>
<tr>
<td><h6 class="properties">ZEPPELIN_NOTEBOOK_GIT_REMOTE_USERNAME</h6></td>
<td><h6 class="properties">zeppelin.notebook.git.remote.username</h6></td>
<td>token</td>
<td>GitHub username. By default it is `token` to use GitHub's API</td>
</tr>
<tr>
<td><h6 class="properties">ZEPPELIN_NOTEBOOK_GIT_REMOTE_ACCESS_TOKEN</h6></td>
<td><h6 class="properties">zeppelin.notebook.git.remote.access-token</h6></td>
<td>token</td>
<td>GitHub access token to use GitHub's API. If username/password combination is used and not GitHub API, then this value is the password</td>
</tr>
<tr>
<td><h6 class="properties">ZEPPELIN_NOTEBOOK_GIT_REMOTE_ORIGIN</h6></td>
<td><h6 class="properties">zeppelin.notebook.git.remote.origin</h6></td>
<td>token</td>
<td>GitHub remote name. Default is `origin`</td>
</tr>
</table>
@ -431,7 +455,7 @@ The following properties needs to be updated in the `zeppelin-site.xml` in order
### Storing user credentials
In order to avoid having to re-enter credentials every time you restart/redeploy Zeppelin, you can store the user credentials. Zeppelin supports this via the ZEPPELIN_CREDENTIALS_PERSIST configuration.
In order to avoid having to re-enter credentials every?time you restart/redeploy Zeppelin, you can store the user credentials. Zeppelin supports this via the ZEPPELIN_CREDENTIALS_PERSIST configuration.
Please notice that passwords will be stored in *plain text* by default. To encrypt the passwords, use the ZEPPELIN_CREDENTIALS_ENCRYPT_KEY config variable. This will encrypt passwords using the AES-128 algorithm.
@ -473,5 +497,9 @@ update your configuration with the obfuscated password :
</property>
```
### Create GitHub Access Token
When using GitHub to track notebooks, one can use GitHub's API for authentication. To create an access token, please use the following link https://github.com/settings/tokens.
The value of the access token generated is set in the `zeppelin.notebook.git.remote.access-token` property.
**Note:** After updating these configurations, Zeppelin server needs to be restarted.

33
docs/setup/storage/storage.md
View file

@ -34,6 +34,7 @@ There are few notebook storage systems available for a use out of the box:
* storage using Amazon S3 service - `S3NotebookRepo`
* storage using Azure service - `AzureNotebookRepo`
* storage using MongoDB - `MongoNotebookRepo`
* storage using GitHub - `GitHubNotebookRepo`
Multiple storage systems can be used at the same time by providing a comma-separated list of the class-names in the configuration.
By default, only first two of them will be automatically kept in sync by Zeppelin.
@ -361,3 +362,35 @@ export ZEPPELIN_NOTEBOOK_MONGO_AUTOIMPORT=true
#### Import your local notes automatically
By setting `ZEPPELIN_NOTEBOOK_MONGO_AUTOIMPORT` as `true` (default `false`), you can import your local notes automatically when Zeppelin daemon starts up. This feature is for easy migration from local file system storage to MongoDB storage. A note with ID already existing in the collection will not be imported.
## Notebook Storage in GitHub
To enable GitHub tracking, uncomment the following properties in `zeppelin-site.xml`
```sh
<property>
<name>zeppelin.notebook.git.remote.url</name>
<value>git@github.com:mohamagdy/zeppelin-notebooks.git</value>
<description>remote Git repository URL</description>
</property>
<property>
<name>zeppelin.notebook.git.remote.username</name>
<value>token</value>
<description>remote Git repository username</description>
</property>
<property>
<name>zeppelin.notebook.git.remote.access-token</name>
<value>1b29e853bc73b90af0d280233101f91b9105d7cb</value>
<description>remote Git repository password</description>
</property>
<property>
<name>zeppelin.notebook.git.remote.remote</name>
<value>origin</value>
<description>Git repository remote</description>
</property>
```
The access token could be obtained by following the steps on this link https://github.com/settings/tokens.