directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smckin...@apache.org
Subject directory-fortress-core git commit: add readme for config info
Date Thu, 03 Dec 2015 01:29:52 GMT
Repository: directory-fortress-core
Updated Branches:
  refs/heads/master e6cb14c5c -> 3a3baa8c7


add readme for config info


Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/3a3baa8c
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/3a3baa8c
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/3a3baa8c

Branch: refs/heads/master
Commit: 3a3baa8c758945273ddc7e9752eb55747ab303cf
Parents: e6cb14c
Author: Shawn McKinney <smckinney@apache.org>
Authored: Wed Dec 2 19:29:51 2015 -0600
Committer: Shawn McKinney <smckinney@apache.org>
Committed: Wed Dec 2 19:29:51 2015 -0600

----------------------------------------------------------------------
 README-CONFIG.txt | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/3a3baa8c/README-CONFIG.txt
----------------------------------------------------------------------
diff --git a/README-CONFIG.txt b/README-CONFIG.txt
new file mode 100644
index 0000000..9e57060
--- /dev/null
+++ b/README-CONFIG.txt
@@ -0,0 +1,83 @@
+#
+#   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.
+#
+___________________________________________________________________________________
+###################################################################################
+# README-CONFIG.txt for Fortress Core Identity and Access Management SDK
+# Version 1.0-RC41
+# This file contains an overview of the fortress configuration system.
+
+___________________________________________________________________________________
+###################################################################################
+# SECTION 1.  Overview
+###################################################################################
+
+Fortress obtains its configuration information from the following three sources:
+1. fortress.properties file.
+2. Java system properties
+3. LDAP entry
+
+Of the three listed, 1 is mandatory, 2 & 3 are optional.  This means you may copy everything
into the fortress.properties
+file and forgo the usage of the other two.  The precedence is same order as listed.
+
+The general idea is the property file contains the coordinates to locate the config entry
stored in LDAP.
+The idea is to store most of the parameters inside the LDAP config node to cut back on the
number of places things must change.
+The system properties are only there to allow external subsystems the ability to poke properties
in at runtime.  A use case for #2 is a deployed war file, i.e. fortress-web,
+that is downloaded from the Internet and needs to have its ldap configuration parameters
overridden to point to proper location.
+
+You can only change these values using the system properties, which are LDAP connection coordinates
to config LDAP entry:
+  fortress.host
+  fortress.port
+  fortress.admin.user
+  fortress.admin.pw
+  fortress.min.admin.conn
+  fortress.max.admin.conn
+  fortress.enable.ldap.ssl
+  fortress.enable.ldap.ssl.debug
+  fortress.trust.store
+  fortress.trust.store.password
+  fortress.trust.store.set.prop
+  fortress.config.realm
+  fortress.ldap.server.type
+
+___________________________________________________________________________________
+###################################################################################
+# SECTION 2.  How It Works
+###################################################################################
+
+The build.properties file is used by the fortress core ant script, build.xml, to push attribute
values into the following locations:
+1. fortress.properties
+2. refreshLDAPData.xml - this is the base load script that sets up the DIT structure and
populates the config node in LDAP
+
+The fortress.properties are then loaded onto the classpath where it will be found by fortress.
 The refreshLDAPData.xml is
+the base load script that can be loaded using this command:
+# mvn install -Dload.file=./ldap/setup/refreshLDAPData.xml
+
+Anytime you need to refresh the values contained inside the other files, run this command:
+# mvn install
+
+This will then use the maven-antrun-plugin to kick off the following ant target within the
build.xml file:
+
+<ant antfile="${basedir}/build.xml" target="init-fortress-config" />
+
+For more info on which parameters are used where, look at the init-fortress-config target
located inside the build.xml file.
+
+
+
+
+


Mime
View raw message