incubator-connectors-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kwri...@apache.org
Subject svn commit: r1214143 - /incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml
Date Wed, 14 Dec 2011 10:25:26 GMT
Author: kwright
Date: Wed Dec 14 10:25:26 2011
New Revision: 1214143

URL: http://svn.apache.org/viewvc?rev=1214143&view=rev
Log:
More documentation fixes

Modified:
    incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml

Modified: incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml?rev=1214143&r1=1214142&r2=1214143&view=diff
==============================================================================
--- incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml
(original)
+++ incubator/lcf/branches/CONNECTORS-313/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml
Wed Dec 14 10:25:26 2011
@@ -79,8 +79,7 @@
         <table>
           <caption>Distribution directories</caption>
           <tr><th><em>dist</em> directory</th><th>Meaning</th></tr>
-          <tr><td><em>web</em></td><td>Web applications
that should be deployed on tomcat or the equivalent, plus recommended application server -D
switch names and values</td></tr>
-          <tr><td><em>processes</em></td><td>classpath
jars that should be included in the class path for all non-connector-specific processes, along
with -D switches, using the same convention as described for tomcat, above</td></tr>
+          <tr><td><em>connectors.xml</em></td><td>an
xml file describing the connectors that should be registered</td></tr>
           <tr><td><em>connector-lib</em></td><td>jars
for all the connectors, referred to by properties.xml</td></tr>
           <tr><td><em>wsdd</em></td><td>wsdd files that
are needed by the included connectors in order to function</td></tr>
           <tr><td><em>xxx-process</em></td><td>scripts,
classpath jars, and -D switch values needed for a required connector-specific process</td></tr>
@@ -91,12 +90,13 @@
           <tr><td><em>xxx-integration</em></td><td>pre-built
integration components to deploy on target system "xxx", e.g. Solr</td></tr>
         </table>
         <p></p>
-        <p>For all of the <em>dist</em> subdirectories above (except for
<em>wsdd</em>, which does not correspond to a process), any scripts resulting
from the build that pertain to that process will be placed in a <em>script</em>
subdirectory.  Thus, the scripts for the <em>filenet-processes</em> subdirectory
will be found in <em>dist/filenet-processes/script</em>.
-        (This script requires two variables to be set before execution: JAVA_HOME, and MCF_HOME,
which should point to ManifoldCF's home execution directory, described below.)  Indeed, everything
you need to run an ManifoldCF process can be found under <em>dist/processes</em>
when the ant build completes: a <em>define</em> subdirectory containing -D switch
description files, a <em>jar</em> subdirectory where jars are placed, and a <em>war</em>
subdirectory where war files are output.  </p>
+        <p>For all of the <em>dist/xxx-process</em> subdirectories above,
any scripts resulting from the build that pertain to that process will be placed in a <em>script</em>
subdirectory.  Thus, the scripts for the <em>filenet-processes</em> subdirectory
will be found in <em>dist/filenet-processes/script</em>.
+            The supplied scripts for a process generally take care of building an appropriate
classpath and setting necessary -D switches.  (Note: none of the current connectors require
special -D switches
+            at this time.)  If you need to construct a classpath by hand, it is important
to remember that "more" is not necessarily "better".  The process deployment strategy implied
by the build structure has
+            been carefully thought out to avoid jar conflicts.  Indeed, several connectors
are structured using multiple processes precisely for that reason.</p>
         <p></p>
-        <p>The supplied scripts in the <em>script</em> directory for a
process generally take care of building an appropriate classpath and setting necessary -D
switches.  (Note: none of the current connectors require special -D switches at this time.)
 If you need to construct a classpath by hand, it is important to remember that "more" is
not necessarily "better".  The process deployment strategy implied by the build structure
has been carefully thought out to avoid jar conflicts.  Indeed, several connectors are structured
using multiple processes precisely for that reason.</p>
-        <p></p>
-        <p>The <em>xxx-integration</em> directories contain components
you may need to deploy on the target system to make the associated connector function correctly.
 For example, the Solr connector includes plug-in classes for enforcing ManifoldCF security
on Solr 3.x and 4.x.  See the README file in each directory for detailed instructions on how
to deploy the components.</p>
+        <p>The <em>xxx-integration</em> directories contain components
you may need to deploy on the target system to make the associated connector function correctly.
 For example, the Solr
+            connector includes plug-in classes for enforcing ManifoldCF security on Solr
3.x and 4.x.  See the README file in each directory for detailed instructions on how to deploy
the components.</p>
         <p></p>
         <p>Inside the <em>examples</em> directory, you will find everything
you need to fire up ManifoldCF in a single-process model under Jetty.  Everything is included
so that all you need to do is change
             to that directory, and start it using the command <em>&lt;java&gt;
-jar start.jar</em>.  This is described in more detail later, and is the recommended
way for beginners to try out ManifoldCF.</p>
@@ -249,16 +249,8 @@
         <section>
           <title>Preparation</title>
           <p>Before you begin, you will need to install Maven (if you haven't already)
and prepare by downloading the necessary materials to support the LGPL connector builds, just
as you would for the Ant
-              build described in the previous section.  We therefore strongly recommend reading
about the Ant build process before proceeding.</p>
-          <p>Once the LGPL connector prerequisites are in place, you need to push various
ManifoldCF-required jars into your local Maven repository, as follows:</p>
-          <source>
-mvn install:install-file -Dfile=lib/jdbcpool-0.99.jar -DgroupId=com.bitmechanic -DartifactId=jdbcpool
-Dversion=0.99 -Dpackaging=jar
-mvn install:install-file -Dfile=lib/commons-httpclient-mcf.jar -DgroupId=commons-httpclient
-DartifactId=commons-httpclient-mcf -Dversion=3.1 -Dpackaging=jar
-mvn install:install-file -Dfile=lib/xercesImpl-mcf.jar -DgroupId=xerces -DartifactId=xercesImpl-mcf
-Dversion=2.9.1 -Dpackaging=jar
-mvn install:install-file -Dfile=lib/chemistry-opencmis-server-inmemory-war.war -DgroupId=org.apache.chemistry.opencmis
-DartifactId=chemistry-opencmis-server-inmemory-war -Dversion=0.5.0 -Dpackaging=war
-mvn install:install-file -Dfile=connectors/jcifs/jcifs/jcifs.jar -DgroupId=org.samba.jcifs
-DartifactId=jcifs -Dversion=1.3.17 -Dpackaging=jar
-mvn install:install-file -Dfile=lib/hsqldb.jar -DgroupId=org.hsqldb -DartifactId=hsqldb -Dversion=2.2.6.12-04-2011
-Dpackaging=jar
-          </source>
+              build described in the previous section.  Then, you need to push various ManifoldCF-required
jars into your local Maven repository.  The script <em>mvn-bootstrap[.sh|.bat]</em>
will do this for you.
+              This script takes no arguments, but does require internet access in order to
download LGPL jars that are required by the Maven build.</p>
         </section>
         <section>
           <title>How to build</title>
@@ -571,36 +563,7 @@ cd dist/example
         <section>
           <title>Initializing the database</title>
           <p></p>
-          <p>These are some of the commands you will need to use to create the database
instance, initialize the schema, and register all of the appropriate components:</p>
-          <p></p>
-          <table>
-            <tr><th>Command</th><th>Arguments</th></tr>
-            <tr><td>org.apache.manifoldcf.core.DBCreate</td><td>postgres
postgres</td></tr>
-            <tr><td>org.apache.manifoldcf.agents.Install</td><td></td></tr>
-            <tr><td>org.apache.manifoldcf.agents.Register</td><td>org.apache.manifoldcf.crawler.system.CrawlerAgent</td></tr>
-            <tr><td>org.apache.manifoldcf.agents.RegisterOutput</td><td>org.apache.manifoldcf.agents.output.gts.GTSConnector
"GTS Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.agents.RegisterOutput</td><td>org.apache.manifoldcf.agents.output.solr.SolrConnector
"SOLR Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.agents.RegisterOutput</td><td>org.apache.manifoldcf.agents.output.opensearchserver.OpenSearchServerConnector
"OpenSearchServer Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.agents.RegisterOutput</td><td>org.apache.manifoldcf.agents.output.nullconnector.NullConnector
"Null Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.authorities.RegisterAuthority</td><td>org.apache.manifoldcf.authorities.authorities.activedirectory.ActiveDirectoryAuthority
"Active Directory Authority"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.cmis.CmisRepositoryConnector
"CMIS"</td></tr>
-            <tr><td>org.apache.manifoldcf.authorities.RegisterAuthority</td><td>org.apache.manifoldcf.crawler.connectors.cmis.CmisAuthorityConnector
"CMIS"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.DCTM.DCTM
"Documentum Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.authorities.RegisterAuthority</td><td>org.apache.manifoldcf.crawler.authorities.DCTM.AuthorityConnector
"Documentum Authority"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.filenet.FilenetConnector
"FileNet Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.filesystem.FileConnector
"Filesystem Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.jdbc.JDBCConnector
"Database Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.sharedrive.SharedDriveConnector
"Windows Share Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.livelink.LivelinkConnector
"LiveLink Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.authorities.RegisterAuthority</td><td>org.apache.manifoldcf.crawler.connectors.livelink.LivelinkAuthority
"LiveLink Authority"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.memex.MemexConnector
"Memex Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.authorities.RegisterAuthority</td><td>org.apache.manifoldcf.crawler.connectors.memex.MemexAuthority
"Memex Authority"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.meridio.MeridioConnector
"Meridio Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.authorities.RegisterAuthority</td><td>org.apache.manifoldcf.crawler.connectors.meridio.MemexAuthority
"Meridio Authority"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.rss.RSSConnector
"RSS Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.sharepoint.SharePointRepository
"SharePoint Connector"</td></tr>
-            <tr><td>org.apache.manifoldcf.crawler.Register</td><td>org.apache.manifoldcf.crawler.connectors.webcrawler.WebcrawlerConnector
"Web Connector"</td></tr>
-          </table>
+          <p>If you run the multiprocess model, you will need to initialize the database
before you start the agents process or use the crawler UI.  ???</p>
           <p></p>
         </section>
         <section>
@@ -629,7 +592,7 @@ cd dist/example
         <p>Connector-specific processes require the classpath for their invocation
to include all the jars that are in the corresponding <em>dist/&#60;process_name&#62;-process</em>
directory.  The Documentum and FileNet connectors are the only two connectors that currently
require additional processes.  Start these processes using the commands listed below, and
stop them with SIGTERM (or ^C, if they are running in a shell).</p>
           <p></p>
           <table>
-            <tr><th>Connector</th><th>Process</th><th>Main
class</th><th>Script name (relative to MCF_HOME)</th></tr>
+            <tr><th>Connector</th><th>Process</th><th>Main
class</th><th>Script name (relative to <em>dist</em>)</th></tr>
             <tr><td>Documentum</td><td>documentum-server-process</td><td>org.apache.manifoldcf.crawler.server.DCTM.DCTM</td><td>documentum-server-process/script/run[.sh|.bat]</td></tr>
             <tr><td>Documentum</td><td>documentum-registry-process</td><td>org.apache.manifoldcf.crawler.registry.DCTM.DCTM</td><td>documentum-registry-process/script/run[.sh|.bat]</td></tr>
             <tr><td>FileNet</td><td>filenet-server-process</td><td>org.apache.manifoldcf.crawler.server.filenet.Filenet</td><td>filenet-server-process/script/run[.sh|.bat]</td></tr>



Mime
View raw message