|
From: <pe...@us...> - 2003-12-12 23:45:46
|
Update of /cvsroot/neuclear/neuclear-id/xdocs
In directory sc8-pr-cvs1:/tmp/cvs-serv8922/xdocs
Modified Files:
building.xml installation.xml navigation.xml
Log Message:
Minor fixes in the web app.
Updated documentation.
Index: building.xml
===================================================================
RCS file: /cvsroot/neuclear/neuclear-id/xdocs/building.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** building.xml 11 Nov 2003 02:31:47 -0000 1.2
--- building.xml 12 Dec 2003 23:45:42 -0000 1.3
***************
*** 8,43 ****
<body>
! <section name="Requirements">
<p>
! To build the NeuClear framework you first need to install <a href="http://jakarta.apache.org/turbine/maven/">Maven</a>.
Follow their installation instructions and you should be ok. I haven't tried this under windows yet, but I'm guessing
! it should work fine.
! </p>
! <p>
! Maven fetches almost all the required libraries you need the first time you attempt to build it. There are however
! two required libraries that are not yet part of their central repository. You will need to download these yourself and
! install it into Maven's local repository. For your convenience we've <a href="downloads/reqlibs.tar.gz">packaged them up here</a>.
</p>
<p>
Simply unpack it in mavens home directory retaining the directory structure and you should be allright.
</p>
- <p>
- If you want to get them yourself. Get the latest version of <a href="http://www.opensymphony.org">OSCore</a> and
- <a href="http://www.bouncycastle.org">Bouncy Castle Crypto</a>. For Bouncy Castle Crypto you need a JCE and a provider.
- If you're using JDK1.4 you will allready have a JCE. Otherwise the easiest thing todo is to get their combined JCE/Provider.
- I would also recommend getting the signed jar for your version of the JDK and install it as an extension in
- <tt>$JAVA_HOME/jre/lib/ext</tt>.
- </p>
- <p>
- Remember to edit your <tt>$JAVA_HOME/jre/lib/security/java.security</tt> file as well. Adding the following line:
- </p>
- <source>
- security.provider.6=org.bouncycastle.jce.provider.BouncyCastleProvider
- </source>
- <p>Making sure to change the 6 to whatever the last number is in the sequence of providers</p>
- <p>
- In Addition to play around with it you will need a J2EE compliant servlet engine such as <a href="http://jakarta.apache.org/tomcat/">Jakarta Tomcat</a>
- or <a href="http://jetty.mortbay.org">Jetty</a>. Install this as required.
- </p>
</section>
<section name="Building">
--- 8,23 ----
<body>
! <section name="Requirements for Building">
<p>
! To build the NeuClear framework you first need to install
! <a href="http://maven.apache.org/">Maven</a>.
Follow their installation instructions and you should be ok. I haven't tried this under windows yet, but I'm guessing
! it should work fine. Maven fetches all the required libraries you need the first time you attempt to build it. There are however
! two required libraries that are not yet part of their central repository. Some of the required libraries are not in maven's own repositories,
! we have our own maven repository at http://neuclear.org/maven/ and the project is setup to get all the latest from there.
</p>
<p>
Simply unpack it in mavens home directory retaining the directory structure and you should be allright.
</p>
</section>
<section name="Building">
***************
*** 46,60 ****
very easy to learn. To see the options available go to the type:
</p>
! <source>~/projects/NeuClearframework> maven -g</source>
<p>
Of these the most important one is to simply type:
</p>
! <source>~/projects/NeuClearframework> maven war</source>
<p>
! This should build everything and create a NeuClearframework.war file in <tt>target/</tt>. You can then deploy
! this war file in your J2EE compliant servlet engine. eg. place it in tomcat or jetty's <tt>webapps/</tt> directory
and restart.
</p>
</section>
</body>
</document>
--- 26,43 ----
very easy to learn. To see the options available go to the type:
</p>
! <source>~/projects/neuclear-id> maven -g</source>
<p>
Of these the most important one is to simply type:
</p>
! <source>~/projects/neuclear-id> maven war</source>
<p>
! This should build everything and create a neuclear-id.war file in
! <tt>target/</tt>. You can then deploy
! this war file in your J2EE compliant servlet engine. eg. place it in tomcat or jetty's
! <tt>webapps/</tt> directory
and restart.
</p>
</section>
+
</body>
</document>
Index: installation.xml
===================================================================
RCS file: /cvsroot/neuclear/neuclear-id/xdocs/installation.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** installation.xml 10 Dec 2003 23:58:52 -0000 1.5
--- installation.xml 12 Dec 2003 23:45:42 -0000 1.6
***************
*** 14,77 ****
If you are running Mac OS/X Jaguar or Panther you should already be set. Please let us know of any problems.
</p>
<p>
Download the
! <a href="http://neuclear.org/maven/neuclear-id/jars/neuclear-id-app-0.8-SNAPSHOT.jar">NeuClear ID Executable</a>.
Excuse the long and ugly name, we will package it nicer later on. Currently this tool allows you to create a certificate and
sign it. The jar file also contains all the required libraries and should be suitable for unpacking and
adding to your favorite IDE's classpath.
</p>
-
- </section>
- <section name="Requirements for Building">
- <p>
- To build the NeuClear framework you first need to install
- <a href="http://maven.apache.org/">Maven</a>.
- Follow their installation instructions and you should be ok. I haven't tried this under windows yet, but I'm guessing
- it should work fine. Maven fetches all the required libraries you need the first time you attempt to build it. There are however
- two required libraries that are not yet part of their central repository. Some of the required libraries are not in maven's own repositories,
- we have our own maven repository at http://neuclear.org/maven/ and the project is setup to get all the latest from there.
- </p>
<p>
! Simply unpack it in mavens home directory retaining the directory structure and you should be allright.
! </p>
! <p>
! If you want to get them yourself. Get the latest version of
! <a href="http://www.opensymphony.org">OSCore</a> and
! <a href="http://www.bouncycastle.org">Bouncy Castle Crypto</a>. For Bouncy Castle Crypto you need a JCE and a provider.
! If you're using JDK1.4 you will allready have a JCE. Otherwise the easiest thing todo is to get their combined JCE/Provider.
! I would also recommend getting the signed jar for your version of the JDK and install it as an extension in
! <tt>$JAVA_HOME/jre/lib/ext</tt>.
! </p>
! <p>
! Remember to edit your
! <tt>$JAVA_HOME/jre/lib/security/java.security</tt> file as well. Adding the following line:
</p>
! <source>
! security.provider.6=org.bouncycastle.jce.provider.BouncyCastleProvider
! </source>
! <p>Making sure to change the 6 to whatever the last number is in the sequence of providers</p>
<p>
! In Addition to play around with it you will need a J2EE compliant servlet engine such as
! <a href="http://jakarta.apache.org/tomcat/">Jakarta Tomcat</a>
! or
! <a href="http://jetty.mortbay.org">Jetty</a>. Install this as required.
</p>
</section>
! <section name="Building">
<p>
! Unpack the source and binary distributions. Familiarise yourself a bit with maven. It's a bit different than ant, but
! very easy to learn. To see the options available go to the type:
</p>
- <source>~/projects/neuclear-id> maven -g</source>
<p>
! Of these the most important one is to simply type:
</p>
- <source>~/projects/neuclear-id> maven war</source>
<p>
! This should build everything and create a neuclear-id.war file in
! <tt>target/</tt>. You can then deploy
! this war file in your J2EE compliant servlet engine. eg. place it in tomcat or jetty's
! <tt>webapps/</tt> directory
! and restart.
</p>
</section>
--- 14,48 ----
If you are running Mac OS/X Jaguar or Panther you should already be set. Please let us know of any problems.
</p>
+ </section>
+ <section name="NeuClear Executable">
<p>
Download the
! <a href="http://prdownloads.sourceforge.net/neuclear/neuclear-id-app-0.8.jar?download">NeuClear ID Executable</a>.
Excuse the long and ugly name, we will package it nicer later on. Currently this tool allows you to create a certificate and
sign it. The jar file also contains all the required libraries and should be suitable for unpacking and
adding to your favorite IDE's classpath.
</p>
<p>
! The tool is intended to be used from the commandline like this:
</p>
! <source>$ java -jar neuclear-id-app-0.8.jar</source>
<p>
! This will list the options available. For more indepth information on the tool see the <a href="bdg.html">
! Busy Developers Guide
! </a>
</p>
</section>
! <section name="Sample Web Application">
<p>
! We provide a sample web application showing how to integrate NeuClear into an existing web application.
! Download the
! <a href="http://prdownloads.sourceforge.net/neuclear/neuclear-id-0.8.war?download">NeuClear ID War</a> here.
</p>
<p>
! This should be suitable for deployment on any servlet engine or J2EE appserver that supports version 2.3
! of the Servlet API.
</p>
<p>
! In tomcat you can simply drop it into the <tt>$CATALINA_HOME/webapps</tt> folder.
</p>
</section>
Index: navigation.xml
===================================================================
RCS file: /cvsroot/neuclear/neuclear-id/xdocs/navigation.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** navigation.xml 8 Dec 2003 22:05:09 -0000 1.5
--- navigation.xml 12 Dec 2003 23:45:42 -0000 1.6
***************
*** 30,33 ****
--- 30,34 ----
-->
<!-- <item name="Live Application" href="http://NeuClear.org:8080/NeuClearframework/"/>-->
+ <item name="Building" href="/building.html"/>
<item name="Installation" href="/installation.html"/>
<item name="Credits and Dependencies" href="/credits.html"/>
|