incubator-blur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cr...@apache.org
Subject [2/4] git commit: More updates to console docs
Date Sat, 23 Aug 2014 01:16:05 GMT
More updates to console docs


Project: http://git-wip-us.apache.org/repos/asf/incubator-blur/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-blur/commit/3f8bf104
Tree: http://git-wip-us.apache.org/repos/asf/incubator-blur/tree/3f8bf104
Diff: http://git-wip-us.apache.org/repos/asf/incubator-blur/diff/3f8bf104

Branch: refs/heads/master
Commit: 3f8bf104f9132035fa4791f7971cdb64316446aa
Parents: ab02626
Author: Chris Rohr <rohr.chris@gmail.com>
Authored: Fri Aug 22 20:59:17 2014 -0400
Committer: Chris Rohr <rohr.chris@gmail.com>
Committed: Fri Aug 22 20:59:56 2014 -0400

----------------------------------------------------------------------
 .../resources/org/apache/blur/doc/header.html   |   7 +-
 docs/console.html                               | 133 +++++++++++++++++--
 2 files changed, 129 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/3f8bf104/blur-util/src/main/resources/org/apache/blur/doc/header.html
----------------------------------------------------------------------
diff --git a/blur-util/src/main/resources/org/apache/blur/doc/header.html b/blur-util/src/main/resources/org/apache/blur/doc/header.html
index 370544f..c50f86b 100644
--- a/blur-util/src/main/resources/org/apache/blur/doc/header.html
+++ b/blur-util/src/main/resources/org/apache/blur/doc/header.html
@@ -1,14 +1,14 @@
 <!DOCTYPE html>
-<!-- 
+<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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.
@@ -42,6 +42,7 @@
             <li><a href="cluster-setup.html">Cluster Setup</a></li>
             <li><a href="using-blur.html">Using Blur</a></li>
             <li class="active"><a href="Blur.html">Blur API</a></li>
+            <li><a href="console.html">Console</a></li>
             <li><a href="site/index.html" target="_blank">Maven Site</a></li>
             <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li>
           </ul>

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/3f8bf104/docs/console.html
----------------------------------------------------------------------
diff --git a/docs/console.html b/docs/console.html
index 40b05c7..c081448 100644
--- a/docs/console.html
+++ b/docs/console.html
@@ -36,13 +36,13 @@
         </div>
         <div class="collapse navbar-collapse">
           <ul class="nav navbar-nav">
-            <li class="active"><a href="index.html">Main</a></li>
+            <li><a href="index.html">Main</a></li>
             <li><a href="getting-started.html">Getting Started</a></li>
             <li><a href="data-model.html">Data Model</a></li>
             <li><a href="cluster-setup.html">Cluster Setup</a></li>
             <li><a href="using-blur.html">Using Blur</a></li>
             <li><a href="Blur.html">Blur API</a></li>
-            <li><a href="console.html">Console</a></li>
+            <li class="active"><a href="console.html">Console</a></li>
             <li><a href="site/index.html" target="_blank">Maven Site</a></li>
             <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li>
           </ul>
@@ -56,6 +56,7 @@
             <ul class="nav bs-sidenav">
               <li><a href="#configuration">Configuration</a></li>
               <li><a href="#security">Security</a></li>
+              <li><a href="#dev">Dev Mode</a></li>
             </ul>
           </div>
         </div>
@@ -67,6 +68,7 @@
             <p class="lead">
               Below you will find a list of available options and their appropriate defaults
for the Blur Console component. All options can be set in the blur-site.properties file.
             </p>
+            <h3>Base Settings</h3>
             <table class="table table-bordered table-striped table-condensed">
               <thead>
                 <tr>
@@ -77,7 +79,56 @@
               </thead>
               <tbody>
                 <tr>
-                  <td></td>
+                  <td>blur.console.port</td>
+                  <td>8080</td>
+                  <td>The port that the embedded Jetty server will run on when started.</td>
+                </tr>
+                <tr>
+                  <td>blur.console.authentication.provider</td>
+                  <td>org.apache.blur.console.providers.AllAuthenticated</td>
+                  <td>The class name that will implement the IAuthenticationProvider
interface and provide security to the tool.</td>
+                </tr>
+                <tr>
+                  <td>blur.console.authorization.provider</td>
+                  <td>org.apache.blur.console.providers.EmptyAuthorization</td>
+                  <td>The class name that will implement the IAuthorizationProvider
interface and provide authorization to the data.</td>
+                </tr>
+                <tr>
+                  <td>blur.console.authentication.roles.admin</td>
+                  <td>admin</td>
+                  <td>Used to aide in the mapping of custom provider roles to console
roles. This maps the administrator role.</td>
+                </tr>
+                <tr>
+                  <td>blur.console.authentication.roles.searcher</td>
+                  <td>searcher</td>
+                  <td>Used to aide in the mapping of custom provider roles to console
roles. This maps the searcher role.</td>
+                </tr>
+                <tr>
+                  <td>blur.console.authentication.roles.manager</td>
+                  <td>manager</td>
+                  <td>Used to aide in the mapping of custom provider roles to console
roles. This maps the manager role.</td>
+                </tr>
+              </tbody>
+            </table>
+            <h3>Included Security Provider Settings</h3>
+            <table class="table table-bordered table-striped table-condensed">
+              <thead>
+                <tr>
+                  <th>Provider</th>
+                  <th>Property</th>
+                  <th>Description</th>
+                </tr>
+              </thead>
+              <tbody>
+                <tr>
+                  <td>org.apache.blur.console.providers.TomcatUsers</td>
+                  <td>blur.console.authentication.provider.tomcat.usersfile</td>
+                  <td>The location of the file containing the users, passwords, and
roles.</td>
+                </tr>
+                <tr>
+                  <td>org.apache.blur.console.providers.GlobalJsonAuthorization</td>
+                  <td>blur.console.authorization.provider.globaljson.file</td>
+                  <td>The location of the file containing the access control to the
data for various "users" that can be used during searching.</td>
                 </tr>
               </tbody>
             </table>
@@ -91,16 +142,81 @@
           </p>
           <h3>Authentication Provider</h3>
           <p>
-
+            The Authentication Provider (interface org.apache.blur.console.providers.IAuthenticationProvider)
provides the ability to lock down the console tool to privileged users.  The interface
+            allows for logging in, retrieving a User, and providing roles for that user that
give access to functionality within the tool.
           </p>
           <h3>Authorization Provider</h3>
           <p>
-
+            The Authorization Provider (interface org.apache.blur.console.providers.IAuthorizationProvider)
provides the ability to apply Blur level access control to the users of the console.
           </p>
-          <h3>Available Implementations</h3>
-          <p>
+          <h3>Roles</h3>
 
-          </p>
+          <h3>Available Implementations</h3>
+          <table class="table table-bordered table-condensed table-striped">
+            <thead>
+              <tr>
+                <th>Provider</th>
+                <th>Interface</th>
+                <th>Description</th>
+              </tr>
+            </thead>
+            <tbody>
+              <tr>
+                <td>org.apache.blur.console.providers.AllAuthenticated</td>
+                <td>IAuthenticationProvider</td>
+                <td>Allows anyone to access all functionality of the console. Bypasses
user login.</td>
+              </tr>
+              <tr>
+                <td>org.apache.blur.console.providers.EmptyAuthorization</td>
+                <td>IAuthorizationProvider</td>
+                <td>This provider does not set up any attributes for Blur security
for the users of the console.</td>
+              </tr>
+              <tr>
+                <td>org.apache.blur.console.providers.GlobalJsonAuthorization</td>
+                <td>IAuthorizationProvider</td>
+                <td>
+                  Provides a list of users and their security attributes defined in a JSON
file.  These users can be selected from the search screen and will have their access applied
during searching.
+                  <br/>
+                  <code>
+                    "user1":{
+                    <br/>
+                      &nbsp;&nbsp;"attribute1":"foo,bar,baz",
+                    <br/>
+                    &nbsp;&nbsp;"attribute2":"zzzzz"
+                    <br/>
+                     },
+                    <br/>
+                    "user2":{
+                    <br/>
+                    &nbsp;&nbsp;"attribute1":"foo",
+                    <br/>
+                    &nbsp;&nbsp;"attribute2":"12345"
+                    <br/>
+                    }
+                  </code>
+                </td>
+              </tr>
+              <tr>
+                <td>org.apache.blur.console.providers.TomcatUsers</td>
+                <td>IAuthenticationProvider</td>
+                <td>Provides a list of users, roles, and passwords in an xml file.
 The format of this file is identical to a tomcat-users file.</td>
+              </tr>
+            </tbody>
+          </table>
+          <div class="alert alert-info">
+            <strong>Note:</strong>
+            Custom Providers can be created by implementing the interfaces, placing the jar
in the runtime blur lib directory, and adding the classnames to the config file.
+          </div>
+          <div class="alert alert-info">
+            <strong>Note:</strong>
+            Configuring the same class for authentication and authorization providers will
reuse the same instance for both.
+          </div>
+        </section>
+        <section>
+          <div class="page-header">
+            <h1 id="dev">Dev Mode</h1>
+          </div>
+          <p>Adding --dev to the arguments when running Blur Console</p>
         </section>
       </div>
     </div>
@@ -111,5 +227,6 @@
     <script src="resources/js/bootstrap.min.js"></script>
     <!-- Enable responsive features in IE8 with Respond.js (https://github.com/scottjehl/Respond)
-->
     <script src="resources/js/respond.min.js"></script>
+    <script src="resources/js/docs.js"></script>
   </body>
 </html>


Mime
View raw message