You are here

Deploying using Docker Compose

Use this information to quickly start up Alfresco Content Services using Docker Compose. This deployment method is only supported for development and test environments.

To deploy Alfresco Content Services using docker-compose, download and install Docker, then follow the steps below.

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. Get the latest docker-compose.yml file by accessing the Alfresco Content Services trial download page.

    Save the docker-compose.yml file in a local folder.

    You can download the docker-compose.yml file directly from GitHub, or clone the project locally, and then change directory to the project folder:

    git clone https://github.com/Alfresco/acs-deployment.git
    cd acs-deployment/docker-compose
  2. Deploy Alfresco Content Services, including the repository, Share, Postgres database, and Search Services:

    docker-compose up

    This downloads the images, fetches all the dependencies, creates each container, and then starts the system:

    Creating network "docker-compose_default" with the default driver
    ...
    Creating docker-compose_imagemagick_1           ... done
    Creating docker-compose_alfresco_1              ... done
    Creating docker-compose_alfresco-pdf-renderer_1 ... done
    Creating docker-compose_share_1                 ... done
    Creating docker-compose_libreoffice_1           ... done
    Creating docker-compose_solr6_1                 ... done
    Creating docker-compose_postgres_1              ... done
    Attaching to docker-compose_share_1, docker-compose_alfresco-pdf-renderer_1, docker-compose_alfresco_1, 
    docker-compose_imagemagick_1, docker-compose_libreoffice_1, docker-compose_postgres_1, docker-compose_solr6_1
    ...

    If you downloaded the project and changes were made to the project settings, any new images will be pulled from GitHub before the system starts.

    As an alternative, you can also start the containers in background by running docker-compose up -d.

  3. Wait for the logs to complete, showing message:

    ...
    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 in step 6 of Checking system start up).
    • 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 to step 2 (above) to start the deployment again.
    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.
  4. Open your browser and check everything starts up correctly:

    • Alfresco: http://localhost:8082/alfresco
    • Share: http://localhost:8080/share
    • Solr: http://localhost:8083/solr
  5. Log in to Alfresco Share and start using it.

You can use a number of commands to check that the system started correctly. See Checking system start up for more.

See the Alfresco/acs-deployment GitHub project documentation for the prerequisites and detailed setup: Deploying using Docker Compose

In this project, you can use the docker-compose.yml file following the documentation for standard installations, or customize the file to apply settings as appropriate to your specific deployment environment.

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.