You are here

Installing the Tomcat application server

Install an instance of Tomcat manually and modify it to use the correct directory structure and files for Alfresco Community Edition.

The installation directory for Tomcat is represented as <TOMCAT_HOME>.

  1. Download and install Tomcat following the instructions from http://tomcat.apache.org.
  2. Create an additional classpath to Tomcat, which will be shared among all web applications.
    1. Create the directories required for an Alfresco Community Edition installation under <TOMCAT_HOME>:

      • Create the shared/classes directory.
      • Create the shared/lib directory.
    2. Open the <TOMCAT_HOME>/conf/catalina.properties file.
    3. Change the value of the shared.loader= property to the following:

      shared.loader=${catalina.base}/shared/classes
  3. Copy the JDBC drivers for the database you are using to the lib directory.
  4. (Optional) If you plan to use Kerberos authentication.

    By default, Tomcat uses an 8 KB header buffer size, which might not be large enough for the Kerberos authentication protocol. We need to increase this buffer size. To make this change, edit the <TOMCAT_HOME>/conf/server.xml file and change the <Connector> defined for HTTP traffic as follows:

    <Connector port="8080" protocol="HTTP/1.1"
        URIEncoding="UTF-8"
        connectionTimeout="20000"
        maxHttpHeaderSize="32768"
        redirectPort="8443" />
  5. (Optional) Configure additional connectors.

    You might want to connect from your front end load balancer with a different protocol, like AJP, or you might want to terminate TLS directly in Tomcat.

    In these cases, you need to add additional connectors to Tomcat. Follow the official Tomcat documentation for these use cases, and make sure to increase the maxHttpHeaderSize on these additional Connectors as well (in case you plan to use Kerberos).

  6. (Optional) Enable Simple JAR modules.

    The Alfresco Community Edition repository allows you to provide extensions outside of the web application, known as simple JAR modules. If you want to enable this mechanism, follow these steps:

    1. Create the following directories under <TOMCAT_HOME>:

      1. modules/platform
      2. modules/share
    2. Copy the files alfresco.xml and share.xml from the distribution zip /web-server/conf/Catalina/localhost to <TOMCAT_HOME>/conf/Catalina/localhost (or hostname).
  7. Configure mutual TLS for Solr communication.

    The communication with Solr is encrypted and authenticated via mutual TLS. For this connection, you need an additional Connector.

    Note: This Connector is not used by end users. Its sole purpose is to handle the communication with Solr.
    1. Open the <TOMCAT_HOME>/conf/server.xml file.
    2. Add the following Connector:

      <Connector port="8443" protocol="org.apache.coyote.http11.Http11Protocol"

          SSLEnabled="true" maxThreads="150" scheme="https"

          keystoreFile="xxxxx"

          keystorePass="password" keystoreType="JCEKS" 
          secure="true" connectionTimeout="240000"

          truststoreFile="xxxxx"

          truststorePass="password" truststoreType="JCEKS" 
          clientAuth="want" sslProtocol="TLS" />

      Note: The keystore and truststore file locations in the above example will be created later, when you install and configure Alfresco Search Services.
      Note: If you're using a different keystore or truststore type other than the default, JCEKS, you must change the value in the properties file.
  8. Save the server.xml file.
Important: Remember to review and update the Connector details in server.xml, including the keystore and truststore file locations, after installing and configuring Alfresco Search Services.

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.