You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by pr...@apache.org on 2016/05/25 05:56:45 UTC
incubator-zeppelin git commit: Update/shiro docs
Repository: incubator-zeppelin
Updated Branches:
refs/heads/master 2c1693ea4 -> aff2755eb
Update/shiro docs
### What is this PR for?
Currently, Zeppelin has two authentication docs. One is [**Authentication**](https://zeppelin.incubator.apache.org/docs/0.6.0-incubating-SNAPSHOT/security/authentication.html) and the other is [**Shiro Authentication**](https://zeppelin.incubator.apache.org/docs/0.6.0-incubating-SNAPSHOT/manual/shiroauthentication.html). As a user, it's little bit confused. So I changed the category of `shiroauthentication.md` file from `manual` to `security` and also changed the name of `Authentication` to `Authentication for NGINX`. Please see the below screenshot images :)
### What type of PR is it?
Improvement
### Todos
* [x] - Add `conf/shiro.ini` file to `.gitignore`
* [x] - Update `zeppelin-login.png` screenshot image file in `shiroauthentication.md`
* [x] - Change the category of `shiroauthentication.md` file from `manual` -> `security`
* [x] - Change `Authentication` -> `Authentication for NGINX`
### What is the Jira issue?
### How should this be tested?
### Screenshots (if appropriate)
1. Updating zeppelin-login.png
- before
- after
<img width="1272" alt="zeppelin-login" src="https://cloud.githubusercontent.com/assets/10060731/15422244/812541e6-1eb2-11e6-89bc-ed635bc9aaa8.png">
2. Changing the category of **Shiro Authentication** & Changing **Authentication** -> **Authentication for NGINX**
- before
- after
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
Author: AhyoungRyu <fb...@hanmail.net>
Closes #907 from AhyoungRyu/update/shiroDocs and squashes the following commits:
95d37ab [AhyoungRyu] Change title Authentication -> Authentication for NGINX
d290937 [AhyoungRyu] Change Shiro Authentication docs category
749ce8c [AhyoungRyu] Change shiroauthentication.md location
20b8ae9 [AhyoungRyu] Update login screenshot image in shiroauthentication.md
122afc2 [AhyoungRyu] Add conf/shiro.ini file to .gitignore
Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/aff2755e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/aff2755e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/aff2755e
Branch: refs/heads/master
Commit: aff2755eb779663bde2a09e14a0e69ef5999f45c
Parents: 2c1693e
Author: AhyoungRyu <fb...@hanmail.net>
Authored: Fri May 20 17:34:01 2016 +0900
Committer: Prabhjyot Singh <pr...@gmail.com>
Committed: Wed May 25 11:26:33 2016 +0530
----------------------------------------------------------------------
.gitignore | 1 +
docs/_includes/themes/zeppelin/_navigation.html | 6 +-
.../zeppelin/img/docs-img/zeppelin-login.png | Bin 41310 -> 251053 bytes
docs/manual/shiroauthentication.md | 72 -------------------
docs/security/authentication.md | 6 +-
docs/security/shiroauthentication.md | 72 +++++++++++++++++++
6 files changed, 78 insertions(+), 79 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/aff2755e/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index eeb4d3b..5328914 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,6 +25,7 @@ conf/keystore
conf/truststore
conf/interpreter.json
conf/notebook-authorization.json
+conf/shiro.ini
# other generated files
spark/dependency-reduced-pom.xml
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/aff2755e/docs/_includes/themes/zeppelin/_navigation.html
----------------------------------------------------------------------
diff --git a/docs/_includes/themes/zeppelin/_navigation.html b/docs/_includes/themes/zeppelin/_navigation.html
index 1884a23..9969cda 100644
--- a/docs/_includes/themes/zeppelin/_navigation.html
+++ b/docs/_includes/themes/zeppelin/_navigation.html
@@ -94,7 +94,8 @@
<li role="separator" class="divider"></li>
<!-- li><span><b>Security</b><span></li -->
<li><a href="{{BASE_PATH}}/security/overview.html">Security Overview</a></li>
- <li><a href="{{BASE_PATH}}/security/authentication.html">Authentication</a></li>
+ <li><a href="{{BASE_PATH}}/security/authentication.html">Authentication for NGINX</a></li>
+ <li><a href="{{BASE_PATH}}/security/shiroauthentication.html">Shiro Authentication</a></li>
<li><a href="{{BASE_PATH}}/security/notebook_authorization.html">Notebook Authorization</a></li>
<li><a href="{{BASE_PATH}}/security/interpreter_authorization.html">Interpreter Authorization</a></li>
<li role="separator" class="divider"></li>
@@ -102,9 +103,6 @@
<li><a href="{{BASE_PATH}}/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
<li><a href="{{BASE_PATH}}/development/howtocontribute.html">How to contribute (code)</a></li>
<li><a href="{{BASE_PATH}}/development/howtocontributewebsite.html">How to contribute (website)</a></li>
- <li role="separator" class="divider"></li>
- <!-- li><span><b>Shiro Security</b><span></li -->
- <li><a href="{{BASE_PATH}}/manual/shiroauthentication.html">Shiro Authentication</a></li>
</ul>
</li>
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/aff2755e/docs/assets/themes/zeppelin/img/docs-img/zeppelin-login.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/zeppelin-login.png b/docs/assets/themes/zeppelin/img/docs-img/zeppelin-login.png
index 522630f..b379c81 100644
Binary files a/docs/assets/themes/zeppelin/img/docs-img/zeppelin-login.png and b/docs/assets/themes/zeppelin/img/docs-img/zeppelin-login.png differ
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/aff2755e/docs/manual/shiroauthentication.md
----------------------------------------------------------------------
diff --git a/docs/manual/shiroauthentication.md b/docs/manual/shiroauthentication.md
deleted file mode 100644
index 2699130..0000000
--- a/docs/manual/shiroauthentication.md
+++ /dev/null
@@ -1,72 +0,0 @@
----
-layout: page
-title: "Shiro Security for Apache Zeppelin"
-description: ""
-group: manual
----
-<!--
-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 %}
-
-# Shiro authentication for Apache Zeppelin
-[Apache Shiro](http://shiro.apache.org/) is a powerful and easy-to-use Java security framework that performs authentication, authorization, cryptography, and session management. In this documentation, we will explain step by step how Shiro works for Zeppelin notebook authentication.
-
-When you connect to Apache Zeppelin, you will be asked to enter your credentials. Once you logged in, then you have access to all notes including other user's notes.
-
-## Security Setup
-You can setup **Zeppelin notebook authentication** in some simple steps.
-
-####1. Secure the HTTP channel
-To secure the HTTP channel, you have to change both **anon** and **authcBasic** settings in `conf/shiro.ini`. In here, **anon** means "the access is anonymous" and **authcBasic** means "basic auth security".
-
-The default status of them is
-
-```
-/** = anon
-#/** = authcBasic
-```
-Deactivate the line "/** = anon" and activate the line "/** = authcBasic" in `conf/shiro.ini` file.
-
-```
-#/** = anon
-/** = authcBasic
-```
-
-For the further information about `shiro.ini` file format, please refer to [Shiro Configuration](http://shiro.apache.org/configuration.html#Configuration-INISections).
-
-####2. Secure the Websocket channel
-Set to property **zeppelin.anonymous.allowed** to **false** in `conf/zeppelin-site.xml`. If you don't have this file yet, just copy `conf/zeppelin-site.xml.template` to `conf/zeppelin-site.xml`.
-
-####3. Start Zeppelin
-
-```
-bin/zeppelin-daemon.sh start (or restart)
-```
-
-Then you can browse Zeppelin at [http://localhost:8080](http://localhost:8080).
-
-####4. Login
-Finally, you can login using one of the below **username/password** combinations.
-
-<center><img src="../assets/themes/zeppelin/img/docs-img/zeppelin-login.png" width="40%" height="40%"></center>
-
-```
-admin = password1
-user1 = password2
-user2 = password3
-```
-
-Those combinations are defined in the `conf/shiro.ini` file.
-
-> **NOTE :** This documentation is originally from [SECURITY-README.md](https://github.com/apache/incubator-zeppelin/blob/master/SECURITY-README.md).
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/aff2755e/docs/security/authentication.md
----------------------------------------------------------------------
diff --git a/docs/security/authentication.md b/docs/security/authentication.md
index 9d48c58..f73ccf7 100644
--- a/docs/security/authentication.md
+++ b/docs/security/authentication.md
@@ -1,7 +1,7 @@
---
layout: page
-title: "Authentication"
-description: "Authentication"
+title: "Authentication for NGINX"
+description: "Authentication for NGINX"
group: security
---
<!--
@@ -17,7 +17,7 @@ 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.
-->
-# Authentication
+# Authentication for NGINX
Authentication is company-specific.
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/aff2755e/docs/security/shiroauthentication.md
----------------------------------------------------------------------
diff --git a/docs/security/shiroauthentication.md b/docs/security/shiroauthentication.md
new file mode 100644
index 0000000..05918e3
--- /dev/null
+++ b/docs/security/shiroauthentication.md
@@ -0,0 +1,72 @@
+---
+layout: page
+title: "Shiro Security for Apache Zeppelin"
+description: ""
+group: security
+---
+<!--
+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 %}
+
+# Shiro authentication for Apache Zeppelin
+[Apache Shiro](http://shiro.apache.org/) is a powerful and easy-to-use Java security framework that performs authentication, authorization, cryptography, and session management. In this documentation, we will explain step by step how Shiro works for Zeppelin notebook authentication.
+
+When you connect to Apache Zeppelin, you will be asked to enter your credentials. Once you logged in, then you have access to all notes including other user's notes.
+
+## Security Setup
+You can setup **Zeppelin notebook authentication** in some simple steps.
+
+####1. Secure the HTTP channel
+To secure the HTTP channel, you have to change both **anon** and **authcBasic** settings in `conf/shiro.ini`. In here, **anon** means "the access is anonymous" and **authcBasic** means "basic auth security".
+
+The default status of them is
+
+```
+/** = anon
+#/** = authcBasic
+```
+Deactivate the line "/** = anon" and activate the line "/** = authcBasic" in `conf/shiro.ini` file.
+
+```
+#/** = anon
+/** = authcBasic
+```
+
+For the further information about `shiro.ini` file format, please refer to [Shiro Configuration](http://shiro.apache.org/configuration.html#Configuration-INISections).
+
+####2. Secure the Websocket channel
+Set to property **zeppelin.anonymous.allowed** to **false** in `conf/zeppelin-site.xml`. If you don't have this file yet, just copy `conf/zeppelin-site.xml.template` to `conf/zeppelin-site.xml`.
+
+####3. Start Zeppelin
+
+```
+bin/zeppelin-daemon.sh start (or restart)
+```
+
+Then you can browse Zeppelin at [http://localhost:8080](http://localhost:8080).
+
+####4. Login
+Finally, you can login using one of the below **username/password** combinations.
+
+<center><img src="../assets/themes/zeppelin/img/docs-img/zeppelin-login.png"></center>
+
+```
+admin = password1
+user1 = password2
+user2 = password3
+```
+
+Those combinations are defined in the `conf/shiro.ini` file.
+
+> **NOTE :** This documentation is originally from [SECURITY-README.md](https://github.com/apache/incubator-zeppelin/blob/master/SECURITY-README.md).