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. Clone the project locally, change directory to the project folder, and switch to the release branch:

    git clone https://github.com/Alfresco/acs-deployment.git
    cd acs-deployment
    git checkout support/HF/1.0

    In this example, the branch support/HF/1.0 contains to the latest Alfresco Content Services 6.0.1 release.

    You can replace the branch name with a release tag that corresponds to specific version of Alfresco Content Services. See Alfresco Content Service deployment - Releases for a list of releases.

    You can skip the git checkout command to deploy Alfresco Content Services using the latest images. By doing this, you'll access the latest (and possibly unreleased) components, such as release candidates (i.e. -RC).

    Alternatively, you can use the following link to view or download the project source code (as a zip file):

    https://github.com/Alfresco/acs-deployment/tree/support/HF/1.0
  2. Change directory to the docker-compose folder:

    cd docker-compose
  3. 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_alfresco-pdf-renderer_1 ... done
    Creating docker-compose_solr6_1                 ... done
    Creating docker-compose_postgres_1              ... done
    Creating docker-compose_imagemagick_1           ... done
    Creating docker-compose_libreoffice_1           ... done
    Creating docker-compose_share_1                 ... done
    Creating docker-compose_alfresco_1              ... done
    Attaching to docker-compose_postgres_1, docker-compose_solr6_1, docker-compose_alfresco-pdf-renderer_1, docker-compose_imagemagick_1, docker-compose_alfresco_1, docker-compose_libreoffice_1, docker-compose_share_1
    ...

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

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

    ...
    alfresco_1 | 2018-08-28 08:40:30,386  INFO  [management.subsystems.ChildApplicationContextFactory] [http-nio-8080-exec-10] Starting 'Transformers' subsystem, ID: [Transformers, default]
    alfresco_1 | 2018-08-28 08:40:30,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 containers (using the --rmi all option):
      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 to step 3 (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.
  5. Open your browser and check everything starts up correctly:

    • Share: http://localhost:8080/share
    • REST APIs and administration: http://localhost:8082/alfresco
    • Search administration: http://localhost:8083/solr
  6. Log in as the admin user. Enter the default administrator password admin.

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.