Skip to Content.
Sympa Menu

idok-commit - [idok-commit] idok commit r757 - trunk

idok-commit AT lists.psi.ch

Subject: Commit emails of the iDok project

List archive

[idok-commit] idok commit r757 - trunk


Chronological Thread 
  • From: "AFS account Roman Geus" <geus AT savannah.psi.ch>
  • To: idok-commit AT lists.psi.ch
  • Subject: [idok-commit] idok commit r757 - trunk
  • Date: Mon, 25 Feb 2008 18:24:15 +0100
  • List-archive: <https://lists.web.psi.ch/pipermail/idok-commit/>
  • List-id: Commit emails of the iDok project <idok-commit.lists.psi.ch>

Author: geus
Date: Mon Feb 25 18:24:15 2008
New Revision: 757

Log:
Added the installation manual in HTML format - generated from doc/INSTALL.odt

Added:
trunk/INSTALL.html (contents, props changed)

Added: trunk/INSTALL.html
==============================================================================
--- (empty file)
+++ trunk/INSTALL.html Mon Feb 25 18:24:15 2008
@@ -0,0 +1,456 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+ <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
+ <TITLE></TITLE>
+ <META NAME="GENERATOR" CONTENT="OpenOffice.org 2.3 (Linux)">
+ <META NAME="CREATED" CONTENT="0;0">
+ <META NAME="CHANGEDBY" CONTENT="Roman Geus">
+ <META NAME="CHANGED" CONTENT="20080225;18073800">
+ <META NAME="SDFOOTNOTE" CONTENT=";;;;P">
+ <META NAME="SDENDNOTE" CONTENT="ARABIC">
+ <STYLE TYPE="text/css">
+ <!--
+ @page { size: 21cm 29.7cm; margin: 2cm }
+ P { margin-bottom: 0.21cm }
+ P.western { so-language: en-US }
+ H1 { margin-bottom: 0.21cm; text-align: left }
+ H1.western { font-family: "Arial", sans-serif; font-size:
20pt; so-language: en-US }
+ H1.cjk { font-family: "Arial"; font-size: 16pt }
+ H1.ctl { font-family: "Lucidasans"; font-size: 16pt }
+ H2 { margin-bottom: 0.21cm; text-align: left }
+ H2.western { font-family: "Arial", sans-serif; font-size:
14pt; so-language: en-US; font-style: italic }
+ H2.cjk { font-family: "Arial"; font-size: 14pt; font-style:
italic }
+ H2.ctl { font-family: "Lucidasans"; font-size: 14pt;
font-style: italic }
+ H3 { margin-bottom: 0.21cm; text-align: left }
+ H3.western { font-family: "Arial", sans-serif; font-size:
12pt; so-language: en-US }
+ H3.cjk { font-family: "Arial" }
+ H3.ctl { font-family: "Lucidasans" }
+ H4 { margin-bottom: 0.21cm; background: transparent;
text-align: left }
+ H4.western { font-family: "Arial", sans-serif; so-language:
en-US; font-style: italic }
+ H4.cjk { font-family: "Arial"; font-size: 11pt; font-style:
italic }
+ H4.ctl { font-family: "Lucidasans"; font-size: 11pt;
font-style: italic }
+ PRE.western { so-language: zxx }
+ CODE.western { so-language: zxx }
+ -->
+ </STYLE>
+</HEAD>
+<BODY LANG="de-DE" DIR="LTR">
+<P LANG="en-US" ALIGN=CENTER STYLE="margin-top: 0.42cm; page-break-after:
avoid">
+<FONT FACE="Arial, sans-serif"><FONT SIZE=6>iDok Install
+Documentation</FONT></FONT></P>
+<H1 LANG="en-US" CLASS="western">1Audience</H1>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">This
+document is written for people who intend to build iDok from the Java
+source code or who intend to setup an iDok server. The following
+instructions assume that a Linux operating system.
+</P>
+<H1 LANG="en-US" CLASS="western">2Software overview</H1>
+<P LANG="en-US" CLASS="western">The iDok software is implemented as a
+client/server architecture.</P>
+<H2 LANG="en-US" CLASS="western">2.1Client</H2>
+<P LANG="en-US" CLASS="western">iDok clients provide different levels
+of functionality:</P>
+<UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Read
+ access to documents, e.g. using a web browser, over the HTTP
+ protocol</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Read
+ and write access to documents, over the WEBDAV protocol (e.g.
+ Windows web folders)</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">The
+ iDok GUI client and the iDok command line client provide full
+ access, i.e.
+ </P>
+ <UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">read
+ and write access to documents and their meta data</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">full
+ text search</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">administrative
+ functionality</P>
+ </UL>
+</UL>
+<H2 LANG="en-US" CLASS="western">2.2Server</H2>
+<P LANG="en-US" CLASS="western">The iDok server consists of several
+server components:</P>
+<H3 LANG="en-US" CLASS="western">2.2.1Apache web server with
+Subversion</H3>
+<P LANG="en-US" CLASS="western">Subversion is the data back end of
+iDok. It handles the versioned storage and retrieval of documents and
+associated meta data.</P>
+<H4 LANG="en-US" CLASS="western">Repository access through HTTP and
+WEBDAV protocol</H4>
+<P LANG="en-US" CLASS="western">The repository access through the
+HTTP and WEBDAV protocols is handled by the Apache web server
+together with the Subversion Apache module (mod_dav_svn).</P>
+<H4 LANG="en-US" CLASS="western">Authentication and authorization of
+repository access</H4>
+<P LANG="en-US" CLASS="western">The authentication of users trying to
+access documents is implemented by any suitable Apache authentication
+module. The folder based authorization is implemented by the
+mod_authz_svn Apache module.</P>
+<H3 LANG="en-US" CLASS="western">2.2.2iDok service daemon</H3>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">The iDok
+service daemon is designed to add the features missing in the
+Apache/Subversion combination to make iDok a document management
+system. Clients access the iDok service daemon through the CORBA
+protocol.
+</P>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">The
+following sections describe the features provided by the iDok service
+daemon.
+</P>
+<H4 LANG="en-US" CLASS="western">Administration tool</H4>
+<UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">Creating
+ iDok projects and repositories</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Setting
+ folder based access permissions</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">Defining
+ groups of users</P>
+</UL>
+<H4 LANG="en-US" CLASS="western">Search</H4>
+<UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Answer
+ search queries</P>
+</UL>
+<H4 LANG="en-US" CLASS="western">Scripting Interface</H4>
+<UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Execute
+ iDok command lines</P>
+</UL>
+<H3 LANG="en-US" CLASS="western">2.2.3iDok indexer</H3>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">The iDok
+indexer crawls all documents and build a search using the document
+content and meta data. The indexer is implemented using the Apache
+Lucene search engine library and needs a set of additional Java
+libraries and 3<SUP>rd</SUP> party applications to index various file
+formats.</P>
+<H1 LANG="en-US" CLASS="western">3Requirements</H1>
+<H2 LANG="en-US" CLASS="western">3.1Building</H2>
+<UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">JDK
+ 1.5 or newer</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Apache
+ ant</P>
+</UL>
+<UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Qt
+ Jambi opensource edition, (from
+ <CODE CLASS="western"><A
HREF="http://trolltech.com/downloads/opensource";>http://trolltech.com/downloads/opensource</A></CODE>,
+ for building the GUI client)</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Doxygen
+ (optionally for building the API documentation)</P>
+</UL>
+<UL>
+ <LI VALUE=1><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">
+ Linux operating system</P>
+</UL>
+<H2 LANG="en-US" CLASS="western">3.2Server</H2>
+<UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Apache
+ web server</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">Subversion</P>
+</UL>
+<UL>
+ <UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">Apache
+ Subversion modules (mod_dav_svn and mod_authz_svn)</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">Subversion
+ command line tools (svn and svnadmin)</P>
+ </UL>
+</UL>
+<UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">OpenOffice
+ (required for indexing OpenOffice and Microsoft Office documents)</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">JRE
+ 1.5 or newer</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Linux
+ operating system</P>
+</UL>
+<H2 LANG="en-US" CLASS="western">3.3Client</H2>
+<UL>
+ <LI VALUE=1><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm">
+ JRE 1.5 or newer</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Qt
+ Jambi opensource edition, (from
+ <CODE CLASS="western"><A
HREF="http://trolltech.com/downloads/opensource";>http://trolltech.com/downloads/opensource</A></CODE>,
+ for the GUI client)</P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Java
+ Webstart (optionally for starting the GUI client). When using Java
+ webstart Qt Jambi is downloaded automatically from the server along
+ with the necessary Qt runtime libraries.
+ </P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Windows
+ or Linux operating system</P>
+</UL>
+<H1 LANG="en-US" CLASS="western">4Obtaining the iDok source code</H1>
+<P LANG="en-US" CLASS="western">Get the iDok source code either by
+downloading the most recent tarball or by checking out from the
+Subversion repository. Visit</P>
+<P LANG="en-US" CLASS="western" ALIGN=CENTER><A
HREF="http://www.idok.ch/downloads/";>http://www.idok.ch/downloads/</A></P>
+<P LANG="en-US" CLASS="western">for further instructions.</P>
+<H1 LANG="en-US" CLASS="western">5Building the Java code</H1>
+<P LANG="en-US" CLASS="western">Make sure that the <CODE
CLASS="western">idlj</CODE>
+and <CODE CLASS="western">juic</CODE> executables are available and
+in the PATH. <CODE CLASS="western">idlj</CODE> generates Java code
+from CORBA IDL files. <CODE CLASS="western">juic</CODE> generates
+Java code from Qt Jambi UI files.</P>
+<P LANG="en-US" CLASS="western">Build the Java source code running
+the ant tool from the main iDok directory (holding the file
+<CODE CLASS="western">build.xml</CODE>) as follows</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$ ant
dist</PRE><H1 LANG="en-US" CLASS="western">
+6Local test server</H1>
+<H2 LANG="en-US" CLASS="western">6.1Installation</H2>
+<P LANG="en-US" CLASS="western">The ant build file <CODE
CLASS="western">local-server.xml</CODE>
+can be used for setting up an a local iDok server. Such a locally
+running server is intended mainly for testing and debugging purposes.</P>
+<P LANG="en-US" CLASS="western">The local server hold all its data
+and configuration files in a directory tree under <CODE
CLASS="western">/tmp/idok_server</CODE>.</P>
+<H3 LANG="en-US" CLASS="western">6.1.1Create directory structure</H3>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">To
+generate the necessary directory structures under <CODE
CLASS="western">/tmp/idok_server</CODE>
+and some test data run <CODE CLASS="western">ant</CODE> as follows:</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$ ant -f
local-server.xml init-server-dirs</PRE><P LANG="en-US" CLASS="western">
+The <CODE CLASS="western">svnadmin</CODE> executable need to be in
+the PATH for this to work.</P>
+<H3 LANG="en-US" CLASS="western">6.1.2Create test repository</H3>
+<P LANG="en-US" CLASS="western">A test repository containing some
+sample documents can be generated using the following command.</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$ ant -f
local-server.xml create-test-project-svn</PRE><P LANG="en-US" CLASS="western">
+The <CODE CLASS="western">svnadmin</CODE> executable need to be in
+the PATH for this to work.</P>
+<H3 LANG="en-US" CLASS="western">6.1.3Start CORBA naming service</H3>
+<P LANG="en-US" CLASS="western">A naming service is needed to enable
+clients to connect to the server using CORBA.</P>
+<P LANG="en-US" CLASS="western">You can start the CORBA naming
+service by running</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$ ant -f
local-server.xml start-server-orbd</PRE><P LANG="en-US" CLASS="western"
STYLE="margin-bottom: 0cm">
+Note, that this command will not return to the command prompt as long
+as the daemon is running.</P>
+<H3 LANG="en-US" CLASS="western">6.1.4Start iDok service</H3>
+<P LANG="en-US" CLASS="western">Start the iDok service daemon by
+running</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$ ant -f
local-server.xml start-server-jacorb</PRE><P LANG="en-US" CLASS="western">
+Note, that this command will not return to the command prompt as long
+as the daemon is running.</P>
+<H3 LANG="en-US" CLASS="western">6.1.5Start iDok indexer</H3>
+<P LANG="en-US" CLASS="western">Start the indexer daemon by running</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$ ant -f
local-server.xml start-indexer</PRE><H3 LANG="en-US" CLASS="western">
+6.1.6Log files</H3>
+<P LANG="en-US" CLASS="western">The CORBA naming service, the iDok
+service and the iDok indexer write logging informations to files in
+the directory <CODE CLASS="western">/tmp/idok_server/log</CODE>. If
+these server processes cause trouble, the log files might prove to be
+useful.</P>
+<H3 LANG="en-US" CLASS="western">6.1.7Initialize the authorization
+database</H3>
+<P LANG="en-US" CLASS="western">Finally the iDok daemon must be
+instructed to perform a one time initialization of its authorization
+database. This can be achieved by running the idok_admin script as
+follows:</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$
scripts/unix/idok_admin init_auth_db</PRE><P LANG="en-US" CLASS="western">
+Log in as user <CODE CLASS="western">idokadmin</CODE> with the
+password <CODE CLASS="western">pass</CODE>.</P>
+<H3 LANG="en-US" CLASS="western">6.1.8Apache web server</H3>
+<P LANG="en-US" CLASS="western">The Apache web server together with
+the <CODE CLASS="western">mod_dav_svn</CODE> and <CODE
CLASS="western">mod_</CODE><CODE CLASS="western">authz_svn</CODE>
+modules are responsible for implementing the read and write access to
+the documents stored in iDok repositories over the HTTP(S) and
+WEBDAV(S) protocols, including authentication and authorization.</P>
+<P LANG="en-US" CLASS="western">The actual Apache configuration is
+system dependent. Thus the configuration shown below might have to be
+adapted.</P>
+<P LANG="en-US" CLASS="western">The iDok service daemon automatically
+generates per repository configuration files in the directory
+<CODE CLASS="western">/tmp/idok_server/httpd/conf.d </CODE>Apache
+should be configured to include any file matching the pattern <CODE
CLASS="western">*.conf</CODE>
+in that directory.</P>
+<H4 LANG="en-US" CLASS="western">Load subversion modules</H4>
+<P LANG="en-US" CLASS="western">The <CODE CLASS="western">mod_dav_svn</CODE>
+and <CODE CLASS="western">mod_authz_svn</CODE> modules are loaded
+e.g. as follows.
+</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">LoadModule
dav_svn_module /usr/lib/apache2/modules/mod_dav_svn.so
+<SPAN LANG="zxx">LoadModule authz_svn_module
/usr/lib/apache2/modules/mod_authz_svn.so </SPAN></PRE><H4 LANG="en-US"
CLASS="western">
+Configure authentication</H4>
+<P LANG="en-US" CLASS="western">The Apache authentication can be
+configured in many ways. The important thing to remember is, that the
+Apache authentication should match the JAAS based authentication done
+by iDok.</P>
+<P LANG="en-US" CLASS="western">The iDok default authentication
+configuration simply defines two users <CODE CLASS="western">idokadmin</CODE>
+and <CODE CLASS="western">idokuser</CODE> (both with password <CODE
CLASS="western">pass</CODE>).
+</P>
+<P LANG="en-US" CLASS="western">In Apache, one can define the same
+user accounts in a password file <CODE
CLASS="western">/tmp/idok_server/httpd/passwd
+</CODE>using the <CODE CLASS="western">htpasswd</CODE> tool and
+reference that password in the configuration:</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">&lt;Location
/&gt;
+ <SPAN LANG="zxx">AuthType Basic </SPAN>
+ <SPAN LANG="zxx">AuthName &quot;iDok login&quot; </SPAN>
+ <SPAN LANG="zxx">AuthUserFile /tmp/idok_server/httpd/passwd </SPAN>
+<SPAN LANG="zxx">&lt;/Location&gt; </SPAN></PRE><H4 LANG="en-US"
CLASS="western">
+Configure repository access</H4>
+<P LANG="en-US" CLASS="western">The iDok service daemon automatically
+generates Apache configuration for all repositories. For the local
+test installation these configuration files are located in the
+directory <CODE CLASS="western">/tmp/idok_server/httpd/conf.d</CODE></P>
+<P LANG="en-US" CLASS="western">Apache needs to be configured in such
+a way that the files in <CODE
CLASS="western">/tmp/idok_server/httpd/conf.d</CODE>
+are automatically loaded:</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">Include
/tmp/idok_server/httpd/conf.d/*.conf</PRE><H2 LANG="en-US" CLASS="western">
+6.2Using the local server</H2>
+<P LANG="en-US" CLASS="western">Visit
+<A
HREF="http://www.idok.ch/documentation/";>http://www.idok.ch/documentation/</A>
+for accessing the iDok user manuals. The following sections just
+contain the information specific to using the local test server.</P>
+<P LANG="en-US" CLASS="western">The start scripts in the directory
+<CODE CLASS="western">scripts/unix</CODE> can be used to run the
+graphical user interface, the command line tool and the command line
+administration tool.</P>
+<P LANG="en-US" CLASS="western">Windows variants of these start
+scripts are under <CODE CLASS="western">scripts/windows</CODE>.</P>
+<H3 LANG="en-US" CLASS="western">6.2.1Starting the graphical user
+interface</H3>
+<P LANG="en-US" CLASS="western">Start the graphical user interface
+using</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$ <CODE
CLASS="western">scripts/unix/idok_gui &amp;</CODE></PRE><P LANG="en-US"
CLASS="western" STYLE="margin-bottom: 0cm">
+In the GUI open the test repository <A
HREF="http://localhost/foo/bar";>http://localhost/foo/bar</A>.
+Login as user <CODE CLASS="western">idokadmin</CODE> with password
+<CODE CLASS="western">pass</CODE> when prompted.</P>
+<H3 LANG="en-US" CLASS="western">6.2.2Starting the command line
+client</H3>
+<P LANG="en-US" CLASS="western">E.g. run the following command to
+list the sample repository content:</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$
scripts/unix/idok list -Rv <A
HREF="http://localhost/foo/bar";>http://localhost/foo/bar</A> </PRE><H3
LANG="en-US" CLASS="western">
+6.2.3Starting the command line administration client</H3>
+<P LANG="en-US" CLASS="western">E.g. list the content of the
+authorization database by runnung the following command:</P>
+<PRE LANG="zxx" CLASS="western" STYLE="margin-left: 1.25cm">$
scripts/unix/idok query</PRE><H1 LANG="en-US" CLASS="western">
+7Preconfigured test server</H1>
+<P LANG="en-US" CLASS="western">The preconfigured test server is
+provided as a downloadable VMware image and is based on an Ubuntu
+7.10 server installation.</P>
+<P LANG="en-US" CLASS="western">It is setup almost identically to the
+local server discussed above. The main difference is that the server
+data is located under <CODE CLASS="western">/var/lib/idok_server</CODE>
+instead of <CODE CLASS="western">/tmp/idok_server</CODE>.</P>
+<H2 LANG="en-US" CLASS="western">7.1Downloading</H2>
+<P LANG="en-US" CLASS="western">Please visit
+<A
HREF="http://www.idok.ch/downloads/downloads-vmware/";>http://www.idok.ch/downloads/downloads-vmware/</A>
+for download instructions.</P>
+<H2 LANG="en-US" CLASS="western">7.2Running</H2>
+<P LANG="en-US" CLASS="western">Theoretically the preconfigured test
+server <I>should</I> run out-of-the-box. However...</P>
+<H2 LANG="en-US" CLASS="western">7.3Apache configuration</H2>
+<H3 LANG="en-US" CLASS="western">7.3.1Important files</H3>
+<H2 LANG="en-US" CLASS="western">7.4init.d scripts for starting and
+stopping iDok services</H2>
+<H2 LANG="en-US" CLASS="western">7.5JNLP files</H2>
+<H1 LANG="en-US" CLASS="western">8Server installation</H1>
+<H2 LANG="en-US" CLASS="western">8.1Configuring Java Webstart</H2>
+<H3 LANG="en-US" CLASS="western">8.1.1Example test server</H3>
+<H3 LANG="en-US" CLASS="western">8.1.2Delivering a JNLP file</H3>
+<H3 LANG="en-US" CLASS="western">8.1.3Signing JAR files</H3>
+<H2 LANG="en-US" CLASS="western">8.2Deploying the software</H2>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">The deploy
+process takes care of transferring the runtime files (typically
+bundled in several JAR files) from the local machine (where the files
+are built) to the server. This process is very site specific. It can
+be accomplished by e.g. secure copy, ftp or rsync.
+</P>
+<H2 LANG="en-US" CLASS="western">8.3Starting the server processes</H2>
+<H2 LANG="en-US" CLASS="western">8.4Site specific customization</H2>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Many iDok
+settings can be tailored by adjusting the appropriate Java system
+properties. Currently there is no documentation that lists and
+explains all available properties. The local-server.xml file might
+give you an idea.
+</P>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Some
+customizations require more than just setting a few properties. This
+is covered in the following sections.
+</P>
+<H3 LANG="en-US" CLASS="western">8.4.1User authentication</H3>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">In any
+serious usage scenario, the authentication scheme probably needs to
+be tailored to site specific needs. Both the Apache web server and
+the iDok service daemon authenticate users in their own manner.
+Apache uses its authentication modules and iDok uses the JAAS
+modules. Typically both Apache and iDok access the same user
+database, whether it is Active Directory or a simple text file or
+something else.
+</P>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">The JAAS
+authentication is configured in the following files:
+</P>
+<UL>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm;
font-style: normal">
+ java/ch/idok/common/config/jaas.conf
+ </P>
+ <LI><P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm;
font-style: normal">
+ sites/psi/java/ch/psi/idok/common/config/jaas.conf
+ </P>
+</UL>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm; font-style:
normal">
+<BR>
+</P>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">The first
+file holds the simple demo configuration for the local server and the
+test server. The second file configures JAAS to use an Active
+Directory server.
+</P>
+<H3 LANG="en-US" CLASS="western">8.4.2E-mail notifications</H3>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">iDok can
+be configured to send E-mail notification messages to users whenever
+a repository is changed. This feature is implemented using Subversion
+post-commit hook scripts. The local server and the test server do not
+use this feature.
+</P>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">However a
+site-specific implementation of the ProjectAndRepositoryCreator
+interface can install the necessary hook script and configuration
+file. See
+</P>
+<UL>
+ <LI VALUE=1><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm; font-style: normal">
+ sites/psi/python/svn_hooks/mailer.py
+ </P>
+</UL>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm; font-style:
normal">
+<BR>
+</P>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">for an
+example hook script and
+</P>
+<UL>
+ <LI VALUE=1><P LANG="en-US" CLASS="western" STYLE="margin-bottom:
0cm; font-style: normal">
+
sites/psi/java/ch/psi/idok/service/server/admin/PSIProjectAndRepositoryCreator.java
+ </P>
+</UL>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm; font-style:
normal">
+<BR>
+</P>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">an example
+class that installs a hook script whenever a new repository is
+created.</P>
+<H1 LANG="en-US" CLASS="western">9Production use</H1>
+<H2 LANG="en-US" CLASS="western">9.1Security</H2>
+<H3 LANG="en-US" CLASS="western">9.1.1Using SSL</H3>
+<H4 LANG="en-US" CLASS="western">Encrypting repository access</H4>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">HTTPS and
+WEBDAVS</P>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">Apache
+configuration</P>
+<P LANG="en-US" CLASS="western" STYLE="margin-bottom: 0cm">mod_ssl</P>
+<H4 LANG="en-US" CLASS="western">Encrypting CORBA traffic</H4>
+<H2 LANG="en-US" CLASS="western">9.2Single Sign On</H2>
+<H3 LANG="en-US" CLASS="western">9.2.1Kerberos/Active Directory</H3>
+<H3 LANG="en-US" CLASS="western">9.2.2Java configuration</H3>
+<H4 LANG="en-US" CLASS="western">JAAS</H4>
+<H3 LANG="en-US" CLASS="western">9.2.3Apache configuration</H3>
+<H4 LANG="en-US" CLASS="western">mod_auth_kerb</H4>
+</BODY>
+</HTML>
\ No newline at end of file



  • [idok-commit] idok commit r757 - trunk, AFS account Roman Geus, 02/25/2008

Archive powered by MHonArc 2.6.19.

Top of Page