directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From plusplusjia...@apache.org
Subject svn commit: r1689817 - in /directory/site/trunk: content/kerby/ content/kerby/user-guide/ templates/kerby/
Date Wed, 08 Jul 2015 08:53:45 GMT
Author: plusplusjiajia
Date: Wed Jul  8 08:53:45 2015
New Revision: 1689817

URL: http://svn.apache.org/r1689817
Log:
Add the content of kerby tools in user guide.

Added:
    directory/site/trunk/content/kerby/user-guide/3-tools.mdtext
    directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext
    directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext
    directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext
Modified:
    directory/site/trunk/content/kerby/downloads.mdtext
    directory/site/trunk/content/kerby/news.mdtext
    directory/site/trunk/content/kerby/quick-start.mdtext
    directory/site/trunk/content/kerby/user-guide.mdtext
    directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext
    directory/site/trunk/content/kerby/user-guide/2-apis.mdtext
    directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext
    directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext
    directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext
    directory/site/trunk/templates/kerby/index.html
    directory/site/trunk/templates/kerby/page.html

Modified: directory/site/trunk/content/kerby/downloads.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/downloads.mdtext?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/downloads.mdtext (original)
+++ directory/site/trunk/content/kerby/downloads.mdtext Wed Jul  8 08:53:45 2015
@@ -29,8 +29,30 @@ The Apache Kerby is distributed as a jar
 
 The Apache Kerby is also available as a Maven dependency:
 
+* Kerby Client API
     <dependency>
-        <groupId>org.apache.directory.kerby</groupId>
-        <artifactId>akerby</artifactId>
+        <groupId>org.apache.kerby</groupId>
+        <artifactId>kerb-client-api-all</artifactId>
         <version>${api-version}</version>
-    </dependency>
\ No newline at end of file
+    </dependency>
+
+* Kerby Server API
+    <dependency>
+        <groupId>org.apache.kerby</groupId>
+        <artifactId>kerb-server-api-all</artifactId>
+        <version>${api-version}</version>
+    </dependency>
+
+* Kerby ASN1
+    <dependency>
+        <groupId>org.apache.kerby</groupId>
+        <artifactId>kerby-asn1</artifactId>
+        <version>${api-version}</version>
+    </dependency>
+
+* Kerby Simple KDC
+    <dependency>
+        <groupId>org.apache.kerby</groupId>
+        <artifactId>kerb-simplekdc</artifactId>
+        <version>${api-version}</version>
+    </dependency>

Modified: directory/site/trunk/content/kerby/news.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/news.mdtext?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/news.mdtext (original)
+++ directory/site/trunk/content/kerby/news.mdtext Wed Jul  8 08:53:45 2015
@@ -1,2 +1,2 @@
 # News
-No news...
\ No newline at end of file
+First release of Apache Kerby is comming soon.

Modified: directory/site/trunk/content/kerby/quick-start.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/quick-start.mdtext?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/quick-start.mdtext (original)
+++ directory/site/trunk/content/kerby/quick-start.mdtext Wed Jul  8 08:53:45 2015
@@ -16,8 +16,6 @@ Notice: Licensed to the Apache Software
     specific language governing permissions and limitations
     under the License.
 
-# Kerby Quick-start guides
-
 The Quick Start guides show you how to do base install of Kerby:
 
 ## 1. How to play with the standalone KDC:
@@ -28,21 +26,21 @@ The distribution of Kerby.
 
 * Generate libraries for distribution:
 
-    mvn package -Pdist
+    $ mvn package -Pdist
 
 * Run kadmin to add principals:
 
-    sh kerby-dist/tool-dist/bin/kadmin.sh [server-conf-dir]
+    $ sh kerby-dist/tool-dist/bin/kadmin.sh [server-conf-dir]
 
   In kadmin, you can type "?" for help. For now, the kadmin only supports to add principals
to json-backend. (Working in progress).
 
 * Start kerby-kdc-server:
 
-    sh kerby-dist/kdc-dist/bin/start-kdc.sh –start [server-conf-dir] [work-dir]
+    $ sh kerby-dist/kdc-dist/bin/start-kdc.sh –start [server-conf-dir] [work-dir]
 
 * Run kinit:
 
-    sh kerby-dist/tool-dist/bin/kinit.sh [principal-name]
+    $ sh kerby-dist/tool-dist/bin/kinit.sh [principal-name]
 
   If you don't specify [server-conf-dir] in step 2 or 3, it will be set as /etc/kerby. In
[server-conf-dir], there should be kdc.conf, backend.conf. And in /etc/, there should be krb5.conf.
 

Modified: directory/site/trunk/content/kerby/user-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide.mdtext?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide.mdtext Wed Jul  8 08:53:45 2015
@@ -26,8 +26,12 @@ This guide is primarily for people new t
 ## Table of contents
 
 * [1 - How to begin](user-guide/1-how-to-begin.html)
-* [2 - APIs](basic-ug/2-apis.html)
-    * [2.1 - KrbClient APIs](2.1-krbclient-apis.html)
-    * [2.2 - Kadmin](2.2-kadmin.html)
-    * [2.3 - KdcServer](2.3-kdcserver.html)
-    * [2.4 - SimpleKdcServer](2.4-simplekdcserver.html)
+* [2 - APIs](user-guide/2-apis.html)
+    * [2.1 - KrbClient APIs](user-guide/2.1-krbclient-apis.html)
+    * [2.2 - Kadmin](user-guide/2.2-kadmin.html)
+    * [2.3 - KdcServer](user-guide/2.3-kdcserver.html)
+    * [2.4 - SimpleKdcServer](user-guide/2.4-simplekdcserver.html)
+* [3 - Tools](user-guide/3-tools.html)
+    * [3.1 - kadmin](user-guide/3.1-kadmin.html)
+    * [3.2 - kinit](user-guide/3.2-kinit.html)
+    * [3.3 - klist](user-guide/3.3-klist.html)

Modified: directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext Wed Jul  8 08:53:45
2015
@@ -1,6 +1,6 @@
 Title: 1 - How To Begin
 NavUp: ../user-guide.html
-NavUpText: Basic User Guide
+NavUpText: User Guide
 NavNext: 2-apis.html
 NavNextText: 2 - APIs
 Notice: Licensed to the Apache Software Foundation (ASF) under one
@@ -21,6 +21,6 @@ Notice: Licensed to the Apache Software
     under the License.
 
 # 1 - How to begin
-This chapter helps you to set up a server, with the minimal configuration options being explained.
That should be enough to get a running server.
+This chapter helps you to set up a Apache Kerby kdc server, with the minimal configuration
options being explained. That should be enough to get a running server.
+
 
-## Table of content

Modified: directory/site/trunk/content/kerby/user-guide/2-apis.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/2-apis.mdtext?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/2-apis.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/2-apis.mdtext Wed Jul  8 08:53:45 2015
@@ -1,6 +1,6 @@
 Title: 2 - APIs
-NavUp: ../basic-user-guide.html
-NavUpText: Basic User Guide
+NavUp: ../user-guide.html
+NavUpText: User Guide
 NavNext: 2.1-krbclient-apis.html
 NavNextText: 2.1 - KrbClient APIs
 Notice: Licensed to the Apache Software Foundation (ASF) under one

Modified: directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext Wed Jul  8 08:53:45 2015
@@ -1,8 +1,8 @@
 Title: 2.2 - Kadmin
 NavPrev: 2.1-krbclient-apis.html
 NavPrevText: 2.1 - KrbClient APIs
-NavUp: 2.1-krbclient-apis.html
-NavUpText: 2.1 - KrbClient APIs
+NavUp: 2-apis.html
+NavUpText: 2 - APIs
 NavNext: 2.3-kdcserver.html
 NavNextText: 2.3 - KdcServer
 Notice: Licensed to the Apache Software Foundation (ASF) under one

Modified: directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext Wed Jul  8 08:53:45
2015
@@ -1,8 +1,8 @@
 Title: 2.3 - KdcServer
 NavPrev: 2.2-kadmin.html
 NavPrevText: 2.2 - Kadmin
-NavUp: 2.2-kadmin.html
-NavUpText: 2.2 - Kadmin
+NavUp: 2-apis.html
+NavUpText: 2 - APIs
 NavNext: 2.3-kdcserver.html
 NavNextText: 2.4 - SimpleKdcServer
 Notice: Licensed to the Apache Software Foundation (ASF) under one

Modified: directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext Wed Jul  8 08:53:45
2015
@@ -1,10 +1,10 @@
 Title: 2.4 - SimpleKdcServer
 NavPrev: 2.3-kdcserver.html
 NavPrevText: 2.3 - KdcServer
-NavUp: 2.3-kdcserver.html
-NavUpText: 2.3 - KdcServer
-NavNext: 2.3-kdcserver.html
-NavNextText: 2.4 - SimpleKdcServer
+NavUp: 2-apis.html
+NavUpText: 2 - APIs
+NavNext: 3-tools.html
+NavNextText: 3 - tools
 Notice: 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

Added: directory/site/trunk/content/kerby/user-guide/3-tools.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3-tools.mdtext?rev=1689817&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3-tools.mdtext (added)
+++ directory/site/trunk/content/kerby/user-guide/3-tools.mdtext Wed Jul  8 08:53:45 2015
@@ -0,0 +1,32 @@
+Title: 3 - Tools
+NavUp: ../user-guide.html
+NavUpText: User Guide
+NavNext: 3.1-kadmin.html
+NavNextText: 3.1 - kadmin
+Notice: 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.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+# 3 - Tools
+This chapter helps you to set up a server, with the minimal configuration options being explained.
That should be enough to get a running server.
+
+This user guide is **not** intended to be a **LDAP** guide : there are some excellent tutorials
or books, we won't try to challenge them !
+
+## Table of content
+
+* [3.1 - kadmin](3.1-kadmin.html)
+* [3.2 - kinit](3.2-kinit.html)
+* [3.3 - klist](3.3-klist.html)
\ No newline at end of file

Added: directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext?rev=1689817&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext (added)
+++ directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext Wed Jul  8 08:53:45 2015
@@ -0,0 +1,51 @@
+Title: 3.1 - kadmin
+NavPrev: 3-tools.html
+NavPrevText: 3 - tools
+NavUp: 3-tools.html
+NavUpText: 3 - tools
+NavNext: 3.2-kinit.html
+NavNextText: 3.2 - kinit
+Notice: 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.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+	
+## 3.1 - kadmin
+
+### SYNOPSIS
+
+kadmin [-O|-N] [-r realm] [-p principal] [-q query] [[-c cache_name]|[-k [-t keytab]]|-n]
[-w password] [-s admin_server[:port]]
+
+### DESCRIPTION
+
+kadmin is command-line interfaces to the Kerberos V5 administration system. kadmin provides
for the maintenance of Kerberos principals, password policies, and service key tables (keytabs).
+
+### Commands
+
+* add_principal
+
+* modify_principal
+
+* rename_principal
+
+* delete_principal
+
+* change_password
+
+* get_principal
+
+* ktadd
+
+* ktremove
\ No newline at end of file

Added: directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext?rev=1689817&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext (added)
+++ directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext Wed Jul  8 08:53:45 2015
@@ -0,0 +1,33 @@
+Title: 3.2 - kinit
+NavPrev: 3.1-kadmin.html
+NavPrevText: 3.1 - kadmin
+NavUp: 3-tools.html
+NavUpText: 3.1 - tools
+NavNext: 3.3-klist.html
+NavNextText: 3.3 - klist
+Notice: 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.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+	
+## 3.2 - kinit
+
+### SYNOPSIS
+
+kinit [-V] [-l lifetime] [-s start_time] [-r renewable_life] [-p | -P] [-f | -F] [-a] [-A]
[-C] [-E] [-v] [-R] [-k [-t keytab_file]] [-c cache_name] [-n] [-S service_name] [-I input_ccache]
[-T armor_ccache] [-X attribute[=value]] [principal]
+
+### DESCRIPTION
+
+kinit obtains and caches an initial ticket-granting ticket for principal.
\ No newline at end of file

Added: directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext?rev=1689817&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext (added)
+++ directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext Wed Jul  8 08:53:45 2015
@@ -0,0 +1,31 @@
+Title: 3.3 - klist
+NavPrev: 3.2-kinit.html
+NavPrevText: 3.2 - kinit
+NavUp: 3-tools.html
+NavUpText: 3.1 - tools
+Notice: 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.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+## 3.3 - klist
+
+### SYNOPSIS
+
+klist [-e] [[-c] [-l] [-A] [-f] [-s] [-a [-n]]] [-C] [-k [-t] [-K]] [-V] [cache_name|keytab_name]
+
+#### DESCRIPTION
+
+klist lists the Kerberos principal and Kerberos tickets held in a credentials cache, or the
keys held in a keytab file.
\ No newline at end of file

Modified: directory/site/trunk/templates/kerby/index.html
URL: http://svn.apache.org/viewvc/directory/site/trunk/templates/kerby/index.html?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/templates/kerby/index.html (original)
+++ directory/site/trunk/templates/kerby/index.html Wed Jul  8 08:53:45 2015
@@ -7,10 +7,10 @@
       <div class="left">
         <h1>Apache Kerby&trade;</h1>
         <h2>The Apache Kerberos Server</h2>
-        <div class="description">Apache KeApache Kerby is a Java Kerberos binding.
It provides a rich, intuitive and interoperable implementation, library, KDC and various facilities
that integrates PKI, OTP and token (OAuth2) as desired in modern environments such as cloud,
Hadoop and mobile.<br/>
+        <div class="description">Apache Kerby is a Java Kerberos binding. It provides
a rich, intuitive and interoperable implementation, library, KDC and various facilities that
integrates PKI, OTP and token (OAuth2) as desired in modern environments such as cloud, Hadoop
and mobile.<br/>
         </div>
-        <!--div class="download-link">
-          <a href="{{base}}api/downloads.html" class="download_badge"><b>Download
Apache<br>LDAP API {{version_api}}</b></a>
+        <div class="download-link">
+          <a href="{{base}}kerby/downloads.html" class="download_badge"><b>Download
Apache<br>Kerby {{version_api}}</b></a>
         </div-->
       </div>
       <div class="right">

Modified: directory/site/trunk/templates/kerby/page.html
URL: http://svn.apache.org/viewvc/directory/site/trunk/templates/kerby/page.html?rev=1689817&r1=1689816&r2=1689817&view=diff
==============================================================================
--- directory/site/trunk/templates/kerby/page.html (original)
+++ directory/site/trunk/templates/kerby/page.html Wed Jul  8 08:53:45 2015
@@ -9,13 +9,6 @@
     {% endblock %}
 
     {% block project-navigation %}
-    <!--ul>
-      <li>
-        <a href="http://bit.ly/1n9YlQT" target="_blank">
-          <img src="{{base}}images/ApacheConBudapest.png" width="125" height="125" alt="I'm
Speaking at ApacheCon Europe 2014! Join me!" title="I'm Speaking at ApacheCon Europe 2014!
Join me!" border="0" style="margin-bottom:-3px;"/>
-        </a>
-      </li>
-    </ul-->
     <h5>Kerby</h5>
     <ul>
         <li><a href="{{base}}kerby/">Home</a></li>
@@ -25,7 +18,7 @@
     <h5>Downloads</h5>
     <ul>
         <li>Coming soon...</li>
-	    <!--li><a href="{{base}}kerby/downloads.html">Core {{version_kerby}}</a>&nbsp;&nbsp;<IMG
src="{{base}}images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li!-->
+	 <!--li><a href="{{base}}kerby/downloads.html">Core {{version_kerby}}</a>&nbsp;&nbsp;<IMG
src="{{base}}images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li!-->
         <!--li><a href="{{base}}kerby/download-old-versions.html">Older versions</a></li-->
     </ul>
     <h5>Getting Started</h5>
@@ -36,7 +29,7 @@
     <h5>Documentation</h5>
     <ul>
         <li><a href="{{base}}kerby/overview.html">Overview</a></li>
-	<li><a href="{{base}}kerby/quick-start.html">Quick Start</a></li>
+	 <li><a href="{{base}}kerby/quick-start.html">Quick Start</a></li>
         <li><a href="{{base}}kerby/user-guide.html">Users Guide</a></li>
         <!--li><a href="{{base}}kerby/gen-docs/latest/apidocs/">JavaDocs</a></li-->
         <!--li><a href="{{base}}kerby/gen-docs/latest/xref/">Cross-Reference</a></li-->



Mime
View raw message