Revision 9893
Added by Jing Tao over 8 years ago
| docs/user/metacat/source/install.rst | ||
|---|---|---|
| 11 | 11 |
you wish to install Metacat must have the following software installed and |
| 12 | 12 |
running correctly: |
| 13 | 13 |
|
| 14 |
* PostgreSQL_ (or another SQL92-compliant RDBMS like Oracle_)
|
|
| 14 |
* PostgreSQL_ |
|
| 15 | 15 |
* `Apache Ant`_ (if building from source) |
| 16 | 16 |
* `Apache Tomcat`_ |
| 17 | 17 |
* `Apache HTTPD Server`_ (recommended) |
| ... | ... | |
| 34 | 34 |
|
| 35 | 35 |
System requirements for running Metacat: |
| 36 | 36 |
|
| 37 |
* a server running an SQL92-compliant database (PostgreSQL_ recommended)
|
|
| 37 |
* a server running PostgreSQL_ database
|
|
| 38 | 38 |
* at least 512MB RAM |
| 39 | 39 |
* 200 MB disk space (Note: The amount of disk space required depends on the size of your RDBMS tablespace and the the size and number of documents stored. Metacat itself requires only about 140 MB of free space after installation). |
| 40 | 40 |
|
| ... | ... | |
| 53 | 53 |
they are doing, here are the steps needed to install Metacat. Detailed |
| 54 | 54 |
instructions for each step are in the next section. |
| 55 | 55 |
|
| 56 |
1. Download and install prerequisites (`Java 6`_, `Apache Tomcat`_ 6, PostgreSQL_, `Apache HTTPD Server`_)
|
|
| 56 |
1. Download and install prerequisites (`Java 7`_, `Apache Tomcat`_ 6, PostgreSQL_, `Apache HTTPD Server`_)
|
|
| 57 | 57 |
2. Create a database in PostgreSQL named 'metacat' and authorize access to it in ``pb_hba.conf`` for the user 'metacat' |
| 58 | 58 |
3. Log in to PostgreSQL and create the 'metacat' user |
| 59 | 59 |
4. Download Metacat from the `Metacat Download Page`_ and extract the archive |
| ... | ... | |
| 95 | 95 |
extraction location will be referred to as the ``<metacat_package_dir>`` for the |
| 96 | 96 |
remainder of this documentation. |
| 97 | 97 |
|
| 98 |
================== ===================================================================== |
|
| 99 |
File Description |
|
| 100 |
================== ===================================================================== |
|
| 101 |
metacat.war The Metacat Web archive file (WAR) |
|
| 102 |
metacat-site.conf Sample Web definition file used by Apache on Ubuntu/Debian |
|
| 103 |
Linux systems. |
|
| 104 |
metacat-site-ssl.conf Sample SSL definition file used by Apache on Ubuntu/Debian |
|
| 105 |
Linux systems. |
|
| 106 |
jk.conf Sample JkMount configuration file used by Apache on |
|
| 107 |
Ubuntu/Debian Linux systems. |
|
| 108 |
workers.properties Sample workers definition file used by Apache on Ubuntu/Debian |
|
| 109 |
Linux systems. |
|
| 110 |
metacat-index.war The Metacat Index WAR for supporting SOLR query features |
|
| 111 |
Optional unless Metacat UI is being used. |
|
| 112 |
metacat-ui.war The Metacat UI - can be deployed as a webapp or directly in webserver |
|
| 113 |
Metacat UI requires metacat-index be deployed and configured. |
|
| 114 |
authority.war The optional LSID Server application WAR |
|
| 115 |
================== ====================================================================== |
|
| 98 |
===================== ================================================================================================================================== |
|
| 99 |
File Description |
|
| 100 |
===================== ================================================================================================================================== |
|
| 101 |
metacat.war The Metacat Web archive file (WAR) |
|
| 102 |
metacat-site.conf Sample Web definition file used by Apache on Ubuntu/Debian Linux systems. |
|
| 103 |
metacat-site-ssl.conf Sample SSL definition file used by Apache on Ubuntu/Debian Linux systems. |
|
| 104 |
jk.conf Sample JkMount configuration file used by Apache on Ubuntu/Debian Linux systems. |
|
| 105 |
workers.properties Sample workers definition file used by Apache on Ubuntu/Debian Linux systems. |
|
| 106 |
metacat-index.war The Metacat Index WAR for supporting SOLR query features Optional unless Metacat UI is being used. |
|
| 107 |
metacatui.war The Metacat UI - can be deployed as a webapp or directly in webserverMetacat UI requires metacat-index be deployed and configured. |
|
| 108 |
authority.war The optional LSID Server application WAR |
|
| 109 |
===================== ================================================================================================================================== |
|
| 116 | 110 |
|
| 117 | 111 |
|
| 118 | 112 |
Download Metacat Source Code |
| ... | ... | |
| 174 | 168 |
Installing and Configuring Required Software |
| 175 | 169 |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 176 | 170 |
Before you can install and run Metacat, you must ensure that a recent Java SDK, |
| 177 |
PostgreSQL (or another SQL92-compliant RDBMS like Oracle), Ant (if
|
|
| 171 |
PostgreSQL, Ant (if |
|
| 178 | 172 |
installing from source), and Tomcat are installed and running correctly. We |
| 179 | 173 |
also highly recommend that you install Apache Web server, as it provides a more |
| 180 | 174 |
robust Web-serving environment and is required by some Metacat functionality. |
| ... | ... | |
| 182 | 176 |
* `Java 7`_ |
| 183 | 177 |
* `Apache Tomcat`_ |
| 184 | 178 |
* `Apache HTTPD Server`_ (Highly Recommended) |
| 185 |
* PostgreSQL_ Database (or Oracle_)
|
|
| 179 |
* PostgreSQL_ Database |
|
| 186 | 180 |
* `Apache Ant`_ (if building from Source) |
| 187 | 181 |
|
| 188 | 182 |
Java 7 |
| ... | ... | |
| 364 | 358 |
|
| 365 | 359 |
PostgreSQL Database |
| 366 | 360 |
................... |
| 367 |
Metacat has been most widely tested with PostgreSQL_ and we recommend using it. |
|
| 368 |
Instructions for installing and configuring Oracle are also included in the |
|
| 369 |
next section. To install and configure PostgreSQL_: |
|
| 361 |
Currently Metacat only supports PostgreSQL_. To install and configure PostgreSQL_: |
|
| 370 | 362 |
|
| 371 | 363 |
1. If you are running Ubuntu_/Debian, get PostgreSQL by typing: |
| 372 | 364 |
|
| ... | ... | |
| 460 | 452 |
more information about configuring the database, please see Database |
| 461 | 453 |
Configuration. |
| 462 | 454 |
|
| 463 |
Installing and Configuring Oracle |
|
| 464 |
................................. |
|
| 465 |
To use Oracle with Metacat, the Oracle RDBMS must be installed and running |
|
| 466 |
as a daemon on the system. In addition the JDBC listener must be enabled. |
|
| 467 |
Enable it by logging in as an Oracle user and typing:: |
|
| 468 |
|
|
| 469 |
lsnrctl start |
|
| 470 |
|
|
| 471 |
Your instance should have a table space of at least 5 MB (10 MB or higher |
|
| 472 |
recommended). You must also create and enable a username specific to Metacat. |
|
| 473 |
The Metacat user must have most normal permissions including: CREATE SESSION, |
|
| 474 |
CREATE TABLE, CREATE INDEX, CREATE TRIGGER, EXECUTE PROCEDURE, EXECUTE TYPE, |
|
| 475 |
etc. If an action is unexplainably rejected by Metacat, the user permissions |
|
| 476 |
are (most likely) not correctly set. |
|
| 477 |
|
|
| 478 |
The Metacat servlet automatically creates the required database schema. For |
|
| 479 |
more information, please see Database Configuration. |
|
| 480 |
|
|
| 481 | 455 |
Apache Ant (if building from Source) |
| 482 | 456 |
.................................... |
| 483 | 457 |
If you are building Metacat from a source distribution or from source code |
| ... | ... | |
| 890 | 864 |
|
| 891 | 865 |
PostgreSQL Database |
| 892 | 866 |
................... |
| 893 |
Metacat can be run with several SQL92-compliant database systems, but it has |
|
| 894 |
been most widely tested with PostgreSQL_. Instructions for installing and |
|
| 867 |
Metacat only can be run with PostgreSQL_. Instructions for installing and |
|
| 895 | 868 |
configuring PostgreSQL for use with Metacat are included in this section. |
| 896 | 869 |
|
| 897 | 870 |
To download and install PostgreSQL: |
| ... | ... | |
| 1023 | 996 |
|
| 1024 | 997 |
Congratulations! You are now ready to configure Metacat. Please see Configuring |
| 1025 | 998 |
Metacat for more information. |
| 1026 |
|
|
Also available in: Unified diff
Remove the oracle support.