Revision 9386
Added by ben leinfelder over 8 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 7`_ (Note: Java 6 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 6: http://www.oracle.com/technetwork/java/javaee/overview/index.html
|
|
| 33 |
.. _Java 7: http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html
|
|
| 34 | 34 |
|
| 35 | 35 |
System requirements for running Metacat: |
| 36 | 36 |
|
| ... | ... | |
| 59 | 59 |
4. Download Metacat from the `Metacat Download Page`_ and extract the archive |
| 60 | 60 |
5. ``sudo mkdir /var/metacat; sudo chown -R <tomcat_user> /var/metacat`` |
| 61 | 61 |
6. ``sudo cp <metacat_package_dir>/metacat.war <tomcat_app_dir>`` |
| 62 |
7. ``sudo /etc/init.d/tomcat6 restart``
|
|
| 62 |
7. ``sudo /etc/init.d/tomcat7 restart``
|
|
| 63 | 63 |
8. Configure Metacat through the Web interface |
| 64 | 64 |
|
| 65 | 65 |
.. _Metacat Download Page: http://knb.ecoinformatics.org/software/metacat/ |
| ... | ... | |
| 99 | 99 |
File Description |
| 100 | 100 |
================== ===================================================================== |
| 101 | 101 |
metacat.war The Metacat Web archive file (WAR) |
| 102 |
metacat-site Sample Web definition file used by Apache on Ubuntu/Debian |
|
| 102 |
metacat-site.conf Sample Web definition file used by Apache on Ubuntu/Debian
|
|
| 103 | 103 |
Linux systems. |
| 104 |
metacat-site-ssl Sample SSL definition file used by Apache on Ubuntu/Debian |
|
| 104 |
metacat-site-ssl.conf Sample SSL definition file used by Apache on Ubuntu/Debian
|
|
| 105 | 105 |
Linux systems. |
| 106 | 106 |
jk.conf Sample JkMount configuration file used by Apache on |
| 107 | 107 |
Ubuntu/Debian Linux systems. |
| ... | ... | |
| 179 | 179 |
also highly recommend that you install Apache Web server, as it provides a more |
| 180 | 180 |
robust Web-serving environment and is required by some Metacat functionality. |
| 181 | 181 |
|
| 182 |
* `Java 6`_
|
|
| 182 |
* `Java 7`_
|
|
| 183 | 183 |
* `Apache Tomcat`_ |
| 184 | 184 |
* `Apache HTTPD Server`_ (Highly Recommended) |
| 185 | 185 |
* PostgreSQL_ Database (or Oracle_) |
| 186 | 186 |
* `Apache Ant`_ (if building from Source) |
| 187 | 187 |
|
| 188 |
Java 6
|
|
| 188 |
Java 7
|
|
| 189 | 189 |
...... |
| 190 |
To run Metacat, you should use Java 6 (Java 5 is deprecated and will not be |
|
| 191 |
supported after Metacat version 1.9.2). Make sure that the JAVA_HOME |
|
| 190 |
To run Metacat, you should use Java 7. Make sure that the JAVA_HOME |
|
| 192 | 191 |
environment variable is properly set and that both ``java`` and ``javac`` |
| 193 | 192 |
are on your PATH. |
| 194 | 193 |
|
| 195 |
To install Java if you are running Ubuntu_/Debian, you can download the appropriate self-extracting installer::
|
|
| 194 |
To install Java if you are running Ubuntu_/Debian, you can install using apt-get::
|
|
| 196 | 195 |
|
| 197 |
wget http://download.oracle.com/otn-pub/java/jdk/6u30-b12/jdk-6u30-linux-x64.bin |
|
| 198 |
|
|
| 199 |
and follow these commands to install:: |
|
| 200 |
|
|
| 201 |
sudo mkdir -p /opt/java/64 |
|
| 202 |
sudo mv jdk-6u30-linux-x64.bin /opt/java/64 |
|
| 203 |
cd /opt/java/64 |
|
| 204 |
sudo chmod +x jdk-6u30-linux-x64.bin |
|
| 205 |
sudo ./jdk-6u30-linux-x64.bin |
|
| 206 |
sudo update-alternatives --install "/usr/bin/java" "java" "/opt/java/64/jdk1.6.0_30/bin/java" 1 |
|
| 196 |
sudo apt-get install openjdk-7-jdk |
|
| 207 | 197 |
|
| 208 |
You must accept the license agreement during the install process. |
|
| 209 |
|
|
| 210 | 198 |
If you are not using Ubuntu_/Debian, you can get Java from the Oracle_ website and install using the RPM or other installer (Windows). |
| 211 | 199 |
|
| 212 | 200 |
.. _Ubuntu: http://www.ubuntu.com/ |
| 213 | 201 |
|
| 214 | 202 |
Apache Tomcat |
| 215 | 203 |
............. |
| 216 |
We recommend that you install Tomcat 6 into the directory of your choice. |
|
| 204 |
We recommend that you install Tomcat 6 or 7 into the directory of your choice.
|
|
| 217 | 205 |
Included with the Metacat download is a Tomcat-friendly start-up script that |
| 218 | 206 |
should be installed as well. |
| 219 | 207 |
|
| ... | ... | |
| 222 | 210 |
|
| 223 | 211 |
If you are running Ubuntu_/Debian, get Tomcat by typing:: |
| 224 | 212 |
|
| 225 |
sudo apt-get install tomcat6
|
|
| 213 |
sudo apt-get install tomcat7
|
|
| 226 | 214 |
|
| 227 | 215 |
Otherwise, get Tomcat from the `Apache Tomcat`_ page. |
| 228 | 216 |
|
| ... | ... | |
| 238 | 226 |
|
| 239 | 227 |
For DataONE deployments edit:: |
| 240 | 228 |
|
| 241 |
/etc/tomcat6/catalina.properties
|
|
| 229 |
/etc/tomcat7/catalina.properties
|
|
| 242 | 230 |
|
| 243 | 231 |
to include:: |
| 244 | 232 |
|
| ... | ... | |
| 354 | 342 |
sudo a2dismod jk |
| 355 | 343 |
sudo a2enmod jk |
| 356 | 344 |
|
| 357 |
4. Apache needs to know about the Metacat site. The helper file named "metacat-site" has rules that tell Apache which traffic to route to Metacat. Set up Metacat site by dropping the metacat-site file into the sites-available directory and running a2ensite to enable the site: |
|
| 345 |
4. Apache needs to know about the Metacat site. The helper file named "metacat-site.conf" has rules that tell Apache which traffic to route to Metacat. Set up Metacat site by dropping the metacat-site file into the sites-available directory and running a2ensite to enable the site:
|
|
| 358 | 346 |
|
| 359 | 347 |
:: |
| 360 | 348 |
|
| 361 |
sudo cp <metacat_helper_dir>/metacat-site <apache_install_dir>/sites-available |
|
| 362 |
sudo a2ensite metacat-site |
|
| 349 |
sudo cp <metacat_helper_dir>/metacat-site.conf <apache_install_dir>/sites-available
|
|
| 350 |
sudo a2ensite metacat-site.conf
|
|
| 363 | 351 |
|
| 364 | 352 |
5. Disable the default Apache site configuration: |
| 365 | 353 |
|
| ... | ... | |
| 537 | 525 |
sudo chown -R <tomcat_user> /var/metacat |
| 538 | 526 |
|
| 539 | 527 |
|
| 540 |
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., metacat.war) provides the application context, which appears in the URL of the Metacat (e.g., http://yourserver.com/metacat/). To change the context, simply change the name of the WAR file to the desired name before copying it. To install the Metacat WAR:
|
|
| 528 |
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/tomcat7/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., metacat.war) provides the application context, which appears in the URL of the Metacat (e.g., http://yourserver.com/metacat/). To change the context, simply change the name of the WAR file to the desired name before copying it. To install the Metacat WAR:
|
|
| 541 | 529 |
|
| 542 | 530 |
:: |
| 543 | 531 |
|
| ... | ... | |
| 548 | 536 |
|
| 549 | 537 |
:: |
| 550 | 538 |
|
| 551 |
sudo /etc/init.d/tomcat6 restart
|
|
| 539 |
sudo /etc/init.d/tomcat7 restart
|
|
| 552 | 540 |
|
| 553 | 541 |
Congratulations! You have now installed Metacat. If everything is installed |
| 554 | 542 |
correctly, you should see the Authentication Configuration screen (Figure 2.1) |
| ... | ... | |
| 574 | 562 |
|
| 575 | 563 |
:: |
| 576 | 564 |
|
| 577 |
/etc/init.d/tomcat6 stop
|
|
| 565 |
/etc/init.d/tomcat7 stop
|
|
| 578 | 566 |
|
| 579 | 567 |
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: |
| 580 | 568 |
|
| ... | ... | |
| 606 | 594 |
|
| 607 | 595 |
:: |
| 608 | 596 |
|
| 609 |
/etc/init.d/tomcat6 restart
|
|
| 597 |
/etc/init.d/tomcat7 restart
|
|
| 610 | 598 |
|
| 611 | 599 |
|
| 612 | 600 |
7. Run your new Metacat servlet. Go to a Web browser and visit your installed |
| ... | ... | |
| 732 | 720 |
|
| 733 | 721 |
:: |
| 734 | 722 |
|
| 735 |
sudo cp <metacat_package_directory>/authority.war /usr/share/tomcat6/webapps
|
|
| 723 |
sudo cp <metacat_package_directory>/authority.war /usr/share/tomcat7/webapps
|
|
| 736 | 724 |
|
| 737 | 725 |
2. Set up the LSID server by dropping the authority file into Apache's |
| 738 | 726 |
sites-available directory and running a2ensite to enable the site: |
| ... | ... | |
| 787 | 775 |
|
| 788 | 776 |
:: |
| 789 | 777 |
|
| 790 |
/etc/init.d/tomcat6 restart
|
|
| 778 |
/etc/init.d/tomcat7 restart
|
|
| 791 | 779 |
|
| 792 | 780 |
5. If you are running Tomcat behind the Apache server (the recommended |
| 793 | 781 |
configuration), set up and enable the authority service site configurations by |
| ... | ... | |
| 866 | 854 |
Before you can install and run Metacat, you must ensure that a recent Java SDK, |
| 867 | 855 |
PostgreSQL and Tomcat are installed, configured, and running correctly. |
| 868 | 856 |
|
| 869 |
* `Java 6`_
|
|
| 857 |
* `Java 7`_
|
|
| 870 | 858 |
* `Apache Tomcat`_ |
| 871 | 859 |
* PostgreSQL_ Database |
| 872 | 860 |
|
| 873 |
Java 6
|
|
| 861 |
Java 7
|
|
| 874 | 862 |
...... |
| 875 |
To run Metacat, you must have Java 6. (Java 5 is deprecated). Make sure that
|
|
| 863 |
To run Metacat, you must have Java 7. Make sure that
|
|
| 876 | 864 |
the JAVA_HOME environment variable is properly set and that both java and javac |
| 877 | 865 |
are on your PATH. |
| 878 | 866 |
|
| 879 | 867 |
To download and install Java: |
| 880 | 868 |
|
| 881 |
1. Browse to: http://java.sun.com/javase/downloads/widget/jdk6.jsp and follow
|
|
| 882 |
the instructions to download JDK 6.
|
|
| 869 |
1. Browse to: http://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html and follow
|
|
| 870 |
the instructions to download JDK 7.
|
|
| 883 | 871 |
|
| 884 | 872 |
2. Run the downloaded installer to install Java. |
| 885 | 873 |
|
| ... | ... | |
| 888 | 876 |
|
| 889 | 877 |
:: |
| 890 | 878 |
|
| 891 |
System Variable: JAVA_HOME C:\Program Files\Java\jdk1.6.0_18
|
|
| 879 |
System Variable: JAVA_HOME C:\Program Files\Java\jdk1.7.0_79
|
|
| 892 | 880 |
(or whichever version you downloaded) |
| 893 | 881 |
|
| 894 | 882 |
Apache Tomcat |
| 895 | 883 |
............. |
| 896 |
We recommend that you install Tomcat version 6. To download and install Tomcat:
|
|
| 884 |
We recommend that you install Tomcat version 7. To download and install Tomcat:
|
|
| 897 | 885 |
|
| 898 | 886 |
1. Browse to: http://tomcat.apache.org/ |
| 899 | 887 |
2. Download the Tomcat core zip file |
Also available in: Unified diff
update documentation to reference Tomcat 7, Java 7 and newer apache config file name conventions. https://projects.ecoinformatics.org/ecoinfo/issues/6855