Close

Install using Docker Compose

Use this information to quickly deploy 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 and supported platforms

  • 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.

Installation steps

  1. Download the latest Alfresco Content Services docker-compose.yml file by accessing the trial download page.

  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 Docker image locations so they are commented out, and add the Alfresco Governance image locations, change 3.4.x to latest 3.4 version:

     services:
         alfresco:
             #image: alfresco/alfresco-content-repository:6.2.x
             image: quay.io/alfresco/alfresco-governance-repository-enterprise:3.4.x
             mem_limit: 1700m
               
    
         share:
             #image: alfresco/alfresco-share:6.2.x
             image: quay.io/alfresco/alfresco-governance-share-enterprise:3.4.x
             mem_limit: 1g
               
    
  4. In a command prompt login to Quay using the following command (to open up access to Enterprise Docker images):

     $ 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 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.

    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.

     ...
     alfresco_1            | 09-Jun-2020 08:41:58.156 INFO [main] org.apache.coyote.AbstractProtocol.start Starting ProtocolHandler ["http-nio-8080"]
     alfresco_1            | 09-Jun-2020 08:41:58.206 INFO [main] org.apache.coyote.AbstractProtocol.start Starting ProtocolHandler ["ajp-nio-8009"]
     alfresco_1            | 09-Jun-2020 08:41:58.261 INFO [main] org.apache.catalina.startup.Catalina.start Server startup in 226026 ms
    

    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:

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

Final step before you can start with Records Management is to create the Records Management site.

Edit this page

Suggest an edit on GitHub
This website uses cookies in order to offer you the most relevant information. Please accept cookies for optimal performance. This documentation is subject to the Alfresco documentation terms.