You are here

Deploy using Docker Compose

Use this information to quickly start up Alfresco Content Services and Alfresco Search and Insight Engine using Docker Compose.

Prerequisites

  • Docker
    • This allows you to run Docker images and Docker Compose on a single computer.
  • Docker Compose
    • Docker Compose is included as part of some Docker installers. If it's not part of your installation, then install it separately after you've installed Docker.
  • Access to Quay.
    • Docker requires access to certain images which are stored on Quay. You need to use the correct credentials provided by Alfresco to access these images. Contact Alfresco Support to request the credentials.
Note: Make sure the following ports are free on your computer: 5432, 8080, 8082, 8083. These ports are set in the docker-compose.yml file.
  1. Download the latest Alfresco Content Services docker-compose.yml file by accessing the trial download page. Save the file in a local folder.
  2. Edit the file and change the Solr 6 service, see below. Save the file. (Add a # prefix to Alfresco Search Services so it is commented out).

        solr6:
            #image: alfresco/alfresco-search-services:1.2
            image: quay.io/alfresco/insight-engine:1.0.0
            mem_limit: 2500m
            environment:
                #Solr needs to know how to register itself with Alfresco
                    - SOLR_ALFRESCO_HOST=alfresco
                    - SOLR_ALFRESCO_PORT=8080
                #Alfresco needs to know how to call solr
                    - SOLR_SOLR_HOST=solr6
                    - SOLR_SOLR_PORT=8983
                #Create the default alfresco and archive cores
                    - SOLR_CREATE_ALFRESCO_DEFAULTS=alfresco,archive
                    - "SOLR_JAVA_MEM=-Xms2g -Xmx2g"
            ports:
                - 8083:8983 #Browser port

    Note: If you want to use the Apache Zeppelin visualisation interface with Search and Insight Engine you have to deploy it using Docker Compose, along with Alfresco Content Services 6.0 and Search and Insight Engine. You cannot install it manually. See Deploy Alfresco Insight Zeppelin using Docker Compose for the additional container information you need to add to your docker-compose.yml file.
  3. Log in to Quay using the following command:

    $ docker login quay.io
                login against server at https://quay.io/v1/
                Username: <<Quay.io Credential Username>>
                Password: <<Quay.io Credential Password>>
  4. Change directory to the location of the docker-compose.yml file and deploy Alfresco Content Services and Search and Insight Engine using the following command:

    docker-compose up

    This downloads the images, fetches all the dependencies, creates each container, and then starts the system. If you downloaded the project and changes were made to the project settings, any new images will be pulled from Quay before the system starts.

  5. As an alternative, you can also start the containers in the background by running:

    docker-compose up -d
  6. Wait for the logs to complete, the following message will display:

    ...
    alfresco_1 | 2018-05-08 21:02:20,386  INFO  [management.subsystems.ChildApplicationContextFactory] [http-nio-8080-exec-10] Starting 'Transformers' subsystem, ID: [Transformers, default]
    alfresco_1 | 2018-05-08 21:02:20,661  INFO  [management.subsystems.ChildApplicationContextFactory] [http-nio-8080-exec-10] Startup of 'Transformers' subsystem, ID: [Transformers, default] complete

    If you encounter errors whilst the system is starting up:

    • Stop the session (by using CONTROL+C).
    • Remove the container (using the --rmi all option): For example docker-compose down --rmi all.
    • Try allocating more memory resources, as advised in docker-compose.yml. For example, in Docker, change the memory setting in Preferences (or Settings) > Advanced > Memory, to at least 6 GB. Make sure you restart Docker and wait for the process to finish before continuing.
    • Go back and retry the deployment.
    Note: Although 16 GB is the required minimum memory setting, keep in mind that 6 GB is much lower than the required minimum, and may need to be adapted for your environment.
  7. Open your browser and check everything starts up correctly:

    • Alfresco: http://localhost:8082/alfresco
    • Share: http://localhost:8080/share
    • Solr: http://localhost:8083/solr
      Note: You will see the version of Search and Insight Engine that has installed.

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.