Modified: manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml URL: http://svn.apache.org/viewvc/manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml?rev=1631727&r1=1631726&r2=1631727&view=diff ============================================================================== --- manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml (original) +++ manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml Tue Oct 14 12:09:05 2014 @@ -160,7 +160,7 @@ <p>If you need to supply DFC classes during build time, copy the DFC and dependent jars to the source directory <em>connectors/documentum/lib-proprietary</em>, and build using "ant build". The jars will be copied into the right place in your <em>dist</em> directory automatically.</p> - <p>For a binary distribution, just copy the DFC jars to <em>documentum-server-process/lib-proprietary</em> instead.</p> + <p>For a binary distribution, just copy the DFC jars to <em>processes/documentum-server/lib-proprietary</em> instead.</p> <p>If you have done everything right, you should be able to start the Documentum connector's registry and server processes, as per the instructions.</p> <p></p> </section> @@ -174,7 +174,7 @@ <p>If you need to supply your own Jace.jar at build time, copy it to the source directory <em>connectors/filenet/lib-proprietary</em>, and build using "ant build". The Jace.jar will be copied into the right place in your <em>dist</em> directory automatically.</p> <p>If you do not wish to build, simply copy your Jace.jar and the other dependent jars from that installation into the distribution directory - <em>filenet-server-process/lib-proprietary</em>.</p> + <em>processes/filenet-server/lib-proprietary</em>.</p> <p>If correctly done, you will be able to start the FileNet connector's registry and server processes, as per the instructions.</p> <p></p> </section> @@ -317,7 +317,7 @@ <source> mvn clean install </source> - <p>This should generate all the necessary artifacts to run with, and also run the Apache Derby-based tests.</p> + <p>This should generate all the necessary artifacts to run with, and also run the Hsqldb-based tests.</p> <p>To build and skip only the integration tests, type:</p> <source> mvn clean install -DskipITs @@ -378,7 +378,7 @@ mvn clean package <tr><td><em>connector-lib-proprietary</em></td><td>proprietary jars for all the connectors, referred to by properties.xml; not included in binary release</td></tr> <tr><td><em>lib</em></td><td>jars for all of the examples, referenced by the example scripts</td></tr> <tr><td><em>lib-proprietary</em></td><td>proprietary jars for all of the examples, referenced by the proprietary example scripts</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> + <tr><td><em>processes</em></td><td>scripts, classpath jars, and -D switch values needed for the required connector-specific processes</td></tr> <tr><td><em>script-engine</em></td><td>jars and scripts for running the ManifoldCF script interpreter</td></tr> <tr><td><em>example</em></td><td>a jetty-based example that runs in a single process (except for any connector-specific processes), excluding all proprietary libraries</td></tr> <tr><td><em>example-proprietary</em></td><td>a jetty-based example that runs in a single process (except for any connector-specific processes), including proprietary libraries; not included in binary release</td></tr> @@ -389,7 +389,7 @@ mvn clean package <tr><td><em>web</em></td><td>app-server deployable web applications (wars), excluding all proprietary libraries</td></tr> <tr><td><em>web-proprietary</em></td><td>app-server deployable web applications (wars), including proprietary libraries; not included in binary release</td></tr> <tr><td><em>doc</em></td><td>javadocs for framework and all included connectors</td></tr> - <tr><td><em>xxx-integration</em></td><td>pre-built integration components to deploy on target system "xxx", e.g. Solr</td></tr> + <tr><td><em>plugins</em></td><td>pre-built integration components to deploy on target systems, e.g. for Solr</td></tr> </table> <p></p> <p>If you downloaded the binary distribution, you may notice that the <em>connector-lib-proprietary</em> directory contains only a number of @@ -402,19 +402,19 @@ mvn clean package distribution. In order to use these JDBC drivers, you must build ManifoldCF yourself. Start by downloading the drivers and placing them in the <em>lib-proprietary</em> directory. The command <em>ant download-dependencies</em> will do most of this for you, with the exception of the Oracle JDBC driver.</p> <p></p> - <p>The directories titled <em>xxx-process</em> represent separate processes which must be started in order for the associated connector to function. - The number of produced <em>xxx-process</em> directories may vary, because optional individual connectors may or may not supply processes that - must be run to support the connector. For each of the <em>xxx-process</em> subdirectories above, any scripts that pertain to that connector-supplied + <p>The directory titled <em>processes</em> include separate processes which must be started in order for the associated connector to function. + The number of produced <em>processes</em> subdirectories may vary, because optional individual connectors may or may not supply processes that + must be run to support the connector. For each of the <em>processes</em> subdirectories above, any scripts that pertain to that connector-supplied process will be placed in the root level of the subdirectory. 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>The proprietary libraries required by the secondary process <em>xxx-process</em> should be in the directory <em>xxx-process/lib-proprietary</em>. + <p>The proprietary libraries required by the secondary process <em>processes</em> subdirectories should be in the directory <em>processes/xxx/lib-proprietary</em>. These jars are not included in the binary distribution, and you will need to supply them in order to make the process work. A README.txt file is placed in each <em>lib-proprietary</em> directory describing what needs to be provided there.</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 + <p>The <em>plugins</em> directory contains 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>example</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 @@ -438,7 +438,7 @@ mvn clean package <section> <title>Quick-start single process model</title> <p></p> - <p>You can run most of ManifoldCF in a single process, for evaluation and convenience. This single-process version uses Jetty to handle its web applications, and Derby as + <p>You can run most of ManifoldCF in a single process, for evaluation and convenience. This single-process version uses Jetty to handle its web applications, and Hsqldb as an embedded database. All you need to do to run this version of ManifoldCF is to follow the Ant-based build instructions above, and then:</p> <p></p> <source> @@ -452,14 +452,14 @@ cd example <p></p> <p>You can stop the quick-start ManifoldCF at any time using ^C.</p> <p></p> - <p>Bear in mind that Derby is not as full-featured a database as is PostgreSQL. This means that any performance testing you may do against the quick start example may - not be applicable to a full installation. Furthermore, Derby only permits one process at a time to be connected to its databases, so you <strong>cannot</strong> use any + <p>Bear in mind that Hsqldb is not as full-featured a database as is PostgreSQL. This means that any performance testing you may do against the quick start example may + not be applicable to a full installation. Furthermore, embedded Hsqldb only permits one process at a time to be connected to its databases, so you <strong>cannot</strong> use any of the ManifoldCF commands (as described below) while the quick-start ManifoldCF is running.</p> <p></p> <p>Another caveat that you will need to be aware of with the quick-start version of ManifoldCF is that it in no way removes the need for you to run any separate processes that individual connectors require. Specifically, the Documentum and FileNet connectors require processes to be independently started in order to function. You will need to read about these connector-specific processes below in order to use the corresponding connectors. Scripts for running these processes can be found in the directories - named <em>xxx-process</em>.</p> + named <em>processes/xxx</em>.</p> <p></p> </section> @@ -478,7 +478,7 @@ cd example <p>The combined web service presents the crawler UI at the root path for the web application, which is <em>http://<host>:8345/mcf/</em>. The authority service functionality can be found at <em>http://<host>:8345/mcf/UserACLs</em>, similar to the quick-start example. However, the programmatic API service has a path other than the root: <em>http://<host>:8345/mcf/api/</em>.</p> - <p>The script that starts the combined-service web application uses the same database instance (Derby by default) as does the quick-start, and the same <em>properties.xml</em> + <p>The script that starts the combined-service web application uses the same database instance (Hsqldb by default) as does the quick-start, and the same <em>properties.xml</em> file. The same caveats about required individual connector processes also apply as they do for the quick-start example.</p> <p></p> @@ -828,7 +828,6 @@ cd example <li>PostgreSQL (preferred)</li> <li>MySQL (preferred)</li> <li>HSQLDB</li> - <li>Derby (not recommended for production)</li> </ul> <p>You can select the database of your choice by setting the approprate properties in the applicable <em>properties.xml</em> file. The choice of database is largely orthogonal to the choice of deployment model. The ManifoldCF deployment examples provided can thus be readily altered to use the database you desire. The details and caveats of @@ -916,16 +915,6 @@ cd example process. See the <em>properties.xml</em> property descriptions for configuration details.</p> </section> - <section> - <title>Configuring an Apache Derby database</title> - <p></p> - <p>Apache Derby can be used with ManifoldCF only as an embedded database, working with single-process deployments. Its performance currently seems limited by - issues related to its planner and to its handling of deadlock conditions, but this situation could change any time there is a new release of the Derby software. Nevertheless, even - when operating without any apparent stalls due to the above issues, Derby is still only about 1/4 as fast as PostgreSQL. At the moment this limits Derby's utility for - ManifoldCF to demonstration and testing.</p> - </section> - - </section> <section> @@ -971,7 +960,7 @@ cd example <tr><td>org.apache.manifoldcf.dbsuperuserpassword</td><td>No</td><td>Database superuser password, for QuickStart, so ManifoldCF can create database instance.</td></tr> <tr><td>org.apache.manifoldcf.ui.maxstatuscount</td><td>No</td><td>The maximum number of documents ManifoldCF will try to count for the job status display. Defaults to 500000.</td></tr> <tr><td>org.apache.manifoldcf.databaseimplementationclass</td><td>No</td><td>Specifies the class to use to implement database access. - Default is a built-in Derby implementation. Supported choices are: org.apache.manifoldcf.core.database.DBInterfaceDerby, + Default is a built-in Hsqldb implementation. Supported choices are: org.apache.manifoldcf.core.database.DBInterfacePostgreSQL, org.apache.manifoldcf.core.database.DBInterfaceMySQL, org.apache.manifoldcf.core.database.DBInterfaceHSQLDB</td></tr> @@ -980,7 +969,6 @@ cd example <tr><td>org.apache.manifoldcf.postgresql.ssl</td><td>No</td><td>Set to "true" for ssl communication with PostgreSQL.</td></tr> <tr><td>org.apache.manifoldcf.mysql.server</td><td>No</td><td>The MySQL server name. Defaults to 'localhost'.</td></tr> <tr><td>org.apache.manifoldcf.mysql.client</td><td>No</td><td>The MySQL client property. Defaults to 'localhost'. You may want to set this to '%' for a multi-machine setup.</td></tr> - <tr><td>org.apache.manifoldcf.derbydatabasepath</td><td>No</td><td>Absolute or relative path to Derby database; default is '.'.</td></tr> <tr><td>org.apache.manifoldcf.hsqldbdatabasepath</td><td>No</td><td>Absolute or relative path to HSQLDB database; default is '.'.</td></tr> <tr><td>org.apache.manifoldcf.hsqldbdatabaseprotocol</td><td>Yes, for remote HSQLDB connection</td><td>The HSQLDB JDBC protocol; choices are 'hsql', 'http', or 'https'. Default is blank (which means an embedded instance)</td></tr> <tr><td>org.apache.manifoldcf.hsqldbdatabaseserver</td><td>Yes, for remote HSQLDB connection</td><td>The HSQLDB remote server name.</td></tr>
Modified: manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml URL: http://svn.apache.org/viewvc/manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml?rev=1631727&r1=1631726&r2=1631727&view=diff ============================================================================== --- manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml (original) +++ manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml Tue Oct 14 12:09:05 2014 @@ -160,7 +160,7 @@ <p>If you need to supply DFC classes during build time, copy the DFC and dependent jars to the source directory <em>connectors/documentum/lib-proprietary</em>, and build using "ant build". The jars will be copied into the right place in your <em>dist</em> directory automatically.</p> - <p>For a binary distribution, just copy the DFC jars to <em>documentum-server-process/lib-proprietary</em> instead.</p> + <p>For a binary distribution, just copy the DFC jars to <em>processes/documentum-server/lib-proprietary</em> instead.</p> <p>If you have done everything right, you should be able to start the Documentum connector's registry and server processes, as per the instructions.</p> <p></p> </section> @@ -174,7 +174,7 @@ <p>If you need to supply your own Jace.jar at build time, copy it to the source directory <em>connectors/filenet/lib-proprietary</em>, and build using "ant build". The Jace.jar will be copied into the right place in your <em>dist</em> directory automatically.</p> <p>If you do not wish to build, simply copy your Jace.jar and the other dependent jars from that installation into the distribution directory - <em>filenet-server-process/lib-proprietary</em>.</p> + <em>processes/filenet-server/lib-proprietary</em>.</p> <p>If correctly done, you will be able to start the FileNet connector's registry and server processes, as per the instructions.</p> <p></p> </section> @@ -317,7 +317,7 @@ <source> mvn clean install </source> - <p>This should generate all the necessary artifacts to run with, and also run the Apache Derby-based tests.</p> + <p>This should generate all the necessary artifacts to run with, and also run the Hsqldb-based tests.</p> <p>To build and skip only the integration tests, type:</p> <source> mvn clean install -DskipITs @@ -378,7 +378,7 @@ mvn clean package <tr><td><em>connector-lib-proprietary</em></td><td>proprietary jars for all the connectors, referred to by properties.xml; not included in binary release</td></tr> <tr><td><em>lib</em></td><td>jars for all of the examples, referenced by the example scripts</td></tr> <tr><td><em>lib-proprietary</em></td><td>proprietary jars for all of the examples, referenced by the proprietary example scripts</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> + <tr><td><em>processes</em></td><td>scripts, classpath jars, and -D switch values needed for the required connector-specific processes</td></tr> <tr><td><em>script-engine</em></td><td>jars and scripts for running the ManifoldCF script interpreter</td></tr> <tr><td><em>example</em></td><td>a jetty-based example that runs in a single process (except for any connector-specific processes), excluding all proprietary libraries</td></tr> <tr><td><em>example-proprietary</em></td><td>a jetty-based example that runs in a single process (except for any connector-specific processes), including proprietary libraries; not included in binary release</td></tr> @@ -389,7 +389,7 @@ mvn clean package <tr><td><em>web</em></td><td>app-server deployable web applications (wars), excluding all proprietary libraries</td></tr> <tr><td><em>web-proprietary</em></td><td>app-server deployable web applications (wars), including proprietary libraries; not included in binary release</td></tr> <tr><td><em>doc</em></td><td>javadocs for framework and all included connectors</td></tr> - <tr><td><em>xxx-integration</em></td><td>pre-built integration components to deploy on target system "xxx", e.g. Solr</td></tr> + <tr><td><em>plugins</em></td><td>pre-built integration components to deploy on target systems, e.g. for Solr</td></tr> </table> <p></p> <p>If you downloaded the binary distribution, you may notice that the <em>connector-lib-proprietary</em> directory contains only a number of @@ -402,19 +402,19 @@ mvn clean package distribution. In order to use these JDBC drivers, you must build ManifoldCF yourself. Start by downloading the drivers and placing them in the <em>lib-proprietary</em> directory. The command <em>ant download-dependencies</em> will do most of this for you, with the exception of the Oracle JDBC driver.</p> <p></p> - <p>The directories titled <em>xxx-process</em> represent separate processes which must be started in order for the associated connector to function. - The number of produced <em>xxx-process</em> directories may vary, because optional individual connectors may or may not supply processes that - must be run to support the connector. For each of the <em>xxx-process</em> subdirectories above, any scripts that pertain to that connector-supplied + <p>The directory titled <em>processes</em> include separate processes which must be started in order for the associated connector to function. + The number of produced <em>processes</em> subdirectories may vary, because optional individual connectors may or may not supply processes that + must be run to support the connector. For each of the <em>processes</em> subdirectories above, any scripts that pertain to that connector-supplied process will be placed in the root level of the subdirectory. 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>The proprietary libraries required by the secondary process <em>xxx-process</em> should be in the directory <em>xxx-process/lib-proprietary</em>. + <p>The proprietary libraries required by the secondary process <em>processes</em> subdirectories should be in the directory <em>processes/xxx/lib-proprietary</em>. These jars are not included in the binary distribution, and you will need to supply them in order to make the process work. A README.txt file is placed in each <em>lib-proprietary</em> directory describing what needs to be provided there.</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 + <p>The <em>plugins</em> directory contains 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>example</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 @@ -438,7 +438,7 @@ mvn clean package <section> <title>Quick-start single process model</title> <p></p> - <p>You can run most of ManifoldCF in a single process, for evaluation and convenience. This single-process version uses Jetty to handle its web applications, and Derby as + <p>You can run most of ManifoldCF in a single process, for evaluation and convenience. This single-process version uses Jetty to handle its web applications, and Hsqldb as an embedded database. All you need to do to run this version of ManifoldCF is to follow the Ant-based build instructions above, and then:</p> <p></p> <source> @@ -452,14 +452,14 @@ cd example <p></p> <p>You can stop the quick-start ManifoldCF at any time using ^C.</p> <p></p> - <p>Bear in mind that Derby is not as full-featured a database as is PostgreSQL. This means that any performance testing you may do against the quick start example may - not be applicable to a full installation. Furthermore, Derby only permits one process at a time to be connected to its databases, so you <strong>cannot</strong> use any + <p>Bear in mind that Hsqldb is not as full-featured a database as is PostgreSQL. This means that any performance testing you may do against the quick start example may + not be applicable to a full installation. Furthermore, embedded Hsqldb only permits one process at a time to be connected to its databases, so you <strong>cannot</strong> use any of the ManifoldCF commands (as described below) while the quick-start ManifoldCF is running.</p> <p></p> <p>Another caveat that you will need to be aware of with the quick-start version of ManifoldCF is that it in no way removes the need for you to run any separate processes that individual connectors require. Specifically, the Documentum and FileNet connectors require processes to be independently started in order to function. You will need to read about these connector-specific processes below in order to use the corresponding connectors. Scripts for running these processes can be found in the directories - named <em>xxx-process</em>.</p> + named <em>processes/xxx</em>.</p> <p></p> </section> @@ -478,7 +478,7 @@ cd example <p>The combined web service presents the crawler UI at the root path for the web application, which is <em>http://<host>:8345/mcf/</em>. The authority service functionality can be found at <em>http://<host>:8345/mcf/UserACLs</em>, similar to the quick-start example. However, the programmatic API service has a path other than the root: <em>http://<host>:8345/mcf/api/</em>.</p> - <p>The script that starts the combined-service web application uses the same database instance (Derby by default) as does the quick-start, and the same <em>properties.xml</em> + <p>The script that starts the combined-service web application uses the same database instance (Hsqldb by default) as does the quick-start, and the same <em>properties.xml</em> file. The same caveats about required individual connector processes also apply as they do for the quick-start example.</p> <p></p> @@ -828,7 +828,6 @@ cd example <li>PostgreSQL (preferred)</li> <li>MySQL (preferred)</li> <li>HSQLDB</li> - <li>Derby (not recommended for production)</li> </ul> <p>You can select the database of your choice by setting the approprate properties in the applicable <em>properties.xml</em> file. The choice of database is largely orthogonal to the choice of deployment model. The ManifoldCF deployment examples provided can thus be readily altered to use the database you desire. The details and caveats of @@ -916,16 +915,6 @@ cd example process. See the <em>properties.xml</em> property descriptions for configuration details.</p> </section> - <section> - <title>Configuring an Apache Derby database</title> - <p></p> - <p>Apache Derby can be used with ManifoldCF only as an embedded database, working with single-process deployments. Its performance currently seems limited by - issues related to its planner and to its handling of deadlock conditions, but this situation could change any time there is a new release of the Derby software. Nevertheless, even - when operating without any apparent stalls due to the above issues, Derby is still only about 1/4 as fast as PostgreSQL. At the moment this limits Derby's utility for - ManifoldCF to demonstration and testing.</p> - </section> - - </section> <section> @@ -971,7 +960,7 @@ cd example <tr><td>org.apache.manifoldcf.dbsuperuserpassword</td><td>No</td><td>Database superuser password, for QuickStart, so ManifoldCF can create database instance.</td></tr> <tr><td>org.apache.manifoldcf.ui.maxstatuscount</td><td>No</td><td>The maximum number of documents ManifoldCF will try to count for the job status display. Defaults to 500000.</td></tr> <tr><td>org.apache.manifoldcf.databaseimplementationclass</td><td>No</td><td>Specifies the class to use to implement database access. - Default is a built-in Derby implementation. Supported choices are: org.apache.manifoldcf.core.database.DBInterfaceDerby, + Default is a built-in Hsqldb implementation. Supported choices are: org.apache.manifoldcf.core.database.DBInterfacePostgreSQL, org.apache.manifoldcf.core.database.DBInterfaceMySQL, org.apache.manifoldcf.core.database.DBInterfaceHSQLDB</td></tr> @@ -980,7 +969,6 @@ cd example <tr><td>org.apache.manifoldcf.postgresql.ssl</td><td>No</td><td>Set to "true" for ssl communication with PostgreSQL.</td></tr> <tr><td>org.apache.manifoldcf.mysql.server</td><td>No</td><td>The MySQL server name. Defaults to 'localhost'.</td></tr> <tr><td>org.apache.manifoldcf.mysql.client</td><td>No</td><td>The MySQL client property. Defaults to 'localhost'. You may want to set this to '%' for a multi-machine setup.</td></tr> - <tr><td>org.apache.manifoldcf.derbydatabasepath</td><td>No</td><td>Absolute or relative path to Derby database; default is '.'.</td></tr> <tr><td>org.apache.manifoldcf.hsqldbdatabasepath</td><td>No</td><td>Absolute or relative path to HSQLDB database; default is '.'.</td></tr> <tr><td>org.apache.manifoldcf.hsqldbdatabaseprotocol</td><td>Yes, for remote HSQLDB connection</td><td>The HSQLDB JDBC protocol; choices are 'hsql', 'http', or 'https'. Default is blank (which means an embedded instance)</td></tr> <tr><td>org.apache.manifoldcf.hsqldbdatabaseserver</td><td>Yes, for remote HSQLDB connection</td><td>The HSQLDB remote server name.</td></tr> @@ -1033,7 +1021,7 @@ cd example <tr><td>org.apache.manifoldcf.db.postgres.analyze.<tablename></td><td>No</td><td>2000</td><td>For postgresql, specify how many changes should be carried out before carrying out an 'ANALYZE' on the specified table.</td></tr> <tr><td>org.apache.manifoldcf.db.postgres.reindex.<tablename></td><td>No</td><td>250000</td><td>For postgresql, specify how many changes should be carried out before carrying out an 'REINDEX' on the specified table.</td></tr> <tr><td>org.apache.manifoldcf.db.mysql.analyze.<tablename></td><td>No</td><td>2000</td><td>For mysql, specify how many changes should be carried out before carrying out an 'ANALYZE' on the specified table.</td></tr> - <tr><td>org.apache.manifoldcf.ui.maxstatuscount</td><td>No</td><td>10000</td><td>Set the upper limit for the precise document count to be returned on the 'Status and Job Management' page.</td></tr> + <tr><td>org.apache.manifoldcf.ui.maxstatuscount</td><td>No</td><td>500000</td><td>Set the upper limit for the precise document count to be returned on the 'Status and Job Management' page.</td></tr> </table> <p></p> <p>The configuration file can also specify a set of directories which will be searched for connector jars. The directive that adds to the class path is:</p> Modified: manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml URL: http://svn.apache.org/viewvc/manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml?rev=1631727&r1=1631726&r2=1631727&view=diff ============================================================================== --- manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml (original) +++ manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml Tue Oct 14 12:09:05 2014 @@ -160,7 +160,7 @@ <p>If you need to supply DFC classes during build time, copy the DFC and dependent jars to the source directory <em>connectors/documentum/lib-proprietary</em>, and build using "ant build". The jars will be copied into the right place in your <em>dist</em> directory automatically.</p> - <p>For a binary distribution, just copy the DFC jars to <em>documentum-server-process/lib-proprietary</em> instead.</p> + <p>For a binary distribution, just copy the DFC jars to <em>processes/documentum-server/lib-proprietary</em> instead.</p> <p>If you have done everything right, you should be able to start the Documentum connector's registry and server processes, as per the instructions.</p> <p></p> </section> @@ -174,7 +174,7 @@ <p>If you need to supply your own Jace.jar at build time, copy it to the source directory <em>connectors/filenet/lib-proprietary</em>, and build using "ant build". The Jace.jar will be copied into the right place in your <em>dist</em> directory automatically.</p> <p>If you do not wish to build, simply copy your Jace.jar and the other dependent jars from that installation into the distribution directory - <em>filenet-server-process/lib-proprietary</em>.</p> + <em>processes/filenet-server/lib-proprietary</em>.</p> <p>If correctly done, you will be able to start the FileNet connector's registry and server processes, as per the instructions.</p> <p></p> </section> @@ -317,7 +317,7 @@ <source> mvn clean install </source> - <p>This should generate all the necessary artifacts to run with, and also run the Apache Derby-based tests.</p> + <p>This should generate all the necessary artifacts to run with, and also run the Hsqldb-based tests.</p> <p>To build and skip only the integration tests, type:</p> <source> mvn clean install -DskipITs @@ -378,7 +378,7 @@ mvn clean package <tr><td><em>connector-lib-proprietary</em></td><td>proprietary jars for all the connectors, referred to by properties.xml; not included in binary release</td></tr> <tr><td><em>lib</em></td><td>jars for all of the examples, referenced by the example scripts</td></tr> <tr><td><em>lib-proprietary</em></td><td>proprietary jars for all of the examples, referenced by the proprietary example scripts</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> + <tr><td><em>processes</em></td><td>scripts, classpath jars, and -D switch values needed for the required connector-specific processes</td></tr> <tr><td><em>script-engine</em></td><td>jars and scripts for running the ManifoldCF script interpreter</td></tr> <tr><td><em>example</em></td><td>a jetty-based example that runs in a single process (except for any connector-specific processes), excluding all proprietary libraries</td></tr> <tr><td><em>example-proprietary</em></td><td>a jetty-based example that runs in a single process (except for any connector-specific processes), including proprietary libraries; not included in binary release</td></tr> @@ -389,7 +389,7 @@ mvn clean package <tr><td><em>web</em></td><td>app-server deployable web applications (wars), excluding all proprietary libraries</td></tr> <tr><td><em>web-proprietary</em></td><td>app-server deployable web applications (wars), including proprietary libraries; not included in binary release</td></tr> <tr><td><em>doc</em></td><td>javadocs for framework and all included connectors</td></tr> - <tr><td><em>xxx-integration</em></td><td>pre-built integration components to deploy on target system "xxx", e.g. Solr</td></tr> + <tr><td><em>plugins</em></td><td>pre-built integration components to deploy on target systems, e.g. for Solr</td></tr> </table> <p></p> <p>If you downloaded the binary distribution, you may notice that the <em>connector-lib-proprietary</em> directory contains only a number of @@ -402,19 +402,19 @@ mvn clean package distribution. In order to use these JDBC drivers, you must build ManifoldCF yourself. Start by downloading the drivers and placing them in the <em>lib-proprietary</em> directory. The command <em>ant download-dependencies</em> will do most of this for you, with the exception of the Oracle JDBC driver.</p> <p></p> - <p>The directories titled <em>xxx-process</em> represent separate processes which must be started in order for the associated connector to function. - The number of produced <em>xxx-process</em> directories may vary, because optional individual connectors may or may not supply processes that - must be run to support the connector. For each of the <em>xxx-process</em> subdirectories above, any scripts that pertain to that connector-supplied + <p>The directory titled <em>processes</em> include separate processes which must be started in order for the associated connector to function. + The number of produced <em>processes</em> subdirectories may vary, because optional individual connectors may or may not supply processes that + must be run to support the connector. For each of the <em>processes</em> subdirectories above, any scripts that pertain to that connector-supplied process will be placed in the root level of the subdirectory. 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>The proprietary libraries required by the secondary process <em>xxx-process</em> should be in the directory <em>xxx-process/lib-proprietary</em>. + <p>The proprietary libraries required by the secondary process <em>processes</em> subdirectories should be in the directory <em>processes/xxx/lib-proprietary</em>. These jars are not included in the binary distribution, and you will need to supply them in order to make the process work. A README.txt file is placed in each <em>lib-proprietary</em> directory describing what needs to be provided there.</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 + <p>The <em>plugins</em> directory contains 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>example</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 @@ -438,7 +438,7 @@ mvn clean package <section> <title>Quick-start single process model</title> <p></p> - <p>You can run most of ManifoldCF in a single process, for evaluation and convenience. This single-process version uses Jetty to handle its web applications, and Derby as + <p>You can run most of ManifoldCF in a single process, for evaluation and convenience. This single-process version uses Jetty to handle its web applications, and Hsqldb as an embedded database. All you need to do to run this version of ManifoldCF is to follow the Ant-based build instructions above, and then:</p> <p></p> <source> @@ -452,14 +452,14 @@ cd example <p></p> <p>You can stop the quick-start ManifoldCF at any time using ^C.</p> <p></p> - <p>Bear in mind that Derby is not as full-featured a database as is PostgreSQL. This means that any performance testing you may do against the quick start example may - not be applicable to a full installation. Furthermore, Derby only permits one process at a time to be connected to its databases, so you <strong>cannot</strong> use any + <p>Bear in mind that Hsqldb is not as full-featured a database as is PostgreSQL. This means that any performance testing you may do against the quick start example may + not be applicable to a full installation. Furthermore, embedded Hsqldb only permits one process at a time to be connected to its databases, so you <strong>cannot</strong> use any of the ManifoldCF commands (as described below) while the quick-start ManifoldCF is running.</p> <p></p> <p>Another caveat that you will need to be aware of with the quick-start version of ManifoldCF is that it in no way removes the need for you to run any separate processes that individual connectors require. Specifically, the Documentum and FileNet connectors require processes to be independently started in order to function. You will need to read about these connector-specific processes below in order to use the corresponding connectors. Scripts for running these processes can be found in the directories - named <em>xxx-process</em>.</p> + named <em>processes/xxx</em>.</p> <p></p> </section> @@ -478,7 +478,7 @@ cd example <p>The combined web service presents the crawler UI at the root path for the web application, which is <em>http://<host>:8345/mcf/</em>. The authority service functionality can be found at <em>http://<host>:8345/mcf/UserACLs</em>, similar to the quick-start example. However, the programmatic API service has a path other than the root: <em>http://<host>:8345/mcf/api/</em>.</p> - <p>The script that starts the combined-service web application uses the same database instance (Derby by default) as does the quick-start, and the same <em>properties.xml</em> + <p>The script that starts the combined-service web application uses the same database instance (Hsqldb by default) as does the quick-start, and the same <em>properties.xml</em> file. The same caveats about required individual connector processes also apply as they do for the quick-start example.</p> <p></p> @@ -828,7 +828,6 @@ cd example <li>PostgreSQL (preferred)</li> <li>MySQL (preferred)</li> <li>HSQLDB</li> - <li>Derby (not recommended for production)</li> </ul> <p>You can select the database of your choice by setting the approprate properties in the applicable <em>properties.xml</em> file. The choice of database is largely orthogonal to the choice of deployment model. The ManifoldCF deployment examples provided can thus be readily altered to use the database you desire. The details and caveats of @@ -916,16 +915,6 @@ cd example process. See the <em>properties.xml</em> property descriptions for configuration details.</p> </section> - <section> - <title>Configuring an Apache Derby database</title> - <p></p> - <p>Apache Derby can be used with ManifoldCF only as an embedded database, working with single-process deployments. Its performance currently seems limited by - issues related to its planner and to its handling of deadlock conditions, but this situation could change any time there is a new release of the Derby software. Nevertheless, even - when operating without any apparent stalls due to the above issues, Derby is still only about 1/4 as fast as PostgreSQL. At the moment this limits Derby's utility for - ManifoldCF to demonstration and testing.</p> - </section> - - </section> <section> @@ -971,7 +960,7 @@ cd example <tr><td>org.apache.manifoldcf.dbsuperuserpassword</td><td>No</td><td>Database superuser password, for QuickStart, so ManifoldCF can create database instance.</td></tr> <tr><td>org.apache.manifoldcf.ui.maxstatuscount</td><td>No</td><td>The maximum number of documents ManifoldCF will try to count for the job status display. Defaults to 500000.</td></tr> <tr><td>org.apache.manifoldcf.databaseimplementationclass</td><td>No</td><td>Specifies the class to use to implement database access. - Default is a built-in Derby implementation. Supported choices are: org.apache.manifoldcf.core.database.DBInterfaceDerby, + Default is a built-in Hsqldb implementation. Supported choices are: org.apache.manifoldcf.core.database.DBInterfacePostgreSQL, org.apache.manifoldcf.core.database.DBInterfaceMySQL, org.apache.manifoldcf.core.database.DBInterfaceHSQLDB</td></tr> @@ -980,7 +969,6 @@ cd example <tr><td>org.apache.manifoldcf.postgresql.ssl</td><td>No</td><td>Set to "true" for ssl communication with PostgreSQL.</td></tr> <tr><td>org.apache.manifoldcf.mysql.server</td><td>No</td><td>The MySQL server name. Defaults to 'localhost'.</td></tr> <tr><td>org.apache.manifoldcf.mysql.client</td><td>No</td><td>The MySQL client property. Defaults to 'localhost'. You may want to set this to '%' for a multi-machine setup.</td></tr> - <tr><td>org.apache.manifoldcf.derbydatabasepath</td><td>No</td><td>Absolute or relative path to Derby database; default is '.'.</td></tr> <tr><td>org.apache.manifoldcf.hsqldbdatabasepath</td><td>No</td><td>Absolute or relative path to HSQLDB database; default is '.'.</td></tr> <tr><td>org.apache.manifoldcf.hsqldbdatabaseprotocol</td><td>Yes, for remote HSQLDB connection</td><td>The HSQLDB JDBC protocol; choices are 'hsql', 'http', or 'https'. Default is blank (which means an embedded instance)</td></tr> <tr><td>org.apache.manifoldcf.hsqldbdatabaseserver</td><td>Yes, for remote HSQLDB connection</td><td>The HSQLDB remote server name.</td></tr> @@ -1033,7 +1021,7 @@ cd example <tr><td>org.apache.manifoldcf.db.postgres.analyze.<tablename></td><td>No</td><td>2000</td><td>For postgresql, specify how many changes should be carried out before carrying out an 'ANALYZE' on the specified table.</td></tr> <tr><td>org.apache.manifoldcf.db.postgres.reindex.<tablename></td><td>No</td><td>250000</td><td>For postgresql, specify how many changes should be carried out before carrying out an 'REINDEX' on the specified table.</td></tr> <tr><td>org.apache.manifoldcf.db.mysql.analyze.<tablename></td><td>No</td><td>2000</td><td>For mysql, specify how many changes should be carried out before carrying out an 'ANALYZE' on the specified table.</td></tr> - <tr><td>org.apache.manifoldcf.ui.maxstatuscount</td><td>No</td><td>10000</td><td>Set the upper limit for the precise document count to be returned on the 'Status and Job Management' page.</td></tr> + <tr><td>org.apache.manifoldcf.ui.maxstatuscount</td><td>No</td><td>500000</td><td>Set the upper limit for the precise document count to be returned on the 'Status and Job Management' page.</td></tr> </table> <p></p> <p>The configuration file can also specify a set of directories which will be searched for connector jars. The directive that adds to the class path is:</p>
