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:14:10 UTC

directory-fortress-realm git commit: FC-56 - Add Fortress Realm README

Repository: directory-fortress-realm
Updated Branches:
  refs/heads/master c772d3611 -> cbb8e8feb


FC-56 - Add Fortress Realm README


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

Branch: refs/heads/master
Commit: cbb8e8feb5aed7eee697a684d980818a131ff007
Parents: c772d36
Author: Shawn McKinney <sm...@apache.org>
Authored: Thu Feb 5 11:13:53 2015 -0600
Committer: Shawn McKinney <sm...@apache.org>
Committed: Thu Feb 5 11:13:53 2015 -0600

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


http://git-wip-us.apache.org/repos/asf/directory-fortress-realm/blob/cbb8e8fe/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
new file mode 100755
index 0000000..91603a3
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,67 @@
+#
+#   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 for Fortress Realm Application Installation
+Last updated: February 5, 2015
+___________________________________________________________________________________
+###################################################################################
+# SECTION 0.  Prerequisites for Fortress Realm installation
+###################################################################################
+a. Internet access to retrieve source code from Apache Fortress Rest GIT and binary dependencies from online Maven repo.
+
+b. Java SDK Version 7 or beyond installed to target environment
+
+c. Apache Maven installed to target environment
+
+_________________________________________________________________________________
+###################################################################################
+# SECTION 1:  Instructions to clone source from Fortress Realm Git Repo:
+###################################################################################
+
+a. Clone the directory-fortress-realm from apache git repo:
+# git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-realm.git
+
+b. Change directory to package home:
+# cd directory-fortress-realm/
+___________________________________________________________________________________
+###################################################################################
+# SECTION 2:  Instructions to install Fortress Realm
+###################################################################################
+
+a. Open a command prompt on target machine in the root folder of the directory-fortress-realm package
+
+b. Set java home:
+# export JAVA_HOME=...
+
+c. Set maven home:
+# export M2_HOME=...
+
+d. Run maven install:
+# $M2_HOME/bin/mvn clean install
+
+e. Build the javadoc:
+# $M2_HOME/bin/mvn javadoc:javadoc
+
+f. To view Fortress Realm Setup Notes for Tomcat Container point your browser here:
+file:///[package home]/target/site/apidocs/org/apache/directory/fortress/realm/tomcat/package-summary.html
+
+(where [package_home] is location of directory-fortress-realm base package)
\ No newline at end of file