You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sm...@apache.org on 2015/02/06 00:44:05 UTC
directory-fortress-core git commit: FC-56 - Cleanup core readme's
Repository: directory-fortress-core
Updated Branches:
refs/heads/master 2075c28f4 -> 0212adfa4
FC-56 - Cleanup core readme's
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/0212adfa
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/0212adfa
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/0212adfa
Branch: refs/heads/master
Commit: 0212adfa4dc98e66e94b7c9694efc8bc658b606d
Parents: 2075c28
Author: Shawn McKinney <sm...@apache.org>
Authored: Thu Feb 5 17:43:49 2015 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Thu Feb 5 17:43:49 2015 -0600
----------------------------------------------------------------------
README.txt | 104 +++----
.../core/doc-files/apache-directory.html | 181 ++++++------
.../core/doc-files/apache-fortress-realm.html | 19 +-
.../core/doc-files/apache-fortress-rest.html | 155 ++++++-----
.../core/doc-files/apache-fortress-web.html | 3 +-
.../fortress/core/doc-files/apache-tomcat.html | 272 ++++++++++---------
6 files changed, 382 insertions(+), 352 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/0212adfa/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
index 992cdd5..ae1d8fc 100755
--- a/README.txt
+++ b/README.txt
@@ -25,7 +25,7 @@ ________________________________________________________________________________
# Table of Contents
###################################################################################
# Document Overview
-# Tips for users of Fortress
+# Tips for users of Fortress Core
# SECTION 0. Prerequisites for Fortress Core SDK installation and usage
# SECTION 1. Options for installing OpenLDAP to target server environment
# SECTION 2. Instructions to pull Fortress Core source code from Apache GIT
@@ -36,11 +36,12 @@ ________________________________________________________________________________
# SECTION 7. Instructions for Symas installation of OpenLDAP - using 'init-slapd' target
# SECTION 8. Instructions to integration test using 'FortressJUnitTest' maven target
# SECTION 9. Instructions to run the command line interpreter (CLI) utility using 'cli' target
-# SECTION 10. Instructions to use Fortress A/P/R/BAC APIs with 'test-samples' target
-# SECTION 11. Instructions to run the command console using 'console' target
-# SECTION 12. Instructions to encrypt LDAP passwords used in config files.
-# SECTION 13. Instructions to load policy data using maven install -Dload.file target.
-# SECTION 14. Instructions to load test fortress using maven loadtest profile and jmeter.
+# SECTION 10. Instructions to load policy data using maven fortress-load.
+# SECTION 11. Instructions to build and test the fortress samples with 'test-samples' target
+# SECTION 12. Instructions to run the command console using 'console' target
+# SECTION 13. Instructions to performance test fortress core using maven loadtest profile and jmeter.
+# SECTION 14. Instructions to encrypt LDAP passwords used in config files.
+
___________________________________________________________________________________
###################################################################################
# Document Overview
@@ -525,7 +526,26 @@ b. follow instructions in the command line interpreter reference manual containe
$FORTRESS_HOME/dist/docs/api/com/jts/fortress/cli/package-summary.html
___________________________________________________________________________________
###################################################################################
-# SECTION 10. Instructions to use Fortress A/P/R/BAC APIs with 'test-samples' target
+# SECTION 10. Instructions to load policy data using maven fortress-load.
+###################################################################################
+
+Loads policy data into ldap.
+
+a. Create a load file using examples from FORTRESS_HOME/ldap/setup folder.
+
+e.g. myLoadFile.xml
+
+b. From FORTRESS_HOME folder, enter the following command:
+
+# $M2_HOME/bin/mvn install -Dload.file=./ldap/setup/myLoadFile.xml -DskipTests=true
+
+Notes:
+ - This maven target executes FortressAntTask class (as described in FORTRESS_HOME/dist/docs/api/org/openldap/fortress/ant/FortressAntTask.html).
+ - Drives Fortress policy apis using a simple xml format.
+ - Use to automate user and rbac policy data loads.
+___________________________________________________________________________________
+###################################################################################
+# SECTION 11. Instructions to build and test the fortress samples with 'test-samples' target
###################################################################################
a. from FORTRESS_HOME enter the following command:
@@ -561,7 +581,7 @@ Testing Notes:
- The 2nd and subsequent times 'test-samples' runs, it will tear down the data loaded during the prior run.
___________________________________________________________________________________
###################################################################################
-# SECTION 11. Instructions to run the command console using 'console' target
+# SECTION 12. Instructions to run the command console using 'console' target
###################################################################################
a. from FORTRESS_HOME enter the following command:
@@ -569,64 +589,46 @@ a. from FORTRESS_HOME enter the following command:
# $ANT_HOME/bin/ant console
___________________________________________________________________________________
###################################################################################
-# SECTION 12. Instructions to encrypt LDAP passwords used in config files.
+# SECTION 13. Instructions to performance test fortress core using maven loadtest profile and jmeter.
###################################################################################
-If you need the passwords for LDAP service accounts to be encrypted before loading into Fortress properties files you can
-use the 'encrypt' ant target.
-
-a. From FORTRESS_HOME root folder, enter the following command from a system prompt:
-
-# $ANT_HOME/bin/ant encrypt -Dparam1=secret
-encrypt:
- [echo] Encrypt a value
- [java] Encrypted value=wApnJUnuYZRBTF1zQNxX/Q==
-BUILD SUCCESSFUL
-Total time: 1 second
-
-b. Copy the hashed value and paste it into the corresponding build.properties setting, e.g.:
+To load test fortress createSession or checkAccess performance using jmeter:
-# This OpenLDAP admin root pass is bound for fortress.properties and was hashed using 'encrypt' target in build.xml:
-cfg.log.root.pw=wApnJUnuYZRBTF1zQNxX/Q==
-___________________________________________________________________________________
-###################################################################################
-# SECTION 13. Instructions to load policy data using maven install -Dload.file target.
-###################################################################################
+a. Update .jmx located under FORTRESS_HOME/src/test/jmeter folder.
-If you need to load policy data into the default database you can use maven target.
+e.g. ftCheckAccess.jmx
-a. Create a load file using examples from FORTRESS_HOME/ldap/setup folder.
+b. Load the security policy and users required by the jmeter test routines:
-e.g. myLoadFile.xml
+# $M2_HOME/bin/mvn install -Dload.file=./ldap/setup/LoadTestUsers.xml -DskipTests=true
-b. From FORTRESS_HOME folder, enter the following command from a system prompt:
+c. From FORTRESS_HOME folder, enter the following command from a system prompt:
-# $M2_HOME/bin/mvn install -Dload.file=./ldap/setup/myLoadFile.xml -DskipTests=true
+# $M2_HOME/bin/mvn -Ploadtest-ftca jmeter:jmeter
-admin notes:
+Notes:
+ - the above maps to ftCheckAccess.jmx
+ - jmx files with prefex 'ac' call fortress accelerator functions (which requires special setup NOT covered by this document)
+ - jmx files with prefix 'ft' are for fortress functions (which are covered by this document)
- - Calls ant target to execute FortressAntTask class (described in FORTRESS_HOME/dist/docs/api/org/openldap/fortress/ant/FortressAntTask.html).
- - Drives Fortress A/P/R/BAC APIs using supplied text files containing data in xml format.
- - Used to automatically load common data into target ldap machines.
___________________________________________________________________________________
###################################################################################
-# SECTION 14. Instructions to load test fortress using maven loadtest profile and jmeter.
+# SECTION 14. Instructions to encrypt LDAP passwords used in config files.
###################################################################################
-To load test fortress createSession or checkAccess performance using jmeter:
-
-a. Update .jmx located under FORTRESS_HOME/src/test/jmeter folder.
-
-e.g. ftCheckAccess.jmx
-
-b. Load the security policy and users required by the jmeter test routines:
+If you need the passwords for LDAP service accounts to be encrypted before loading into Fortress properties files you can
+use the 'encrypt' ant target.
-# $M2_HOME/bin/mvn install -Dload.file=./ldap/setup/LoadTestUsers.xml -DskipTests=true
+a. From FORTRESS_HOME root folder, enter the following command from a system prompt:
-c. From FORTRESS_HOME folder, enter the following command from a system prompt:
+# $ANT_HOME/bin/ant encrypt -Dparam1=secret
+encrypt:
+ [echo] Encrypt a value
+ [java] Encrypted value=wApnJUnuYZRBTF1zQNxX/Q==
+BUILD SUCCESSFUL
+Total time: 1 second
-# $M2_HOME/bin/mvn -Ploadtest-ftca jmeter:jmeter
+b. Copy the hashed value and paste it into the corresponding build.properties setting, e.g.:
-Note: the above maps to ftCheckAccess.jmx
-Note: jmx files with prefex 'ac' call fortress accelerator functions (which requires special setup NOT covered by this document)
- jmx files with prefix 'ft' are for fortress functions (which are covered by this document).
+# This OpenLDAP admin root pass is bound for fortress.properties and was hashed using 'encrypt' target in build.xml:
+cfg.log.root.pw=wApnJUnuYZRBTF1zQNxX/Q==
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/0212adfa/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html
index 4b0008a..de08ddd 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-directory.html
@@ -18,125 +18,134 @@
*
-->
<html>
- <head>
- <title>Apache Fortress Ten Minute Guide</title>
- <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
- </head>
- <body>
- <hr>
- <fieldset>
- <legend><b>Navigation Links</b></legend>
- <ul>
- <li><a href="./apache-directory.html">Setup Apache Directory Server</a></li>
- <li><a href="./apache-fortress-core.html">Build Apache Fortress Core</a></li>
- <li><a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a></li>
- <li><a href="./apache-tomcat.html">Setup Apache Tomcat Web Server</a></li>
- <li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
- <li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
- </ul>
- <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
- </fieldset>
- <hr>
- <p>
-
- <h3>Setup Apache Directory Server</h3>
- <img src="apacheds-logo.jpeg">
- <br><br>
- Download and install the package for your platform <a href="http://directory.apache.org/apacheds/downloads.html">Apache Directory Downloads Page</a>.
-
- This section provides instructions to install Directory Server and Studio. The Apache Directory is an LDAPv3 compliant directory server. Apache Studio
- is an ldap browser that can be used to maintain the ldap server directory and data.
- <h4>Steps to install</h4>
- <ol>
-
- <li>
- Download and install the package for your platform <a href="http://directory.apache.org/apacheds/downloads.html">Apache Directory Server Downloads Page</a>.
-
- <br><br>
-
- <ol type="A">
- <li>
- After installation start the directory server process.
-
- For Debian from system command prompt:
+<head>
+ <title>Apache Fortress Ten Minute Guide</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<hr>
+<fieldset>
+ <legend><b>Navigation Links</b></legend>
+ <ul>
+ <li><a href="./apache-directory.html">Setup Apache Directory Server</a></li>
+ <li><a href="./apache-fortress-core.html">Build Apache Fortress Core</a></li>
+ <li><a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a></li>
+ <li><a href="./apache-tomcat.html">Setup Apache Tomcat Web Server</a></li>
+ <li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
+ <li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
+ </ul>
+ <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
+</fieldset>
+<hr>
+<p>
+
+<h3>Setup Apache Directory Server</h3>
+<img src="apacheds-logo.jpeg">
+<br><br>
+Download and install the package for your platform <a href="http://directory.apache.org/apacheds/downloads.html">Apache
+ Directory Downloads Page</a>.
+
+This section provides instructions to install Directory Server and Studio. The Apache Directory is an LDAPv3 compliant
+directory server. Apache Studio
+is an ldap browser that can be used to maintain the ldap server directory and data.
+<h4>Steps to install</h4>
+<ol>
+
+ <li>
+ Download and install the package for your platform <a
+ href="http://directory.apache.org/apacheds/downloads.html">Apache Directory Server Downloads Page</a>.
+
+ <br><br>
+
+ <ol type="A">
+ <li>
+ After installation start the directory server process.
+
+ For Debian from system command prompt:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# sudo /etc/init.d/apacheds-[VERSION]-default start
+ # sudo /etc/init.d/apacheds-[VERSION]-default start
</p>
</pre>
- Where [VERSION] matches what was installed earlier. At the time of this writing the latest version is 2.0.0-M19.
- For Redhat (as root):
+ Where [VERSION] matches what was installed earlier. At the time of this writing the latest version is
+ 2.0.0-M19.
+ For Redhat (as root):
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-TODO: add instructions here
+ TODO: add instructions here
</p>
</pre>
- </li>
+ </li>
- <li>
- Check the status of server process.
+ <li>
+ Check the status of server process.
- For Debian from system command prompt:
+ For Debian from system command prompt:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# sudo /etc/init.d/apacheds-[VERSION]-default status
-ApacheDS - default is running (70041).
+ # sudo /etc/init.d/apacheds-[VERSION]-default status
+ ApacheDS - default is running (70041).
</p>
</pre>
- For Redhat (as root):
+ For Redhat (as root):
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-TODO: add instructions here
+ TODO: add instructions here
</p>
</pre>
- </li>
+ </li>
- </ol>
+ </ol>
- </li>
+ </li>
- <br>
+ <br>
- <li>
- Download and install Apache Directory Studio <a href="http://directory.apache.org/studio/downloads.html">Apache Directory Studio Downloads Page</a>.
+ <li>
+ Download and install Apache Directory Studio <a href="http://directory.apache.org/studio/downloads.html">Apache
+ Directory Studio Downloads Page</a>.
- <br><br>
+ <br><br>
- <ol type="A">
- <li>
- After installation start the directory studio process.
+ <ol type="A">
+ <li>
+ After installation start the directory studio process.
- </li>
+ </li>
- <br>
+ <br>
- <li>
- From the LDAP Browser perspective create a new connection. Enter an arbitrary name for connection, e.g. 'apacheds'. If apache directory server is running locally you may use 'localhost' and default port is '10389'.
- </li>
- <br><img src="./connection-create-screenshot1.png" /><br><br>
+ <li>
+ From the LDAP Browser perspective create a new connection. Enter an arbitrary name for connection, e.g.
+ 'apacheds'. If apache directory server is running locally you may use 'localhost' and default port is
+ '10389'.
+ </li>
+ <br><img src="./connection-create-screenshot1.png"/><br><br>
- <br>
+ <br>
- <li>
- The default creds for apache directory server are 'uid=admin,ou=system' and 'secret' for the password. It's a good idea to verify this info by clicking on the 'Check Authentication' button.
- </li>
- <br><img src="./connection-create-screenshot2.png" /><br><br>
+ <li>
+ The default creds for apache directory server are 'uid=admin,ou=system' and 'secret' for the password.
+ It's a good idea to verify this info by clicking on the 'Check Authentication' button.
+ </li>
+ <br><img src="./connection-create-screenshot2.png"/><br><br>
- <br>
- <li>
- After all the info has been entered, you should be able to browse the directory.
- </li>
- <br><img src="./connection-create-screenshot3.png" /><br><br>
+ <br>
+ <li>
+ After all the info has been entered, you should be able to browse the directory.
+ </li>
+ <br><img src="./connection-create-screenshot3.png"/><br><br>
- <br>
+ <br>
- </ol>
+ </ol>
- </li>
+ </li>
- <br>
- </ol>
- </body>
- <p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights Reserved.</p>
+ <br>
+</ol>
+</body>
+<p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights
+ Reserved.</p>
</html>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/0212adfa/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html
index 40dd66f..c3ca722 100644
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-realm.html
@@ -46,10 +46,11 @@
<ol>
<li>
- Clone the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-realm.git">Apache Fortress Realm Git repo</a>:
+ Clone the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-realm.git">Apache Fortress Realm
+ Git repo</a>:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-realm.git
+ # git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-realm.git
</p>
</pre>
@@ -59,7 +60,7 @@
Set JAVA_HOME:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export JAVA_HOME=/opt/jdk1.7.0_10/
+ # export JAVA_HOME=/opt/jdk1.7.0_10/
</p>
</pre>
</li>
@@ -68,7 +69,7 @@
Change directory:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# cd directory-fortress-realm/
+ # cd directory-fortress-realm/
</p>
</pre>
</li>
@@ -77,7 +78,7 @@
Set M2_HOME:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export M2_HOME=/usr/local/maven-version
+ # export M2_HOME=/usr/local/maven-version
</p>
</pre>
</li>
@@ -85,17 +86,19 @@
<br>
<li>
- Build fortress realm with maven and install to local repo. The fortress rest [<a href="apache-fortress-rest.html">Build Apache Fortress Rest</a>]
+ Build fortress realm with maven and install to local repo. The fortress rest [<a
+ href="apache-fortress-rest.html">Build Apache Fortress Rest</a>]
and fortress web [<a href="apache-fortress-web.html">Build Apache Fortress Web</a>]
are both dependent on the fortress realm.
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn clean install
+ # $M2_HOME/bin/mvn clean install
</p>
</pre>
</li>
</ol>
</body>
-<p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights Reserved.</p>
+<p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights
+ Reserved.</p>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/0212adfa/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
index cbb7a50..d5b72f0 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-rest.html
@@ -18,133 +18,140 @@
*
-->
<html>
- <head>
- <title>Apache Fortress Ten Minute Guide</title>
- <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
- </head>
- <body>
- <hr>
- <fieldset>
- <legend><b>Navigation Links</b></legend>
- <ul>
- <li><a href="./apache-directory.html">Setup Apache Directory Server</a></li>
- <li><a href="./apache-fortress-core.html">Build Apache Fortress Core</a></li>
- <li><a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a></li>
- <li><a href="./apache-tomcat.html">Setup Apache Tomcat Web Server</a></li>
- <li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
- <li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
- </ul>
- <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
- </fieldset>
- <hr>
- <p>
-
- <h3>Build Apache Fortress Rest</h3>
-
- <h4>This section describes how to install and use the Fortress Rest Application. It provides a RESTful wrapper around the Fortress Core apis.</h4>
-
- <ol>
-
- <li>
- Clone the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-enmasse.git">Apache Fortress Rest Git repo</a>:
+<head>
+ <title>Apache Fortress Ten Minute Guide</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<hr>
+<fieldset>
+ <legend><b>Navigation Links</b></legend>
+ <ul>
+ <li><a href="./apache-directory.html">Setup Apache Directory Server</a></li>
+ <li><a href="./apache-fortress-core.html">Build Apache Fortress Core</a></li>
+ <li><a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a></li>
+ <li><a href="./apache-tomcat.html">Setup Apache Tomcat Web Server</a></li>
+ <li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
+ <li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
+ </ul>
+ <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
+</fieldset>
+<hr>
+<p>
+
+<h3>Build Apache Fortress Rest</h3>
+
+<h4>This section describes how to install and use the Fortress Rest Application. It provides a RESTful wrapper around
+ the Fortress Core apis.</h4>
+
+<ol>
+
+ <li>
+ Clone the <a href="https://git-wip-us.apache.org/repos/asf?p=directory-fortress-enmasse.git">Apache Fortress
+ Rest Git repo</a>:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-rest.git
+ # git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-rest.git
</p>
</pre>
- </li>
+ </li>
- <li>
- Set JAVA_HOME:
+ <li>
+ Set JAVA_HOME:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export JAVA_HOME=/opt/jdk1.7.0_10/
+ # export JAVA_HOME=/opt/jdk1.7.0_10/
</p>
</pre>
- </li>
+ </li>
- <li>
- Change directory:
+ <li>
+ Change directory:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# cd directory-fortress-enmasse/
+ # cd directory-fortress-enmasse/
</p>
</pre>
- </li>
+ </li>
- <li>
- Set M2_HOME:
+ <li>
+ Set M2_HOME:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# export M2_HOME=/usr/share/maven-version
+ # export M2_HOME=/usr/share/maven-version
</p>
</pre>
- </li>
+ </li>
- <li>
- Generate the javadoc
+ <li>
+ Generate the javadoc
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn javadoc:javadoc
+ # $M2_HOME/bin/mvn javadoc:javadoc
</p>
</pre>
- The javadoc will be located under target/site/apidocs.
- </li>
+ The javadoc will be located under target/site/apidocs.
+ </li>
- <br>
+ <br>
- <li>
- Copy the fortress.properties, created on step <a href="./apache-fortress-core.html">Build Apache Fortress Core</a>, to this package's resource folder.
+ <li>
+ Copy the fortress.properties, created on step <a href="./apache-fortress-core.html">Build Apache Fortress
+ Core</a>, to this package's resource folder.
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# cp [directory-fortress-core]/config/fortress.properties [directory-fortress-enmasse]/src/main/resources
+ # cp [directory-fortress-core]/config/fortress.properties
+ [directory-fortress-enmasse]/src/main/resources
</p>
</pre>
- Where [directory-fortress-core] is base folder of the fortress core source package and [directory-fortress-enmasse] is the current package's home folder.
- </li>
+ Where [directory-fortress-core] is base folder of the fortress core source package and
+ [directory-fortress-enmasse] is the current package's home folder.
+ </li>
- <br>
+ <br>
- <li>
- Load the fortress rest test policies:
+ <li>
+ Load the fortress rest test policies:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn install -Dload.file=./src/main/resources/FortressRestServerRoles.xml -DskipTests=true
+ # $M2_HOME/bin/mvn install -Dload.file=./src/main/resources/FortressRestServerRoles.xml
+ -DskipTests=true
</p>
</pre>
- </li>
+ </li>
- <li>
- To deploy fortress rest, run this command:
+ <li>
+ To deploy fortress rest, run this command:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn tomcat:deploy
+ # $M2_HOME/bin/mvn tomcat:deploy
</p>
</pre>
- </li>
+ </li>
- <li>
- To redeploy:
+ <li>
+ To redeploy:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn tomcat:redeploy
+ # $M2_HOME/bin/mvn tomcat:redeploy
</p>
</pre>
- </li>
+ </li>
- <li>
- Run the tests:
+ <li>
+ Run the tests:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn test
+ # $M2_HOME/bin/mvn test
</p>
</pre>
- </li>
+ </li>
- </ol>
+</ol>
- </body>
- <p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights Reserved.</p>
+</body>
+<p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights
+ Reserved.</p>
</html>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/0212adfa/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html
index 5fdc667..7194af3 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-web.html
@@ -99,7 +99,8 @@
Load the fortress web test policies:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# $M2_HOME/bin/mvn install -Dload.file=./src/main/resources/FortressWebDemoUsers.xml -DskipTests=true
+ # $M2_HOME/bin/mvn install -Dload.file=./src/main/resources/FortressWebDemoUsers.xml
+ -DskipTests=true
</p>
</pre>
</li>
http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/0212adfa/src/main/java/org/apache/directory/fortress/core/doc-files/apache-tomcat.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-tomcat.html b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-tomcat.html
index 8d80055..06ac67c 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-tomcat.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-tomcat.html
@@ -18,193 +18,201 @@
*
-->
<html>
- <head>
- <title>Apache Fortress Ten Minute Guide</title>
- <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
- </head>
- <body>
- <hr>
- <fieldset>
- <legend><b>Navigation Links</b></legend>
- <ul>
- <li><a href="./apache-directory.html">Setup Apache Directory Server</a></li>
- <li><a href="./apache-fortress-core.html">Build Apache Fortress Core</a></li>
- <li><a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a></li>
- <li><a href="./apache-tomcat.html">Setup Apache Tomcat Web Server</a></li>
- <li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
- <li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
- </ul>
- <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
- </fieldset>
- <hr>
- <p>
-
- <h3>Setup Apache Tomcat Web Server</h3>
- <img src="tomcat.png">
- <br><br>
- This document contains instructions to install Tomcat 7 to common Linux distros. Any Tomcat (version 7 and beyond) instance
- may be used but server commands and file locations must be translated to match target environment.
- <hr>
- <h4>This section describes how to install Apache Tomcat to Debian and Redhat distros and enable HTTPS communication</h4>
- <ol>
- <li>
- If Tomcat is already installed skip this step.
- <br><br>
- For Debian from system command prompt:
+<head>
+ <title>Apache Fortress Ten Minute Guide</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<hr>
+<fieldset>
+ <legend><b>Navigation Links</b></legend>
+ <ul>
+ <li><a href="./apache-directory.html">Setup Apache Directory Server</a></li>
+ <li><a href="./apache-fortress-core.html">Build Apache Fortress Core</a></li>
+ <li><a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a></li>
+ <li><a href="./apache-tomcat.html">Setup Apache Tomcat Web Server</a></li>
+ <li><a href="./apache-fortress-rest.html">Build Apache Fortress Rest</a></li>
+ <li><a href="./apache-fortress-web.html">Build Apache Fortress Web</a></li>
+ </ul>
+ <li><a href="./ten-minute-guide.html">Ten Minute Guide</a></li>
+</fieldset>
+<hr>
+<p>
+
+<h3>Setup Apache Tomcat Web Server</h3>
+<img src="tomcat.png">
+<br><br>
+This document contains instructions to install Tomcat 7 to common Linux distros. Any Tomcat (version 7 and beyond)
+instance
+may be used but server commands and file locations must be translated to match target environment.
+<hr>
+<h4>This section describes how to install Apache Tomcat to Debian and Redhat distros and enable HTTPS communication</h4>
+<ol>
+ <li>
+ If Tomcat is already installed skip this step.
+ <br><br>
+ For Debian from system command prompt:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# sudo apt-get install tomcat7 tomcat7-admin tomcat7-docs
+ # sudo apt-get install tomcat7 tomcat7-admin tomcat7-docs
</p>
</pre>
- For Redhat (as root):
+ For Redhat (as root):
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# mkdir tmp
-# cd tmp
-# wget http://www.us.apache.org/dist/tomcat/tomcat-7/v7.0.55/bin/apache-tomcat-7.0.55.tar.gz
-# tar xzf apache-tomcat-7.0.55.tar.gz
-# mv apache-tomcat-7.0.55 /usr/share/tomcat7
-# cd /usr/share/tomcat7
-# ./bin/startup.sh
+ # mkdir tmp
+ # cd tmp
+ # wget http://www.us.apache.org/dist/tomcat/tomcat-7/v7.0.55/bin/apache-tomcat-7.0.55.tar.gz
+ # tar xzf apache-tomcat-7.0.55.tar.gz
+ # mv apache-tomcat-7.0.55 /usr/share/tomcat7
+ # cd /usr/share/tomcat7
+ # ./bin/startup.sh
</p>
</pre>
- </li>
+ </li>
- <li>
- Verify process is running:
+ <li>
+ Verify process is running:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# ps -ef | grep tomcat
+ # ps -ef | grep tomcat
</p>
</pre>
- </li>
+ </li>
- <li>
- Place the fortress-realm proxy jar from <a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a> into Tomcat server's /lib folder. The proxy
- jar name is fortress-realm-proxy-[version].jar and located here: directory-fortress-realm/proxy/target
+ <li>
+ Place the fortress-realm proxy jar from <a href="./apache-fortress-realm.html">Build Apache Fortress Realm</a>
+ into Tomcat server's /lib folder. The proxy
+ jar name is fortress-realm-proxy-[version].jar and located here: directory-fortress-realm/proxy/target
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# cp fortress-realm-proxy-[VERSION]-proxy.jar /usr/share/tomcat7/lib
+ # cp fortress-realm-proxy-[VERSION]-proxy.jar /usr/share/tomcat7/lib
</p>
</pre>
- Where [VERSION] matches the value in this packages pom.xml file. At the time of this writing the current version was 1.0-RC40.
- </li>
+ Where [VERSION] matches the value in this packages pom.xml file. At the time of this writing the current version
+ was 1.0-RC40.
+ </li>
- <br>
+ <br>
- <li>
+ <li>
Edit tomcat-users.xml:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# vi /usr/share/tomcat7/conf/tomcat-users.xml
+ # vi /usr/share/tomcat7/conf/tomcat-users.xml
</p>
</pre>
- </li>
+ </li>
- <li>
- Add privilege for <b>tcmanager</b> user to connect with Tomcat Manager. This account can access GUI and deploy via maven.
+ <li>
+ Add privilege for <b>tcmanager</b> user to connect with Tomcat Manager. This account can access GUI and deploy
+ via maven.
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-<role rolename="manager-script"/>
-<role rolename="manager-gui"/>
-<user username="tcmanager" password="m@nager123" roles="manager-script,manager-gui"/>
+ <role rolename="manager-script"/>
+ <role rolename="manager-gui"/>
+ <user username="tcmanager" password="m@nager123" roles="manager-script,manager-gui"/>
</p>
</pre>
- Using the config file realm to store credentials for an important application like the Tomcat Manager is a security <b>antipattern</b>. For production, a realm like
- fortress realm should used globally by Tomcat.
- </li>
-
- <br>
-
- <li>
- Save and exit.
- </li>
-
- <br>
-
- <li>
- Enable Tomcat SSL
- <ol type="a">
- <br>
- <li>
- Copy keystore created during <a href="II-keys.html">Section II - Managing PKI Keys</a> to <b>/usr/local/tomcat/conf</b> folder.
+ Using the config file realm to store credentials for an important application like the Tomcat Manager is a
+ security <b>antipattern</b>. For production, a realm like
+ fortress realm should used globally by Tomcat.
+ </li>
+
+ <br>
+
+ <li>
+ Save and exit.
+ </li>
+
+ <br>
+
+ <li>
+ Enable Tomcat SSL
+ <ol type="a">
+ <br>
+ <li>
+ Copy keystore created during <a href="II-keys.html">Section II - Managing PKI Keys</a> to <b>/usr/local/tomcat/conf</b>
+ folder.
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# sudo cp src/test/resources/certs/mykeystore /usr/share/tomcat7/conf
+ # sudo cp src/test/resources/certs/mykeystore /usr/share/tomcat7/conf
</p>
</pre>
- </li>
+ </li>
- <li>
- Edit <b>/usr/share/tomcat7/conf/server.xml</b> file:
+ <li>
+ Edit <b>/usr/share/tomcat7/conf/server.xml</b> file:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# vi /usr/share/tomcat7/conf/server.xml
+ # vi /usr/share/tomcat7/conf/server.xml
</p>
</pre>
- </li>
- <li>
- Add the following to <b>server.xml</b>:
+ </li>
+ <li>
+ Add the following to <b>server.xml</b>:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-<!-- Define a SSL Coyote HTTP/1.1 Connector on port 8443 -->
-<Connector
- port="8443" maxThreads="200"
- scheme="https" secure="true" SSLEnabled="true"
- keystoreFile="conf/mykeystore" keystorePass="changeit"
- clientAuth="false" sslProtocol="TLS"/>
+ <!-- Define a SSL Coyote HTTP/1.1 Connector on port 8443 -->
+ <Connector
+ port="8443" maxThreads="200"
+ scheme="https" secure="true" SSLEnabled="true"
+ keystoreFile="conf/mykeystore" keystorePass="changeit"
+ clientAuth="false" sslProtocol="TLS"/>
</p>
</pre>
- </li>
+ </li>
- <li>
- Save and exit the file.
- </li>
+ <li>
+ Save and exit the file.
+ </li>
- <br>
+ <br>
- <li>
- Restart Tomcat (Debian):
+ <li>
+ Restart Tomcat (Debian):
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-sudo /etc/init.d/tomcat7 restart
+ sudo /etc/init.d/tomcat7 restart
</p>
</pre>
- Redhat users:
+ Redhat users:
<pre>
<p style="font: monospace; color: black; background-color: lightgrey; font-size: 10pt">
-# ./bin/shutdown.sh
-# ./bin/startup.sh
+ # ./bin/shutdown.sh
+ # ./bin/startup.sh
</p>
</pre>
- </li>
- </ol>
- </li>
- <li>
- Verify setup by signing onto the Tomcat Manager app with credentials <b>userId</b>: <i>tcmanager</i>, <b>password</b>: <i>m@nager123</i>
- <br><br>
- <ol type="a">
- <li>
- non-SSL -
- local: <a href="http://localhost:8080/manager">http://localhost:8080/manager</a>,
- remote: <a href="http://fortressdemo2.com:8080/manager">http://fortressdemo2.com:8080/manager</a>
- <br>
- </li>
- <br>
- <li>
- SSL -
- local: <a href="https://localhost:8443/manager">https://localhost:8443/manager</a>,
- remote: <a href="https://fortressdemo2.com:8443/manager">https://fortressdemo2.com:8443/manager</a>
- </li>
- </ol>
- <br>
- Accept the self-signed certificate when the warning dialog appears.
- </li>
-
- </ol>
- </body>
- <p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights Reserved.</p>
+ </li>
+ </ol>
+ </li>
+ <li>
+ Verify setup by signing onto the Tomcat Manager app with credentials <b>userId</b>: <i>tcmanager</i>, <b>password</b>:
+ <i>m@nager123</i>
+ <br><br>
+ <ol type="a">
+ <li>
+ non-SSL -
+ local: <a href="http://localhost:8080/manager">http://localhost:8080/manager</a>,
+ remote: <a href="http://fortressdemo2.com:8080/manager">http://fortressdemo2.com:8080/manager</a>
+ <br>
+ </li>
+ <br>
+ <li>
+ SSL -
+ local: <a href="https://localhost:8443/manager">https://localhost:8443/manager</a>,
+ remote: <a href="https://fortressdemo2.com:8443/manager">https://fortressdemo2.com:8443/manager</a>
+ </li>
+ </ol>
+ <br>
+ Accept the self-signed certificate when the warning dialog appears.
+ </li>
+
+</ol>
+</body>
+<p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache Software Foundation. All Rights
+ Reserved.</p>
</html>