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/05 18:01:36 UTC
directory-fortress-commander git commit: FC-56 - Update Fortress Web
README
Repository: directory-fortress-commander
Updated Branches:
refs/heads/master c45c39da9 -> eb846cf8c
FC-56 - Update Fortress Web README
Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/commit/eb846cf8
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/tree/eb846cf8
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/diff/eb846cf8
Branch: refs/heads/master
Commit: eb846cf8c369fbd106b4c5b16b62a524d1652cb0
Parents: c45c39d
Author: Shawn McKinney <sm...@apache.org>
Authored: Thu Feb 5 11:01:23 2015 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Thu Feb 5 11:01:23 2015 -0600
----------------------------------------------------------------------
README.txt | 131 +++++++++++++++++++-------------------------------------
1 file changed, 45 insertions(+), 86 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/blob/eb846cf8/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
index 5bf4eba..9b63cd5 100755
--- a/README.txt
+++ b/README.txt
@@ -19,92 +19,68 @@
___________________________________________________________________________________
###################################################################################
README for Fortress Web Application Installation
-RC40
-Last updated: November 4, 2014
+Last updated: February 5, 2015
___________________________________________________________________________________
###################################################################################
-# SECTION 1: Prerequisites
+# SECTION 0. Prerequisites for Fortress Web installation and usage
###################################################################################
-1. Internet access to retrieve dependencies from online Maven repo.
+a. Internet access to retrieve source code from Apache Fortress Web GIT and binary dependencies from online Maven repo.
-NOTE: The Commander maven may run without connection to Internet iff:
-- The binary dependencies are already present in M2_HOME
+b. Java SDK Version 7 or beyond installed to target environment
-2. Java SDK Version 7 or beyond installed to target environment
+c. Apache Maven installed to target environment
-3. Apache Ant installed.
-
-4. Apache Maven 3 installed.
-
-5. Fortress/ApacheDS QUICKSTART installed to target system.
-Instructions: http://directory.apache.org/fortress/quick-start/apacheds/apacheds.html
-
-6. Tomcat 7 (or suitable servlet container) installed:
-http://tomcat.apache.org
-
-7. Fortress Realm must be enabled:
-Instructions: https://symas.com/javadocs/sentry
+d. LDAP server installed. (see README in Apache Fortress Core)
+e. Apache Tomcat or other servlet container installed
+_________________________________________________________________________________
###################################################################################
-# SECTION 2: Important Notes about Fortress Web Application
+# SECTION 1: Instructions to clone source from Fortress Web Git Repo:
###################################################################################
-1. Fortress Web is released as Apache 2.0. (see LICENSE.txt)
-
-2. This web app was tested using Apache Tomcat 7 but would work inside any current Java Servlet container (with changes to deploy procedure)
-
-3. Maven 'install' target in this package builds Commander war file which deploys to Java EE servlet container.
+a. Clone the directory-fortress-commander from apache git repo:
+# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-commander.git
-4. This document includes instructions to Compile, Deploy, run Javadoc and Test the Commander Web application using Apache Tomcat.
-
-5. Security Measures implemented within this application include:
-
- - Java EE Security - Confidentiality, Authentication, Session Management
- - requires HTTP Basic Auth header exchange to pass credentials used for security checks.
-
- - Spring Security - Role-Based Access Control Interceptor
- - Service-level Authorization uses Spring Security.
- - To find out what Roles required to which Services, view the Spring annotations inside this file:
- commander-dist-[version]/src//main/java/org/openldap/enmasse/FortressServiceImpl.java
+b. Change directory to package home:
+# cd directory-fortress-commander/
+___________________________________________________________________________________
+###################################################################################
+# SECTION 2: Instructions to build Fortress Web
+###################################################################################
- - Fortress Sentry - Java EE security plugin for Identity, Coarse-grained Authorization, and Audit Trail
+a. Open a command prompt on target machine in the root folder of the directory-fortress-commander package
- - Commander - Identity, Administrative, Compliance and Review pages
+b. Set java home:
+# export JAVA_HOME=...
- - Wicket - Controls buttons and links displayed by role and permissions
+c. Set maven home:
+# export M2_HOME=...
- - OpenLDAP - Password Hashing, Policies.
-_________________________________________________________________________________
+d. Run maven install:
+# $M2_HOME/bin/mvn clean install -DskipTests
+___________________________________________________________________________________
###################################################################################
-# SECTION 3: Instructions for Fortress Web installation using Source Bundle
+# SECTION 3: Obtain the fortress.properties
###################################################################################
-1. Retrieve Fortress Web source code bundle:
-https://git-wip-us.apache.org/repos/asf/directory-fortress-web.git
+Copy the fortress.properties, created during Apache Fortress Core setup, to this package's resource folder.
+# cp [directory-fortress-core]/config/fortress.properties [directory-fortress-commander]/src/main/resources
-2. Extract contents of directory-fortress-web.tar.gz to target env.
+Where [directory-fortress-core] is base folder of the fortress core source package and [directory-fortress-commander] is the current package's home folder.
___________________________________________________________________________________
###################################################################################
-# SECTION 4: Instructions to build Fortress Web archive file
+# SECTION 4: Load Test Users
###################################################################################
-1. Open a command prompt on target machine in the root folder of the commander-dist package
-
-2. Set java home:
->export JAVA_HOME=/opt/jdk1.7.0_10
-
-3. Set maven home:
->export M2_HOME=/usr/share/maven
-
-4. Run maven install:
->mvn install
+Run maven install with load file:
+# $M2_HOME/bin/mvn install -Dload.file=./src/main/resources/FortressWebDemoUsers.xml -DskipTests=true
###################################################################################
# SECTION 5: Instructions to Deploy Fortress Web application to Tomcat
###################################################################################
-1. Enable Maven to communicate with Tomcat using settings.xml file.
+a. Enable Maven to communicate with Tomcat using settings.xml file.
note: a typical location for this maven configuration file is: ~/.m2/settings.xml
@@ -116,40 +92,23 @@ Add to file:
<password>m@nager123</password>
</server>
-note1: If you followed the installation steps of Fortress QUICKSTART your Tomcat Manager creds would be as above.
-note2: If not using the Fortress Tomcat realm, add the following to tomcat-users.xml and restart tomcat:
- <role rolename="manager-script"/>
- <user username="tcmanager" password="m@nager123" roles="manager-script"/>
+note: If you followed the installation steps of Fortress Ten Minute Guide your Tomcat Manager creds would be as above.
-2. Enter maven command to deploy to Tomcat:
->mvn tomcat:deploy
+b. Enter maven command to deploy to Tomcat:
+# $M2_HOME/bin/mvn tomcat:deploy
-3. To redeploy:
->mvn tomcat:redeploy
+c. To redeploy:
+# $M2_HOME/bin/mvn tomcat:redeploy
___________________________________________________________________________________
###################################################################################
-# SECTION 6: Instructions to integration test Fortress Web application
+# SECTION 6: Instructions to test Fortress Rest application
###################################################################################
-Note: This test case depends that the prerequisite tasks have been performed in SECTION 1.
-
-1. Load the test security policy into LDAP using Commander test target:
->mvn test
-
-2. Run the Selenium Web driver integration tests:
->mvn verify -DskipTests=false
-
-___________________________________________________________________________________
-###################################################################################
-# SECTION 7: Instructions to create Fortress Web javadoc (optional)
-###################################################################################
-
-The service level documentation provides descriptions for each of the Commander pages.
-
-1. Enter the following:
-
-$ mvn javadoc:javadoc
+Note: This test case depends:
-2. View the document output here:
+a. Test data loaded from SECTION X of Apache Fortress Core README
+b. Test data loaded from SECTION 4 of this document
+c. Firefox is loaded on target machine
-directory-fortress-web/target/site/apidocs
\ No newline at end of file
+Run the Selenium Web driver integration tests:
+# $M2_HOME/bin/mvn verify -DskipTests=false
\ No newline at end of file