Skip to content

[Zeppelin-661] Add a documentation for Shiro authentication#711

Closed
AhyoungRyu wants to merge 5 commits intoapache:masterfrom
AhyoungRyu:ZEPPELIN-661
Closed

[Zeppelin-661] Add a documentation for Shiro authentication#711
AhyoungRyu wants to merge 5 commits intoapache:masterfrom
AhyoungRyu:ZEPPELIN-661

Conversation

@AhyoungRyu
Copy link
Copy Markdown
Contributor

What is this PR for?

About a month ago, Shiro authentication for Zeppelin is merged by #586. Even though we already have SECURITY-README.md, many people do not know about the existence of this file. So I wrote a docs based on SECURITY-README.md to the Zeppelin documentation website to guide step by step for Zeppelin users.

What type of PR is it?

Documentation

Todos

  • - Add shiro authentication docs
  • - Add zeppelin.anonymous.allowed property in zeppelin-site.md
  • - Indent Websocket security section in SECURITY-README.md

Is there a relevant Jira issue?

ZEPPELIN-661

How should this be tested?

Screenshots (if appropriate)

screen shot 2016-02-12 at 11 29 29 am
screen shot 2016-02-12 at 11 29 53 am

Questions:

  • Does the licenses files need update? No
  • Is there breaking changes for older versions? No
  • Does this needs documentation? No

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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add by default what is the settings Zeppelin would use? (anon)

@felixcheung
Copy link
Copy Markdown
Member

looks good @hayssams could you review?

@AhyoungRyu
Copy link
Copy Markdown
Contributor Author

@felixcheung Thanks for the quick review! I addressed the default status of anon and authcBasic as you said.

@Leemoonsoo
Copy link
Copy Markdown
Member

Looks great. Thanks @AhyoungRyu for the nice document.

@AhyoungRyu
Copy link
Copy Markdown
Contributor Author

@Leemoonsoo My pleasure : )

@hayssams
Copy link
Copy Markdown
Contributor

LGTM
Great doc. Thanks

@felixcheung
Copy link
Copy Markdown
Member

merging if no more comments

@asfgit asfgit closed this in e6447b2 Feb 16, 2016
@minahlee
Copy link
Copy Markdown
Member

@felixcheung Could you also build the docs and deploy them after you merge the PRs which includes docs changes? So the updated docs can be reflected to website. You can refer https://github.com/apache/incubator-zeppelin/blob/master/docs/README.md

@AhyoungRyu
Copy link
Copy Markdown
Contributor Author

+1 for @minahlee

@minahlee
Copy link
Copy Markdown
Member

@felixcheung FYI, I just deployed the latest documentation on website.

@felixcheung
Copy link
Copy Markdown
Member

thanks, I was not aware of that process. Could you give me permission to add to https://cwiki.apache.org/confluence/display/ZEPPELIN/Committer+Guide

@Leemoonsoo
Copy link
Copy Markdown
Member

@felixcheung Permission granted. Sorry i forgot adding your id to cwiki.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants