You are here

Deploying using Docker Compose

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

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

  1. Clone the project locally, change directory to the project folder, and switch to the release branch:

    git clone https://github.com/Alfresco/acs-community-deployment.git
    cd acs-community-deployment
    git checkout 2.2.0
    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.

    In this example, the release tag 2.2.0 relates to the latest Alfresco Community Edition 201901 GA release that uses the repository image tag 6.1.2-ga.

    You can skip the git checkout command to deploy Alfresco Community Edition 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-community-deployment/tree/2.2.0

    You can find a list of releases in the following page:

  2. Change directory to the docker-compose folder:

    cd docker-compose
  3. Deploy Alfresco Community Edition, including the repository, Share, Postgres database, Search Services, etc.:

    docker-compose up

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

    ...
    Creating docker-compose_activemq_1 ... done
    Creating docker-compose_postgres_1 ... done
    Creating docker-compose_solr6_1    ... done
    Creating docker-compose_share_1    ... done
    Creating docker-compose_alfresco_1 ... done
    Attaching to docker-compose_postgres_1, docker-compose_share_1, docker-compose_alfresco_1, docker-compose_activemq_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 the background by running docker-compose up -d.

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

    ...
    alfresco_1 | 2019-02-21 11:50:50,388  INFO ... Starting 'Transformers' subsystem, ID: [Transformers, default]
    alfresco_1 | 2019-02-21 11:50.50,782  INFO ... 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:

    • Administration and REST APIs: http://localhost:8082/alfresco
    • Share: http://localhost:8080/share
    • 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-community-deployment GitHub project documentation for the prerequisites. You'll find a link to the relevant detailed setup in the Docker Compose steps section.

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.