directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ha...@apache.org
Subject directory-kerby git commit: Adding README.md for kerby-dist
Date Tue, 24 Mar 2015 05:34:14 GMT
Repository: directory-kerby
Updated Branches:
  refs/heads/master 9c6fd7371 -> 653130a29


Adding README.md for kerby-dist


Project: http://git-wip-us.apache.org/repos/asf/directory-kerby/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerby/commit/653130a2
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/653130a2
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/653130a2

Branch: refs/heads/master
Commit: 653130a29088cd8451d63a59cd6d8a396f2a8743
Parents: 9c6fd73
Author: hazel <linchen7@foxmail.com>
Authored: Tue Mar 24 13:34:05 2015 +0800
Committer: hazel <linchen7@foxmail.com>
Committed: Tue Mar 24 13:34:05 2015 +0800

----------------------------------------------------------------------
 README.md            |  7 +++++--
 kerby-dist/README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++
 kerby-dist/pom.xml   |  4 ++--
 readme               | 51 -----------------------------------------------
 4 files changed, 57 insertions(+), 55 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/653130a2/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index d2e4836..6cd6d9c 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ Apache Kerby is a Java Kerberos binding. It provides a rich, intuitive and
inter
 + Provides support for JAAS, GSSAPI and SASL frameworks that applications can leverage.
 + Minimal dependencies, the core part is ensured to depend only on JRE and SLF4J, for easy
use and maintenance.
 
-### KrbClient APIs (Working In Progress)
+### KrbClient APIs
 * Initiate a KrbClient
 <pre>
 KrbClient krbClient = new KrbClient(kdcHost, kdcPort);
@@ -87,4 +87,7 @@ Apache License V2.0
 
 ### How to contribute
 - Git repo in Apache: [Source codes](https://git-wip-us.apache.org/repos/asf/directory-kerby.git)
-- Umbrella JIRA: it's tracked in the master JIRA [DIRKRB-102](https://issues.apache.org/jira/browse/DIRKRB-102),
and find tasks there.
\ No newline at end of file
+- Umbrella JIRA: it's tracked in the master JIRA [DIRKRB-102](https://issues.apache.org/jira/browse/DIRKRB-102),
and find tasks there.
+
+### How to run with a standalone kdc server
+ [Kerby Distribution README](https://github.com/apache/directory-kerby/blob/master/kerby-dist/README.md)
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/653130a2/kerby-dist/README.md
----------------------------------------------------------------------
diff --git a/kerby-dist/README.md b/kerby-dist/README.md
new file mode 100644
index 0000000..ddc9f09
--- /dev/null
+++ b/kerby-dist/README.md
@@ -0,0 +1,50 @@
+Kerby-dist
+============
+
+The distribution of Kerby.
+
+### To run with a standalone kdc server, kinit and kadmin
+
+* Generate libraries for distribution:
+```
+mvn package -Pdist
+```
+
+* Run kadmin to add principals:
+```
+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]
+```
+
+* Run kinit:
+```
+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.
+
+An example of kdc.conf:
+```
+[kdcdefaults]
+    kdc_host = localhost
+    kdc_tcp_port = 8015
+    kdc_realm = TEST.COM
+```
+An example of backend.conf:
+```
+kdc_identity_backend = org.apache.kerby.kerberos.kdc.identitybackend.JsonIdentityBackend
+backend.json.file = /tmp/kerby/jsonbackend
+```
+
+An example of krb5.conf:
+```
+[libdefaults]
+    kdc_realm=TEST.COM
+```
+

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/653130a2/kerby-dist/pom.xml
----------------------------------------------------------------------
diff --git a/kerby-dist/pom.xml b/kerby-dist/pom.xml
index 5c3bd31..b466baa 100644
--- a/kerby-dist/pom.xml
+++ b/kerby-dist/pom.xml
@@ -24,8 +24,8 @@
   </parent>
 
   <artifactId>kerby-dist</artifactId>
-  <name>Kerby KDC Distribution</name>
-  <description>Kerby KDC Distribution</description>
+  <name>Kerby Distribution</name>
+  <description>Kerby Distribution</description>
   <packaging>pom</packaging>
 
   <modules>

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/653130a2/readme
----------------------------------------------------------------------
diff --git a/readme b/readme
deleted file mode 100644
index f57d701..0000000
--- a/readme
+++ /dev/null
@@ -1,51 +0,0 @@
-# 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.
-
-How to run with a standalone kdc server, kinit and kadmin?
-
-1. Generate libraries for distribution:
-    mvn package -Pdist
-
-2. Run kadmin to add principals:
-    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.
-
-3. Run kerby-kdc-server:
-    sh kerby-dist/kdc-dist/bin/start-kdc.sh –start [server-conf-dir] [work-dir]
-
-4. Run kinit:
-    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.
-
-An example of kdc.conf:
-    [kdcdefaults]
-        kdc_host = localhost
-        kdc_tcp_port = 8015
-        kdc_realm = TEST.COM
-
-An example of backend.conf:
-    kdc_identity_backend = org.apache.kerby.kerberos.kdc.identitybackend.JsonIdentityBackend
-    backend.json.file = /tmp/kerby/jsonbackend
-
-An example of krb5.conf:
-    [libdefaults]
-        kdc_realm=TEST.COM
-
-
-


Mime
View raw message