Return-Path: X-Original-To: apmail-incubator-connectors-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-connectors-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4A73116BB for ; Fri, 22 Apr 2011 09:34:11 +0000 (UTC) Received: (qmail 34791 invoked by uid 500); 22 Apr 2011 09:34:11 -0000 Delivered-To: apmail-incubator-connectors-commits-archive@incubator.apache.org Received: (qmail 34758 invoked by uid 500); 22 Apr 2011 09:34:10 -0000 Mailing-List: contact connectors-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: connectors-dev@incubator.apache.org Delivered-To: mailing list connectors-commits@incubator.apache.org Received: (qmail 34751 invoked by uid 99); 22 Apr 2011 09:34:10 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 22 Apr 2011 09:34:10 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 22 Apr 2011 09:34:07 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 054E0238899C; Fri, 22 Apr 2011 09:33:46 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1095899 - in /incubator/lcf/trunk: CHANGES.txt site/src/documentation/content/xdocs/how-to-build-and-deploy.xml Date: Fri, 22 Apr 2011 09:33:45 -0000 To: connectors-commits@incubator.apache.org From: kwright@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110422093346.054E0238899C@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: kwright Date: Fri Apr 22 09:33:45 2011 New Revision: 1095899 URL: http://svn.apache.org/viewvc?rev=1095899&view=rev Log: Fix for CONNECTORS-185. Clarify the multiprocess deployment instructions. Modified: incubator/lcf/trunk/CHANGES.txt incubator/lcf/trunk/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml Modified: incubator/lcf/trunk/CHANGES.txt URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/CHANGES.txt?rev=1095899&r1=1095898&r2=1095899&view=diff ============================================================================== --- incubator/lcf/trunk/CHANGES.txt (original) +++ incubator/lcf/trunk/CHANGES.txt Fri Apr 22 09:33:45 2011 @@ -2,6 +2,9 @@ ManifoldCF Change Log $Id$ ======================= 0.3-dev ========================= +CONNECTORS-185: Clarify the build-and-deploy document to make sure +it is clear that the configfile define is needed for the application server. +(Mark Moloney, Karl Wright) CONNECTORS-183: Add a text field to make Active Directory authority configuration more flexible with regards to protocol. Modified: incubator/lcf/trunk/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml?rev=1095899&r1=1095898&r2=1095899&view=diff ============================================================================== --- incubator/lcf/trunk/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml (original) +++ incubator/lcf/trunk/site/src/documentation/content/xdocs/how-to-build-and-deploy.xml Fri Apr 22 09:33:45 2011 @@ -302,12 +302,12 @@ cd dist/example

The basic steps required to set up and run ManifoldCF are as follows:

    -
  • Check out and build, using "ant". The default target builds everything.
    • -
  • Install postgresql. The postgresql JDBC driver included with ManifoldCF is known to work with version 8.3.x, so that version is the currently recommended one. Configure postgresql for your environment; the default configuration is acceptable for testing and experimentation.
    • +
  • Check out and build, using "ant build".
    • +
  • Install postgresql. The postgresql JDBC driver included with ManifoldCF is known to work with version 8.4.x, so that version is the currently recommended one. Configure postgresql for your environment; the default configuration is acceptable for testing and experimentation.
  • Install a Java application server, such as Tomcat.
    • -
  • Create a home directory for ManifoldCF. To do this, make a copy of the contents of dist from the build. In this directory, create properties.ini and logging.ini, as described above. Note that you will also need to create a synchronization directory, also detailed above, and refer to this directory within your properties.xml.
    • +
  • Create a home directory for ManifoldCF. To do this, make a copy of the contents of dist from the build. In this directory, create properties.xml and logging.ini, as described above. Note that you will also need to create a synchronization directory, also detailed above, and refer to this directory within your properties.xml.
  • Deploy the war files in <MCF_HOME>/web/war to your application server.
    • -
  • Set the starting environment variables for your app server to include the -D commands found in <MCF_HOME>/web/define. The -D commands should be of the form, "-D<file name>=<file contents>".
    • +
  • Set the starting environment variables for your app server to include the -D commands found in <MCF_HOME>/web/define. The -D commands should be of the form, "-D<file name>=<file contents>". You will also need a "-Dorg.apache.manifoldcf.configfile=<properties file>" define option, or the equivalent, in the application server's JVM startup in order for ManifoldCF to be able to locate its configuration file.
  • Use the <MCF_HOME>/processes/script/executecommand.bat command from execute the appropriate commands from the next section below, being sure to first set the JAVA_HOME and MCF_HOME environment variables properly.
  • Start any supporting processes that result from your build. (Some connectors such as Documentum and FileNet have auxiliary processes you need to run to make these connectors functional.)
  • Start your application server.
    • @@ -533,7 +533,8 @@ log4j.appender.MAIN.layout.ConversionPat org.apache.manifoldcf.authorities.SynchronizeAuthoritiesNoneUn-register all registered authority connector classes that can't be found

    -

    Remember that you need to include all the jars under module/dist/processes in the classpath whenever you run one of these commands! You also must include the corresponding -D switches, as described earlier.

    +

    Remember that you need to include all the jars under dist/processes/jar in the classpath whenever you run one of these commands! You also must include the corresponding -D switches if present, as described earlier. But, luckily, there are scripts which do all of this available. These can be found in dist/processes/script/executecommand[.sh,.bat]. + The scripts require some environment variables to be set, such as MCF_HOME and JAVA_HOME, and expect the configuration file to be found at MCF_HOME/properties.xml.

    @@ -571,9 +572,15 @@ log4j.appender.MAIN.layout.ConversionPat
    Deploying the <strong>mcf-crawler-ui</strong>, <strong>mcf-authority-service</strong>, and <strong>mcf-api-service</strong> web applications

    -

    If you built ManifoldCF using ant under the trunk directory, then the ant build will have constructed three war files for you under dist/web. Take these war files and deploy them as web applications under one or more instances of your application server. There is no requirement that the mcf-crawler-ui, mcf-authority-service, and mcf-api-service web applications be deployed on the same instance of the application server. With the current architecture of ManifoldCF, they must be deployed on the same physical server, however.

    -

    -

    Under dist/web, you may also see files that are not war files. These files are meant to be used as command-line -D switches for the application server process. The switches may or may not be identical for the two web applications, but they will never conflict. You may need to alter environment variables or your application server startup scripts in order to provide these switches. (More about this in the future...)

    +

    If you built ManifoldCF using ant under the trunk directory, then the ant build will have constructed three war files for you under dist/web. Take these war + files and deploy them as web applications under one or more instances of your application server. There is no requirement that the mcf-crawler-ui, mcf-authority-service, and mcf-api-service web + applications be deployed on the same instance of the application server. With the current architecture of ManifoldCF, they must be deployed on the same physical server, however.

    +

    +

    For each of the application servers involved with ManifoldCF, you must set the following define, so that the ManifoldCF web applications can locate the configuration file:

    +

    -Dorg.apache.manifoldcf.configfile=<configuration file path>

    +

    Under dist/web/define, if it exists at all, you may also see files that are not war files. These files are meant to be used as command-line -D switches for the application server process. + The switches may or may not be identical for the two web applications, but they will never conflict. You may need to alter environment variables or your application server startup scripts in order to + provide these switches. Luckily, no existing connectors require these at this time.