You are here

Deploy using Docker Compose

Use this information to quickly deploy Alfresco Governance Services using Docker Compose. Due to the limited capabilities of Docker Compose, this deployment method is recommended for development and test environments only.

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
    • Alfresco customers can request Quay.io credentials by logging a ticket at Alfresco Support. These credentials are required to pull private (Enterprise-only) Docker images from Quay.io.
Note: Make sure that 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 Alfresco Content Services 6.1 docker-compose.yml file from GitHub.
  2. Save the file in a local folder.
  3. Edit the file and change the following two services:

    Add a # prefix to the Alfresco Content Repository and Alfresco Share locations so they are commented out, and add the Alfresco Governance image locations

    services:
        alfresco:
            #image: alfresco/alfresco-content-repository:6.1.x
            image: quay.io/alfresco/alfresco-governance-repository-enterprise:3.2.x
            ... 
        share:
            #image: alfresco/alfresco-share:6.1.x
            image: quay.io/alfresco/alfresco-governance-share-enterprise:3.2.x
            ... 
  4. In a command prompt 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>>
  5. In the command prompt change directory to the location of the docker-compose.yml file and deploy Alfresco Governance Services 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.

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

    docker-compose up -d
  7. Wait for the logs to complete.

    ...
    alfresco_1 | 2018-10-05 13:59:36,469  INFO  [management.subsystems.ChildApplicationContextFactory] [http-nio-8080-exec-1] Starting 'Search' subsystem, ID: [Search, managed, solr6]
    alfresco_1 | 2018-10-05 13:59:36,903  INFO  [management.subsystems.ChildApplicationContextFactory] [http-nio-8080-exec-1] Startup of 'Search' subsystem, ID: [Search, managed, solr6] 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.
  8. Open your browser and check everything starts up correctly:

    • Share: http://localhost:8080/share

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.