Menu
▾
▴
[Archive-access-cvs] SF.net SVN: archive-access: [2264] trunk/archive-access/projects/ access-control
|
From: <al...@us...> - 2008-05-12 01:00:30
|
Revision: 2264
http://archive-access.svn.sourceforge.net/archive-access/?rev=2264&view=rev
Author: alexoz
Date: 2008-05-11 17:59:30 -0700 (Sun, 11 May 2008)
Log Message:
-----------
Added work in progress administrator manual and developer manual stub.
Added Paths:
-----------
trunk/archive-access/projects/access-control/dist/
trunk/archive-access/projects/access-control/dist/src/
trunk/archive-access/projects/access-control/dist/src/site/
trunk/archive-access/projects/access-control/dist/src/site/xdoc/
trunk/archive-access/projects/access-control/dist/src/site/xdoc/administrator_manual.xml
trunk/archive-access/projects/access-control/dist/src/site/xdoc/developer_manual.xml
Added: trunk/archive-access/projects/access-control/dist/src/site/xdoc/administrator_manual.xml
===================================================================
--- trunk/archive-access/projects/access-control/dist/src/site/xdoc/administrator_manual.xml (rev 0)
+++ trunk/archive-access/projects/access-control/dist/src/site/xdoc/administrator_manual.xml 2008-05-12 00:59:30 UTC (rev 2264)
@@ -0,0 +1,104 @@
+<document>
+ <properties>
+ <title>Stayback Administrator Manual</title>
+ <author email="aosborne nla gov au">Alex Osborne</author>
+ </properties>
+ <body>
+
+ <section name="Requirements">
+ <ul>
+ <li>Java 1.5 or later</li>
+ <li>A servlet container such
+ as <a href="http://tomcat.apache.org/">Tomcat</a></li>
+ <li>A database that
+ supported by <a href="http://hibernate.org">Hibernate</a> (all the
+ usual suspects do).</li>
+ </ul>
+ </section>
+
+ <section name="Download">
+ <p>A first release of the project has not yet been made, however
+ in the meantime you should be able to get a recent snapshot
+ from the Internet
+ Archive's <a href="http://builds.archive.org:8081/">build
+ server</a>. Select "Show projects", "Access control: Oracle
+ Webapp", "Working copy" and
+ download <tt>target/oracle-0.0.1-SNAPSHOT.war</tt>.
+ Alternatively you can build the project from source, see the
+ <a href="developer_manual.html">Developer Manual</a> for
+ instructions.</p>
+ </section>
+
+ <section name="Installation">
+ <subsection name="General">
+ <ul>
+ <li>Create a user and database to store the access control rules.</li>
+ <li>Deploy the oracle webapp to your application server (eg Apache Tomcat).</li>
+ <li>Download the appropriate JDBC connector for your database and drop it
+ in WEB-INF/lib.</li>
+ <li>Configure the database in the dataSource and sessionFactory beans in
+ WEB-INF/applicationContext.xml.</li>
+ </ul>
+ </subsection>
+ <subsection name="MySQL">
+
+ <p>Create a user and database to store the access control rules:</p>
+
+ <pre>
+ CREATE USER 'stayback'@ 'localhost' IDENTIFIED BY 'password';
+ GRANT USAGE ON * . * TO 'stayback'@ 'localhost' IDENTIFIED BY 'password';
+ CREATE DATABASE `stayback`;
+ GRANT ALL PRIVILEGES ON `stayback` . * TO 'stayback'@ 'localhost';
+ </pre>
+
+ <p>Deploy the oracle webapp to tomcat</p>
+
+ <p>Download <a href="http://www.mysql.com/products/connector-j">MySQL Connector/J</a> and copy
+ <tt>mysql-connector-java-*-bin.jar</tt> to <tt>WEB-INF/lib</tt>.</p>
+
+
+ <p>Configure the database in <tt>WEB-INF/applicationContext.xml</tt></p>:
+
+
+ <pre>
+ <bean id="dataSource"
+ class="org.apache.commons.dbcp.BasicDataSource"
+ destroy-method="close">
+ <property name="driverClassName" value="com.mysql.jdbc.Driver" />
+ <property name="url" value="jdbc:mysql://localhost/stayback" />
+ <property name="username" value="stayback" />
+ <property name="password" value="password" />
+ </bean>
+
+
+ <bean id="sessionFactory" [...] >
+ [...]
+ <property name="hibernateProperties">
+ <value>
+ hibernate.dialect=org.hibernate.dialect.MySQLDialect
+ hibernate.hbm2ddl.auto=create
+ </value>
+ </property>
+ </bean>
+ </pre>
+
+ <p>The <tt>hibernate.hbm2ddl.auto=create</tt> option will cause Hibernate to
+ automatically create the tables in the database.</p>
+ </subsection>
+ </section>
+
+ <section name="Configuring clients">
+ <subsection name="Wayback">
+ TODO: Write this. For now see the oracle section in the example wayback.xml.
+ </subsection>
+ <subsection name="NutchWAX">
+ Stayback client has not yet been integrated into NutchWAX.
+ </subsection>
+ <subsection name="Others">
+ <p>See the <a href="developer_manual.html">developer
+ manual</a> for information about integrating Stayback into
+ other software.
+ </subsection>
+ </section>
+ </body>
+</document>
Added: trunk/archive-access/projects/access-control/dist/src/site/xdoc/developer_manual.xml
===================================================================
--- trunk/archive-access/projects/access-control/dist/src/site/xdoc/developer_manual.xml (rev 0)
+++ trunk/archive-access/projects/access-control/dist/src/site/xdoc/developer_manual.xml 2008-05-12 00:59:30 UTC (rev 2264)
@@ -0,0 +1,11 @@
+<document>
+ <properties>
+ <title>Stayback Developer Manual</title>
+ <author email="aosborne nla gov au">Alex Osborne</author>
+ </properties>
+ <body>
+ <p>For now see
+ the <a href="http://webteam.archive.org/confluence/display/wayback/Exclusions+API">notes</a>
+ on the Wayback wiki.</p>
+ </body>
+</document>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
