Revision 6870
Added by Matt Jones over 12 years ago
| install.rst | ||
|---|---|---|
| 18 | 18 |
|
| 19 | 19 |
* In order to use the Metacat Registry (and for a more robust Web-serving environment in general), the Apache Web server should be installed with Tomcat and the two should be integrated. See the installing Apache for more information. |
| 20 | 20 |
|
| 21 |
* Java_ 6 (Note: Java 5 is deprecated)
|
|
| 21 |
* `Java 6`_ (Note: Java 5 is deprecated)
|
|
| 22 | 22 |
|
| 23 | 23 |
.. _PostgreSQL: http://www.postgresql.org/ |
| 24 | 24 |
|
| ... | ... | |
| 30 | 30 |
|
| 31 | 31 |
.. _Apache HTTPD Server: http://httpd.apache.org/ |
| 32 | 32 |
|
| 33 |
.. _Java: http://www.oracle.com/technetwork/java/javaee/overview/index.html |
|
| 33 |
.. _Java 6: http://www.oracle.com/technetwork/java/javaee/overview/index.html
|
|
| 34 | 34 |
|
| 35 | 35 |
System requirements for running Metacat: |
| 36 | 36 |
|
| ... | ... | |
| 58 | 58 |
they are doing, here are the steps needed to install Metacat. Detailed |
| 59 | 59 |
instructions for each step are in the next section. |
| 60 | 60 |
|
| 61 |
1. Download and install prerequisites (Java_ 6, `Apache Tomcat`_ 6, PostgreSQL_, `Apache HTTPD Server`_), including the tomcat6 init.d script
|
|
| 61 |
1. Download and install prerequisites (`Java 6`_, `Apache Tomcat`_ 6, PostgreSQL_, `Apache HTTPD Server`_)
|
|
| 62 | 62 |
2. Create a database in PostgreSQL named 'metacat' and authorize access to it in ``pb_hba.conf`` for the user 'metacat' |
| 63 | 63 |
3. Log in to PostgreSQL and create the 'metacat' user |
| 64 | 64 |
4. Download Metacat from the `Metacat Download Page`_ and extract the archive |
| 65 | 65 |
5. ``sudo mkdir /var/metacat; sudo chown -R <tomcat_user> /var/metacat`` |
| 66 | 66 |
6. ``sudo cp <metacat_package_dir>/knb.war <tomcat_app_dir>`` |
| 67 |
7. ``sudo /etc/init.d/tomcat5.5 restart``
|
|
| 67 |
7. ``sudo /etc/init.d/tomcat6 restart``
|
|
| 68 | 68 |
8. Configure Metacat through the Web interface |
| 69 | 69 |
|
| 70 | 70 |
.. _Metacat Download Page: http://knb.ecoinformatics.org/software/metacat/ |
| ... | ... | |
| 106 | 106 |
knb.war The Metacat Web archive file (WAR) |
| 107 | 107 |
knb The Web definition file used by Apache on Ubuntu/Debian |
| 108 | 108 |
Linux systems. |
| 109 |
Knb.ssl The SSL definition file used by Apache on Ubuntu/Debian
|
|
| 109 |
knb.ssl The SSL definition file used by Apache on Ubuntu/Debian
|
|
| 110 | 110 |
Linux systems. |
| 111 | 111 |
jk.conf The JkMount configuration file used by Apache on |
| 112 | 112 |
Ubuntu/Debian Linux systems. |
| 113 | 113 |
workers.properties The workers definition file used by Apache on Ubuntu/Debian |
| 114 | 114 |
Linux systems. |
| 115 |
tomcat5.5 The Tomcat startup script for Tomcat 5.5 installed with |
|
| 116 |
apt-get on Ubuntu/Debian Linux systems. |
|
| 117 | 115 |
authority The optional LSID Server application WAR |
| 118 | 116 |
================== =========================================================== |
| 119 | 117 |
|
| ... | ... | |
| 181 | 179 |
also highly recommend that you install Apache Web server, as it provides a more |
| 182 | 180 |
robust Web-serving environment and is required by some Metacat functionality. |
| 183 | 181 |
|
| 184 |
* Java_ 6
|
|
| 182 |
* `Java 6`_
|
|
| 185 | 183 |
* `Apache Tomcat`_ |
| 186 | 184 |
* `Apache HTTPD Server`_ (Highly Recommended) |
| 187 | 185 |
* PostgreSQL_ Database (or Oracle_) |
| ... | ... | |
| 215 | 213 |
|
| 216 | 214 |
If you are running Ubuntu_/Debian, get Tomcat by typing:: |
| 217 | 215 |
|
| 218 |
sudo apt-get install tomcat5.5
|
|
| 216 |
sudo apt-get install tomcat6
|
|
| 219 | 217 |
|
| 220 | 218 |
Otherwise, get Tomcat from the `Apache Tomcat`_ page. |
| 221 | 219 |
|
| 222 |
Install the Metacat-friendly Tomcat start-up script by typing:: |
|
| 223 |
|
|
| 224 |
sudo /etc/init.d/tomcat5.5 stop |
|
| 225 |
sudo mv /etc/init.d/tomcat5.5 /etc/init.d/tomcat5.5.bak |
|
| 226 |
sudo cp <metacat_package_dir>/debian/tomcat5.5 /etc/init.d/tomcat5.5 |
|
| 227 |
sudo chmod +x /etc/init.d/tomcat5.5 |
|
| 228 |
|
|
| 229 |
|
|
| 230 | 220 |
Apache HTTPD Server (Highly Recommended) |
| 231 | 221 |
........................................ |
| 232 | 222 |
Although you have the option of running Metacat with only the Tomcat server, we |
| ... | ... | |
| 352 | 342 |
sudo /etc/init.d/apache2 restart |
| 353 | 343 |
|
| 354 | 344 |
|
| 355 |
PostgreSQL Database
|
|
| 345 |
PostgreSQL Database |
|
| 356 | 346 |
................... |
| 357 | 347 |
Metacat has been most widely tested with PostgreSQL_ and we recommend using it. |
| 358 | 348 |
Instructions for installing and configuring Oracle are also included in the |
| ... | ... | |
| 486 | 476 |
|
| 487 | 477 |
Ant should be installed on your system and the "ant" executable shell script |
| 488 | 478 |
should be available in the user's path. The latest Metacat release was tested |
| 489 |
with Ant 1.6.5.
|
|
| 479 |
with Ant 1.8.2.
|
|
| 490 | 480 |
|
| 491 | 481 |
Installing Metacat |
| 492 | 482 |
~~~~~~~~~~~~~~~~~~ |
| ... | ... | |
| 515 | 505 |
sudo chown -R <tomcat_user> /var/metacat |
| 516 | 506 |
|
| 517 | 507 |
|
| 518 |
3) Install the Metacat WAR in the Tomcat web-application directory. For instructions on downloading the Metacat WAR, please see Downloading Metacat. Typically, Tomcat will look for its application files (WAR files) in the <tomcat_home>/webapps directory (e.g., /usr/share/tomcat5.5/webapps). Your instance of Tomcat may be configured to look in a different directory. We will refer to the Tomcat application directory as <tomcat_app_dir>. NOTE: The name of the WAR file (e.g., knb.war) provides the application context, which appears in the URL of the Metacat (e.g., http://yourserver.com/knb/). To change the context, simply change the name of the WAR file to the desired name before copying it. To install the Metacat WAR:
|
|
| 508 |
3. Install the Metacat WAR in the Tomcat web-application directory. For instructions on downloading the Metacat WAR, please see Downloading Metacat. Typically, Tomcat will look for its application files (WAR files) in the <tomcat_home>/webapps directory (e.g., /usr/share/tomcat6/webapps). Your instance of Tomcat may be configured to look in a different directory. We will refer to the Tomcat application directory as <tomcat_app_dir>. NOTE: The name of the WAR file (e.g., knb.war) provides the application context, which appears in the URL of the Metacat (e.g., http://yourserver.com/knb/). To change the context, simply change the name of the WAR file to the desired name before copying it. To install the Metacat WAR:
|
|
| 519 | 509 |
|
| 520 | 510 |
:: |
| 521 | 511 |
|
| ... | ... | |
| 526 | 516 |
|
| 527 | 517 |
:: |
| 528 | 518 |
|
| 529 |
/etc/init.d/tomcat5.5 restart
|
|
| 519 |
/etc/init.d/tomcat6 restart
|
|
| 530 | 520 |
|
| 531 | 521 |
Congratulations! You have now installed Metacat. If everything is installed |
| 532 | 522 |
correctly, you should see the Authentication Configuration screen (Figure 2.1) |
| ... | ... | |
| 534 | 524 |
http://knb.ecoinformatics.org/knb) into a browser. For more information about |
| 535 | 525 |
configuring Metacat, please see the Configuration Section. |
| 536 | 526 |
|
| 537 |
.. figure:: images/screenshots/image009.jpg
|
|
| 527 |
.. figure:: images/screenshots/image009.png
|
|
| 538 | 528 |
:align: center |
| 539 | 529 |
|
| 540 | 530 |
The Authentication Configuration screen appears the first time you open a |
| ... | ... | |
| 552 | 542 |
|
| 553 | 543 |
:: |
| 554 | 544 |
|
| 555 |
/etc/init.d/tomcat5.5 stop
|
|
| 545 |
/etc/init.d/tomcat6 stop
|
|
| 556 | 546 |
|
| 557 | 547 |
3. Back up the existing Metacat installation. Although not required, we highly recommend that you back up your existing Metacat to a backup directory (<backup_dir>) before installing a new one. You can do so by typing: |
| 558 | 548 |
|
| ... | ... | |
| 584 | 574 |
|
| 585 | 575 |
:: |
| 586 | 576 |
|
| 587 |
/etc/init.d/tomcat5.5 restart
|
|
| 577 |
/etc/init.d/tomcat6 restart
|
|
| 588 | 578 |
|
| 589 | 579 |
|
| 590 | 580 |
7. Run your new Metacat servlet. Go to a Web browser and visit your installed |
| ... | ... | |
| 710 | 700 |
|
| 711 | 701 |
:: |
| 712 | 702 |
|
| 713 |
sudo cp <metacat_package_directory>/authority.war /usr/share/tomcat5.5/webapps
|
|
| 703 |
sudo cp <metacat_package_directory>/authority.war /usr/share/tomcat6/webapps
|
|
| 714 | 704 |
|
| 715 | 705 |
2. Set up the LSID server by dropping the authority file into Apache's |
| 716 | 706 |
sites-available directory and running a2ensite to enable the site: |
| ... | ... | |
| 765 | 755 |
|
| 766 | 756 |
:: |
| 767 | 757 |
|
| 768 |
/etc/init.d/tomcat5.5 restart
|
|
| 758 |
/etc/init.d/tomcat6 restart
|
|
| 769 | 759 |
|
| 770 | 760 |
5. If you are running Tomcat behind the Apache server (the recommended |
| 771 | 761 |
configuration), set up and enable the authority service site configurations by |
| ... | ... | |
| 824 | 814 |
|
| 825 | 815 |
1. Browse to the KNB Software Download Page. In the Metacat section, select |
| 826 | 816 |
the link that looks like: metacat-bin-X.X.X.zip, where X.X.X is the latest |
| 827 |
version of Metacat (e.g., 1.9.0).
|
|
| 817 |
version of Metacat (e.g., 2.0.0).
|
|
| 828 | 818 |
|
| 829 | 819 |
2. Choose to download and Save the file locally. |
| 830 | 820 |
|
| ... | ... | |
| 844 | 834 |
Before you can install and run Metacat, you must ensure that a recent Java SDK, |
| 845 | 835 |
PostgreSQL and Tomcat are installed, configured, and running correctly. |
| 846 | 836 |
|
| 847 |
* Java_ 6
|
|
| 837 |
* `Java 6`_
|
|
| 848 | 838 |
* `Apache Tomcat`_ |
| 849 | 839 |
* PostgreSQL_ Database |
| 850 | 840 |
|
| ... | ... | |
| 873 | 863 |
............. |
| 874 | 864 |
We recommend that you install Tomcat version 6. To download and install Tomcat: |
| 875 | 865 |
|
| 876 |
1. Browse to: http://tomcat.apache.org/download-55.cgi
|
|
| 866 |
1. Browse to: http://tomcat.apache.org/ |
|
| 877 | 867 |
2. Download the Tomcat core zip file |
| 878 | 868 |
3. Extract Tomcat files to C:\Program Files\tomcat using the windows zip |
| 879 | 869 |
utility. |
Also available in: Unified diff
Merged most recent changes from trunk into the RST converted version of the Administrator's Guide. Now the Sphinx/RST version is up to date rlative to the most recent word document, and is now the active copy. The MS Word document will be deprecated and removed. All future changes should be made to the RST version.