You are here

Installing the Alfresco WARs

A WAR file is a JAR file used to distribute a collection of files (JavaServer Pages, servlets, Java classes, XML files, tag libraries, and static web pages) that together constitute a web application.

Use this method of installing if you've already installed a JRE, a supported database, an application server, and the additional components.
The Alfresco Content Services Distribution file is a zip containing the required WAR files, in addition to the additional commands, and configuration files for a manual installation.
  1. Browse to the Support Portal at
  2. Download the following file:

  3. Specify a location for the download and extract the file.

    You see the following directory structure:


    The Distribution zip also contains the following file:


    The file provides a list of recommended components for the latest Alfresco Content Services release.

    The /alf_data directory contains the following directory:


    This directory contains the following files:

    File name Description
    browser.p12 The pkcs12 keystore generated from ssl.keystore that contains the repository private key and certificate for use in browsers, such as Firefox.
    CreateSSLKeystores.txt Contains instructions to create an RSA public/private key pair for the repository with a certificate that has been signed by the Alfresco Certificate Authority (CA).
    generate_keystores.bat Windows batch file for generating secure keys for Solr communication. Linux script file for generating secure keys for Solr communication.
    keystore Secret key keystore containing the secret key used to encrypt and decrypt node properties. Contains password protecting the keystore entries.
    readme.txt Text file containing information about other files in a directory. Contains passwords for SSL keystore. Contains passwords for SSL truststore.
    ssl.keystore Repository keystore containing the repository private/public key pair and certificate.
    ssl.truststore Repository truststore containing certificates that the repository trusts.

    The /alfresco-pdf-renderer directory contains the following files:

    File name Description
    alfresco-pdf-renderer-1.0-linux.tgz alfresco-pdf-renderer binary for Linux
    alfresco-pdf-renderer-1.0-win64.tgz alfresco-pdf-renderer binary for Windows
    alfresco-pdf-renderer-1.0-osx.tgz alfresco-pdf-renderer binary for Mac

    The /amps directory contains the following files:

    File name Description
    alfresco-share-services.amp Share Services AMP

    You can create an /amps_share directory to add any Share AMP files that you want to install separately.

    Important: If you do not apply the Share Services AMP to the repository, Alfresco Share will not work correctly, and when you start up Share, you will see the message: Alfresco Content Services is running without Share Services. See your System Administrator for more details.

    See step 18 of the wizard install topic for more information.

    The /bin directory contains these files:

    File name Description




    These DLLs handle the connection between the native CIFS server and Alfresco Content Services.
    alfresco-mmt.jar Alfresco Module Management Tool (MMT).
    alfresco-spring-encryptor.jar Alfresco Encrypted Properties Management tool
    apply_amps.bat Windows batch file for Tomcat application server installs, used to apply all AMP files in the <installLocation> directory. Linux script file for Tomcat application server installs, used to apply all AMP files in the <installLocation> directory.
    clean_tomcat.bat Windows batch file for cleaning out temporary application server files from previous installations. Linux script for cleaning out temporary application server files from previous installations.

    The /licenses directory contains the following structure:


    This directory contains the third-party license files.

    You can create a /modules directory with the following structure:
    Put simple JAR modules in these folders so that they're loaded when Alfresco Content Services starts up. See Simple Module for more information.

    The /solr4 directory contains the following files and folders:
    File or folder name Description
    /alfrescoModels This directory contains all the content models that come out of the box. Any new custom content model added are synced to this directory so that Solr 4 knows about it.
    /archive-SpacesStore Configuration directory for the archive core.
    /conf Contains configuration files.
    context.xml Configuration file specifies the Solr web application context template to use when installing Solr in separate tomcat server.
    /lib This directory contains extra libraries that Solr 4 loads on start up. These libraries are used to communicate by using CMIS, Alfresco data model or Alfresco Surf Web Scripts. Configuration file for Solr 4-specific logging.
    solr.xml Configuration file which specifies the cores to be used by Solr 4.
    /workspace-SpacesStore Configuration directory for the workspace core.

    The /web-server directory has a standard Tomcat structure:

    The /conf directory contains Catalina repository and Share xml files.

    The /lib directory contains the PostgreSQL JDBC jar file.

    The /shared directory includes the Alfresco Content Services configuration files:
    File name Description
    /classes/ The sample global properties file, which is used for configuration properties.
    /classes/ A sample encrypted properties overlay file.
    /classes/alfresco Contains the directory structure for the configuration override files, including the extension, and web-extension directories.
    The /webapps directory contains these files:
    File name Description
    alfresco.war The Alfresco WAR file
    ROOT.war Application for the server root
    share.war The Alfresco Share WAR file
    solr4.war The Solr 4 WAR file
  4. Move the WAR files from /webapps to the appropriate location for your application server.

    For example, for Tomcat, move the WAR files to the <TOMCAT_HOME>/webapps directory. If you already have a web application that is running in the server root, see Installing into an existing web application for instructions on how to merge the files into your application.

    Note: If you are using JBoss, you must customize the web.xml for all WAR files to include this code fragment:
    This ensures that the JSF deployer in JBoss uses its own bundled JSF version.
  5. Move the contents from /conf, /lib, and /shared to the appropriate location for your application server.
  6. Remove all directories in <TOMCAT_HOME>/webapps.

    If you do not remove these directories, then the WAR files are not deployed when the server starts.

  7. Edit the /shared/classes/ file with your configuration settings.

    As a minimum, uncomment and edit the following properties in the selected sections:

    # Sample custom content and index data location
    # Solr indexing
    # Sample database connection properties 
    # PostgreSQL connection
    # URL Generation Parameters

    Note: See Managing search services and Solr subsystem for more on Solr indexing properties.
  8. Save the file without the .sample extension.
  9. Move the file to <classpathRoot>.

    For example, <TOMCAT_HOME>/shared/classes.

You are now ready to install any additional software that you require. See Installing additional software for Alfresco Content Services and Installing integrations for more information.
Note: If you deployed previous versions of Alfresco Content Services, you must remove any temporary files created by your application server. Use the clean_tomcat.bat or command.
Note: If you are installing the S3 Connector as part of your installation, do not start Alfresco Content Services before applying the S3 AMP file.
Important: After installation, you must generate and install your own certificates to secure the installation. For more information, see Generating Secure Keys for Solr 4 Communication.

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.