directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smckin...@apache.org
Subject directory-fortress-commander git commit: improve readme
Date Sat, 23 Jan 2016 17:01:05 GMT
Repository: directory-fortress-commander
Updated Branches:
  refs/heads/master 7572c67cc -> 0f7d71f4a


improve 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/0f7d71f4
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/tree/0f7d71f4
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/diff/0f7d71f4

Branch: refs/heads/master
Commit: 0f7d71f4a05a8f17da91a39494a17db467b2d68e
Parents: 7572c67
Author: Shawn McKinney <smckinney@apache.org>
Authored: Sat Jan 23 10:05:07 2016 -0600
Committer: Shawn McKinney <smckinney@apache.org>
Committed: Sat Jan 23 10:05:07 2016 -0600

----------------------------------------------------------------------
 README.md                           |  44 ++++++++++++++++++++++---------
 images/fortress-web-system-arch.png | Bin 107082 -> 106098 bytes
 2 files changed, 32 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/blob/0f7d71f4/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 2250b1d..1bd72e3 100755
--- a/README.md
+++ b/README.md
@@ -15,16 +15,16 @@
    specific language governing permissions and limitations
    under the License.
 
-# Apache Fortress Web
-
- Apache Fortress Web Version 1.0-RC41 System Architecture Diagram
+# README for Apache Fortress Web
+ * Version 1.0-RC41
+ Apache Fortress Web System Architecture Diagram
  ![Apache Fortress Web System Architecture](images/fortress-web-system-arch.png "Apache Fortress
Web System Architecture")
 
-This document contains instructions to download, build, and test operations using Apache
Fortress Web component.
-
 -------------------------------------------------------------------------------
 ## Table of Contents
 
+ * Document Overview
+ * Tips for first-time users.
  * SECTION 1. Prerequisites
  * SECTION 2. Download & Build
  * SECTION 3. Get the fortress.properties
@@ -32,6 +32,22 @@ This document contains instructions to download, build, and test operations
usin
  * SECTION 5. Deploy to Tomcat Server
  * SECTION 6. Test with Selenium
 
+___________________________________________________________________________________
+## Document Overview
+
+This document contains instructions to download, build, and test operations using Apache
Fortress Web component.
+
+___________________________________________________________________________________
+##  Tips for first-time users
+
+ * For a tutorial on how to use Apache Fortress check out the: [10 Minute Guide](http://directory.apache.org/fortress/gen-docs/latest/apidocs/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html).
+ * If you see **FORTRESS_CORE_HOME**, refer to the base package of [directory-fortress-core].
+ * If you see **FORTRESS_REALM_HOME**, refer to the base package of [directory-fortress-realm].
+ * If you see **FORTRESS_WEB_HOME**, refer to this packages base folder.
+ * If you see **TOMCAT_HOME**, refer to the location of that package's base folder.
+ * Questions about this software package should be directed to its mailing list:
+   * http://mail-archives.apache.org/mod_mbox/directory-fortress/
+
 -------------------------------------------------------------------------------
 ## SECTION 1. Prerequisites
 
@@ -44,9 +60,8 @@ Minimum software requirements:
  * git
  * Apache Maven3++
  * Apache Tomcat7++
- * Apache Fortress Core installed per README located in the that package.
- * Apache Fortress Realm installed per README located in the that package.
- * LDAP server setup and configured per Apache Fortress Core README.
+ * Apache Fortress Core and LDAP server installed per README located in **FORTRESS_CORE_HOME**
package.
+ * Apache Fortress Realm installed per README located in **FORTRESS_REALM_HOME** package.
 
 Everything else covered in steps that follow.  Tested on Debian, Centos & Windows systems.
 
@@ -62,13 +77,12 @@ Build the source.
 ___________________________________________________________________________________
 ## SECTION 3. Get the fortress.properties
 
-Copy the fortress.properties, created during Fortress Core setup, to this package's resource
folder.
+Copy the fortress.properties, created during **FORTRESS_CORE_HOME** README, to this package's
resource folder.
 
 ```
-cp [directory-fortress-core]/config/fortress.properties [directory-fortress-commander]/src/main/resources
+cp FORTRESS_CORE_HOME/config/fortress.properties FORTRESS_WEB_HOME/src/main/resources
 ```
 
-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. Load Sample Security Policy
 
@@ -98,7 +112,7 @@ ________________________________________________________________________________
 
 2. Get the Fortress Realm Proxy jar.
 
- Place the fortress-realm proxy jar, generated by the [directory-fortress-realm] package
into Tomcat server's /lib folder.  The proxy jar name is named fortress-realm-proxy-[version].jar
and located here: [directory-fortress-realm]/proxy/target.
+ Place the fortress-realm proxy jar, generated by the **FORTRESS_REALM_HOME** package into
**TOMCAT_HOME**/lib folder.  The proxy jar name is named fortress-realm-proxy-[version].jar
and located here: **FORTRESS_REALM_HOME**/proxy/target.
 
 3. Restart Tomcat server.
 
@@ -112,6 +126,12 @@ ________________________________________________________________________________
  mvn tomcat:redeploy
  ```
 
+6. Open browser and test (creds: test/password):
+
+ ```
+ http://hostname:8080/fortress-web
+ ```
+
 ___________________________________________________________________________________
 ## SECTION 6. Test with Selenium
 

http://git-wip-us.apache.org/repos/asf/directory-fortress-commander/blob/0f7d71f4/images/fortress-web-system-arch.png
----------------------------------------------------------------------
diff --git a/images/fortress-web-system-arch.png b/images/fortress-web-system-arch.png
index b6c0325..3261fba 100644
Binary files a/images/fortress-web-system-arch.png and b/images/fortress-web-system-arch.png
differ


Mime
View raw message