Child pages
  • DspaceOnStandardPorts
Skip to end of metadata
Go to start of metadata

Running DSpace on Standard Ports (80 for http:// and 443 for https://)

Since it is not trivial to get a Java servlet container, such as Apache Tomcat to listen on the "standard" TCP ports for a web server, this page explains alternative ways to accomplish it.

What does "port" mean? A server program, like a web server, has to "listen" (i.e. tell the operating system it is offering a service; accepts incoming requests) at a well-known port so that clients, like your web browser, can find it. The combination of host and port uniquely identifies a service:
For example, the URL http://dspace.mit.edu/  identifies a network service running on host dspace.mit.edu and port 80 (the default HTTP port).

It is desirable to implement DSpace on the default ports so you don't have to clutter your URLs with port numbers and try to get users to remember them.

The problem arises on Unix-based servers because the default, well-known, web server ports are in the range that require root (superuser) privileges to listen on. Since the DSpace server (a Java VM) should always be running as an unprivileged user, it cannot directly open these ports. It can only listen on higher-numbered ports. So, the solution is to run the JVM as an unprivileged user and find a way to accept HTTP requests on the standard ports and redirect them to the higher-numbered ports.

Icon

When using Apache 2.4.2 (and lower) in front of a DSpace webapp deployed in Tomcat, mod_proxy_ajp and possibly mod_proxy_http breaks the connection to the back end (Tomcat) prematurely leading to response mixups. This is reported as bug CVE-2012-3502 (http://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2012-3502) of Apache and fixed in Apache 2.4.3 (see http://www.apache.org/dist/httpd/CHANGES_2.4). The 2.2.x branch hasn't shown this problem only the 2.4.x branch has.

See Also

Method 1 - redirecting with IP tables

This is known to work on Red Hat Enterprise Linux 3 and other similar versions of GNU/Linux. Use the iptables utility to redirect requests on the default ports to the higher-numbered ports where the DSpace servlet container is actually listening.

This allows you to use a pure Java servlet container such as Jetty or Apache Tomcat as the actual web server.

See your system's documentation for the iptables and iptables-save commands for more information.

Example: Route HTTP (port 80) to port 8080 and HTTPS (port 443) to port 8443:

Then write the current state of the tables to a configuration file so they are automatically restored to this state after the system is booted:

Configure your Java Servlet container to listen to ports 8080 and 8443 for HTTP and HTTPS connections, respectively.

Method 1b - Write your own iptables config file

Here is an expanded example:
edit the /etc/sysconfig/iptables file (make a backup of this file first!)

Open the standard ports 80 and 443 and the redirect ports 7780 and 7781 in this example inside the *filter block of statements followed by the redirect statements in the *nat block of statements (nat stands for network address translation) ... here is an example of that file (redhat WS3, a 2.4 linux kernel is requried, consult the excellent HOWTOS Documentation at http://www.netfilter.org)

Restart the network

Restart Tomcat as non-root user on port 7780/7781 (edit your conf/server.xml file for this)

Load the URL for port 80 which will get redirect to your tomcat on port 7780

And I'll just add this here on how to get tomcat running in ssl mode:

  • create a directory like /usr/local/jakarta-tomcat-5.0.27/conf/ssl.new
  • copy or link your insitution server.key and server.crt files in this directory
  • execute this command to create the keystore file, this will prompt you for a password you must supply "changeit" without the quotes

* Then change the ownership on

to the user which runs the tomcat server

* Next edit your conf/server.xml file and edit the section for the 8443 connector and add these 3 lines (be sure to add them inside the block of statements that starts with <Connector port="7781" ... and ends with ... />, you may have to uncomment that entire block of statements too since by default these connector statements are wrapped inside tags)

* Restart tomcat

Method 2a - Use Apache HTTPD (mod_proxy_ajp) + Tomcat (port 8009)

This assumes you have the following working:

  1. httpd is running and listening on port 80
  2. tomcat is running and listening on port 8009,8080

By convention, web-servers listen on port 80 to deliver content such as static html files. So that web browsers can

  • Set Tomcat to serve up DSpace by default

* Configure /etc/httpd/conf.d/ssl.conf or proxy_ajp.conf

Note:

  1. You'll need to reload or restart the httpd service
  2. The "!" <bang> sets Apache web-server to NOT REDIRECT everything under /do_not_touch

Method 2b - use Apache HTTPD / Tomcat connector (mod_jk)

Run Apache HTTPD as a front-end for Tomcat, see
the mod_jk wiki page
This is tricky to set up, but secure.

Method 3 - use Apache to redirect requests to Tomcat on port 8080

For RedHat LINUX server:

In /etc/httpd/conf/httpd.conf:

1. Ensure the following modules are listed under "# Dynamic Shared Object (DSO) Support", this is a list showing all modules loaded by Apache:

2. Add the following lines after the <tt><Location></tt> context:
(Note: our dspace url is: http://rose.bris.ac.uk)

3. Ensure Server Name is also set:

4. Restart Apache:

In order to display the dspace home page, not the tomcat home page when accessing http://rose.bris.ac.uk

1. Create a page called HelloWorld.jsp in the directory below:

2. Add the following lines to the HelloWorld.jsp:

Next. In the same directory, add the following to index.jsp just after the <body> tag:-

3. Edit: ../ROOT/WEB-INF/web.xml, disable the following text as follows:

4. Re-start tomcat

Method 4 - Use Tomcat's jsvc daemon

Note: Only works for Unix like platforms.
This documentation is based on Solaris 10 using the Solaris Service Management Facility.
See http://jakarta.apache.org/commons/daemon/jsvc.html
for more details

  1. Download and install Tomcat from jakarta.apache.org
  2. Compile jsvc
    • export JAVA_HOME=/usr/java
    • cd $CATALINA_HOME/bin
    • gunzip jsvc.tar.gz && tar -xvf jsvc.tar
    • ./configure
    • gmake
    • cp jsvc ..
    • cd ..
    • chown tomcat:tomcat jsvc
    • rm -rf jsvc-src
  3. Setup your Service Management Facility process
    1. create the following file: /lib/svc/method/dspace

    2. Create the profile: /var/svc/manifest/application/dspace.xml

      3. Now import the profile

4. Modify Tomcat's Connector in server.xml

5. Enable Tomcat

 Method 5 - Tomcat on low ports natively with authbind 

See:

  • No labels