Close

Install using Docker Compose

Use this information to quickly start up Community Edition using Docker Compose.

Note: While Docker Compose is often used for production deployments, the Docker Compose file provided is recommended for development and test environments only. Customers are expected to adapt this file to their own requirements, if they intend to use Docker Compose to deploy a production environment.

To deploy Community Edition using Docker Compose, download and install Docker, then follow the steps below. Make sure that you’ve reviewed the prerequisites before continuing.

  1. Clone the project locally, and change directory to the project’s docker-compose folder:

     git clone https://github.com/Alfresco/acs-deployment.git
     cd acs-deployment/docker-compose
    

    Note: Make sure that exposed ports are open on your host computer. Check the docker-compose.yml file to determine the exposed ports - refer to the host:container port definitions. You’ll see they include 5432, 8080, 8083 and others.

  2. Deploy Community Edition, including the repository, Share, Postgres database, Search Services, etc.:

     docker-compose -f community-docker-compose.yml up
    

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

     ...
     ⠿ Network docker-compose_default                         Created        ...        0.2s
     Container docker-compose-transform-core-aio-1            Created        ...        0.0s
     ✔ Container docker-compose-share-1                       Created        ...        0.1s
     ✔ Container docker-compose-control-center-1              Created        ...        0.0s
     ✔ Container docker-compose-solr6-1                       Created        ...        0.1s
     ✔ Container docker-compose-postgres-1                    Created        ...        0.0s
     ✔ Container docker-compose-activemq-1                    Created        ...        0.1s
     ✔ Container docker-compose-alfresco-1                    Created        ...        0.1s
     ✔ Container docker-compose-content-app-1                 Created        ...        0.0s
     ✔ Container docker-compose-proxy-1                       Created        ...        0.1s
     Attaching to docker-compose-activemq-1, docker-compose-alfresco-1, docker-compose-content-app-1, docker-compose-control-center-1, docker-compose-postgres-1, docker-compose-proxy-1, docker-compose-share-1, docker-compose-solr6-1, docker-compose-transform-core-aio-1
     d
     ...
    

    Note that the name of each container begins with the folder name you created in step 2.

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

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

     ...
     docker-compose-alfresco-1            ... INFO ... Starting 'Transformers' subsystem, ID: [Transformers, default]
     docker-compose-alfresco-1            ... INFO ... Startup of 'Transformers' subsystem, ID: [Transformers, default] complete
     ...
    

    See Troubleshooting if you encounter errors whilst the system is starting up.

  4. Open your browser and check everything starts up correctly:

    Service Endpoint
    Administration and REST APIs http://localhost:8080/alfresco
    Control Center http://localhost:8080/admin
    Share http://localhost:8080/share
    Alfresco Content App http://localhost:8080/content-app
    Search Services administration http://localhost:8083/solr

    If Docker is running on your local machine, the IP address will be just localhost.

    If you’re still using the Docker Toolbox, you’ll need to switch to Docker Desktop as Docker Toolbox is deprecated.

    See the Alfresco Content Services - Enterprise documentation for more details about the Alfresco Control Center UI.

  5. Log in as the admin user. Enter the default administrator password admin.

Search Services administration

To access the Solr Admin UI, you need to add a header with a secret.

For Safari:

  1. Go to Develop > Show Web Inspector > Sources.
  2. Click on the + next to Local Overrides and select Local Overrides….
  3. Configure the URL using a regular expression for the Solr host and port:

    For example, http://localhost:8983/solr/*

  4. Add the X-Alfresco-Search-Secret header with the secret value.

For Chrome, FireFox, Opera, and Edge:

  1. Install the ModHeader extension.
  2. Add the X-Alfresco-Search-Secret header with the secret value, as shown in the image.

Modheader

Check system start up

Use this information to verify that the system started correctly, and to clean up the deployment.

  1. Open a new terminal window.

  2. Change directory to the docker-compose folder that you created in the deployment steps.

  3. Verify that all the services started correctly.

    1. List the images and additional details:

       docker-compose images
      

      You should see a list of the services defined in your docker-compose.yaml file:

       Container                             Repository                                       Tag                        Image Id        Size  
       ----------------------------------------------------------------------------------------------------------------------------------------
       docker-compose-activemq-1             alfresco/alfresco-activemq                       5.18-jre17-rockylinux8   8d025606b35f        686MB
       docker-compose-alfresco-1             alfresco/alfresco-content-repository-community   23.1.0                   b66ea7d42ad8        1.01GB
       docker-compose-content-app-1          alfresco/alfresco-content-app                    4.3.0                    a43e40e88c2d        87.4MB
       docker-compose-control-center-1       quay.io/alfresco/alfresco-control-center         8.3.0                    9f7f1ce0ba60        43.2MB
       docker-compose-postgres-1             postgres                                         14.4                     fb7289787ade        355MB
       docker-compose-proxy-1                alfresco/alfresco-acs-nginx                      3.4.2                    f9c4519b7920        23.4MB
       docker-compose-share-1                alfresco/alfresco-share                          23.1.1                   f4063f4d7a62        715MB
       docker-compose-solr6-1                alfresco/alfresco-search-services                2.0.8.2                  be4b827d934a        835MB
       docker-compose-transform-core-aio-1   alfresco/alfresco-transform-core-aio             5.0.1                    448b02b47f7d        1.67GB
      
    2. List the running containers:

       docker-compose ps
      

      You should see a list of the services defined in the docker-compose.yaml file.

    3. View the log files for each service <service-name>, or container <container-name>:

       docker-compose logs <service-name>
       docker container logs <container-name>
      

      For example, to check the logs for Share, run any of the following commands:

       docker-compose logs share
       docker container logs docker-compose-share-1
      

      You can add an optional parameter --tail=25 before <container-name> to display the last 25 lines of the logs for the selected container.

       docker-compose logs --tail=25 share
       docker container logs --tail=25 docker-compose-share-1
      

      Check for a success message:

       Successfully retrieved license information from Alfresco.
      

    Once you’ve tested the services, you can clean up the deployment by stopping the running services.

  4. Stop the session by using CONTROL+C in the same window as the running services:

     ^CGracefully stopping... (press Ctrl+C again to force)
     [+] Running 9/9
     ✔ Container docker-compose-transform-core-aio-1  Stopped    ...
     ✔ Container docker-compose-activemq-1            Stopped    ...
     ✔ Container docker-compose-postgres-1            Stopped    ...
     ✔ Container docker-compose-solr6-1               Stopped    ...
     ✔ Container docker-compose-proxy-1               Stopped    ...
     ✔ Container docker-compose-content-app-1         Stopped    ...
     ✔ Container docker-compose-share-1               Stopped    ...
     ✔ Container docker-compose-alfresco-1            Stopped    ...
     ✔ Container docker-compose-control-center-1      Stopped    ...
    
  5. Alternatively, you can open a new terminal window, change directory to the docker-compose folder, and run:

     docker-compose down
    

    This stops the running services, as shown in the previous example, and removes them from memory:

     ...
     ⠿ Container docker-compose-transform-core-aio-1  Removed    ...
     ✔ Container docker-compose-solr6-1               Removed    ...
     ✔ Container docker-compose-postgres-1            Removed    ...
     ✔ Container docker-compose-proxy-1               Removed    ...
     ✔ Container docker-compose-activemq-1            Removed    ...
     ✔ Container docker-compose-alfresco-1            Removed    ...
     ✔ Container docker-compose-control-center-1      Removed    ...
     ✔ Container docker-compose-share-1               Removed    ...
     ✔ Network docker-compose_default                 Removed    ...
     ...
    
  6. You can use a few more commands to explore the services when they’re running. Change directory to docker-compose before running these:

    1. Stop all the running containers:

       docker-compose stop
      
    2. Restart the containers (after using the stop command):

       docker-compose restart
      
    3. Starts the containers that were started with docker-compose up:

       docker-compose start
      
    4. Stop all running containers, and remove them and the network:

       docker-compose down --rmi all
      

      The --rmi all option also removes the images created by docker-compose up, and the images used by any service. You can use this, for example, if any containers fail and you need to remove them:

       ...
       ✔ Container docker-compose-transform-core-aio-1                  Removed        ...        0.5s
       ✔ Container docker-compose-solr6-1                               Removed        ...        10.2s
       ✔ Container docker-compose-postgres-1                            Removed        ...        0.2s
       ✔ Container docker-compose-proxy-1                               Removed        ...        10.2s
       ✔ Container docker-compose-activemq-1                            Removed        ...        2.3s
       ✔ Container docker-compose-alfresco-1                            Removed        ...        10.2s
       ✔ Container docker-compose-control-center-1                      Removed        ...        0.1s
       ✔ Container docker-compose-share-1                               Removed        ...        10.2s
       ...
       ✔ Image alfresco/alfresco-transform-core-aio:5.0.1               Removed        ...        1.9s
      
       ...
      

See the Docker documentation for more on using Docker.

Deployment project in GitHub

See the Alfresco/acs-deployment GitHub project for more details.

  • In this project, you’ll find several Docker Compose files. The default docker-compose.yml file contains the latest work-in-progress deployment scripts, and installs the latest development version of Content Services.
  • To deploy a specific released version of Content Services, several major.minor Docker Compose files are provided in the docker-compose folder of the project.
  • To modify your development environment, for example to change or mount files in the existing images, you’ll have to create new custom Docker images (recommended approach). The same approach applies if you want to install AMP files into the repository and Share images. See the Customization guidelines for more.

Using the Community Compose file in this project deploys the following system:

Docker Compose - Community

Cleanup

To bring the system down and cleanup the containers run the following command:

docker-compose down

Troubleshooting

  1. If you have issues running docker-compose up after deleting a previous Docker Compose cluster, try replacing step 2 in the initial Docker Compose instructions with:

     docker-compose down && docker-compose build --no-cache && docker-compose -f community-docker-compose.yml up
    

    Note: Make sure that the docker-compose up part of the command uses the format you chose in step 2.

  2. Stop the session by using CONTROL+C.

  3. Remove the containers (using the --rmi all option):

     docker-compose down --rmi all
    
  4. Try allocating more memory resources, as advised in docker-compose.yml.

    For example, in Docker, change the memory setting in Preferences (or Settings) Resources > Advanced > Memory to at least 13 GB. Make sure you restart Docker and wait for the process to finish before continuing.

    Go back to step 2 in the initial Docker Compose instructions to start the deployment again.

Note: You’ll need a machine with at least 13GB of memory to distribute among the Docker containers.

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 Documentation Notice.