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 here 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.
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
Note: Make sure that exposed ports are open on your host computer. Check the
docker-compose.ymlfile to determine the exposed ports - refer to the
host:containerport definitions. You’ll see they include 5432, 8080, 8083 and others.
docker-compose.ymlfile in a local folder.
For example, you can create a folder
Change directory to the location of your
Deploy Community Edition, including the repository, Share, Postgres database, Search Services, etc.:
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_share_1 ... Creating docker-compose_solr6_1 ... Creating docker-compose_alfresco_1 ... Creating docker-compose_postgres_1 ... Creating docker-compose_transform-core-aio_1 ... Creating docker-compose_activemq_1 ... Creating docker-compose_alfresco_1 ... done Creating docker-compose_share_1 ... done Creating docker-compose_proxy_1 ... Creating docker-compose_postgres_1 ... done Creating docker-compose_solr6_1 ... done Creating docker-compose_transform-core-aio_1 ... done Creating docker-compose_activemq_1 ... done Creating docker-compose_proxy_1 ... done Attaching to docker-compose_alfresco_1, docker-compose_share_1, docker-compose_postgres_1, docker-compose_solr6_1, docker-compose_transform-core-aio_1, docker-compose_activemq_1, docker-compose_proxy_1 ...
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.
Wait for the logs to complete, showing messages:
... alfresco_1 | 2021-03-18 15:57:50,740 INFO ... Starting 'Transformers' subsystem, ID: [Transformers, default] alfresco_1 | 2021-03-18 15:57:50,935 INFO ... Startup of 'Transformers' subsystem, ID: [Transformers, default] complete ...
See Troubleshooting if you encounter errors whilst the system is starting up.
Open your browser and check everything starts up correctly:
Service Endpoint Administration and REST APIs
Search Services administration
If Docker is running on your local machine, the IP address will be just
If you’re using the Docker Toolbox, run the following command to find the IP address:
Log in as the
adminuser. Enter the default administrator password
Check system start up
Use this information to verify that the system started correctly, and to clean up the deployment.
Open a new terminal window.
Change directory to the
docker-composefolder that you created in the deployment steps.
Verify that all the services started correctly.
List the images and additional details:
You should see a list of the services defined in your
Container Repository ... Size ----------------------------------------------------------------------------------------------------- docker-compose_activemq_1 alfresco/alfresco-activemq ... 716.3 MB docker-compose_alfresco_1 alfresco/alfresco-content-repository-community ... 1.272 GB docker-compose_postgres_1 postgres ... 314.2 MB docker-compose_proxy_1 alfresco/alfresco-acs-nginx ... 21.86 MB docker-compose_share_1 alfresco/alfresco-share ... 743.2 MB docker-compose_solr6_1 alfresco/alfresco-search-services ... 1.148 GB docker-compose_transform-core-aio_1 alfresco/alfresco-transform-core-aio ... 1.579 GB
List the running containers:
You should see a list of the services defined in the
View the log files for each service
<service-name>, or container
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
<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.
Stop the session by using
CONTROL+Cin the same window as the running services:
^CGracefully stopping... (press Ctrl+C again to force) Stopping docker-compose_proxy_1 ... done Stopping docker-compose_alfresco_1 ... done Stopping docker-compose_share_1 ... done Stopping docker-compose_solr6_1 ... done Stopping docker-compose_transform-core-aio_1 ... done Stopping docker-compose_postgres_1 ... done Stopping docker-compose_activemq_1 ... done
Alternatively, you can open a new terminal window, change directory to the
docker-composefolder, and run:
This stops the running services, as shown in the previous example, and removes them from memory:
Stopping docker-compose_proxy_1 ... done Stopping docker-compose_alfresco_1 ... done ... Removing docker-compose_proxy_1 ... done Removing docker-compose_alfresco_1 ... done Removing docker-compose_share_1 ... done Removing docker-compose_solr6_1 ... done Removing docker-compose_transform-core-aio_1 ... done Removing docker-compose_postgres_1 ... done Removing docker-compose_activemq_1 ... done Removing network docker-compose_default
You can use a few more commands to explore the services when they’re running. Change directory to
docker-composebefore running these:
Stop all the running containers:
Restart the containers (after using the
Starts the containers that were started with
Stop all running containers, and remove them and the network:
docker-compose down [--rmi all]
--rmi alloption 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:
Stopping docker-compose_proxy_1 ... Removing docker-compose_proxy_1 ... Removing network docker-compose_default Removing image alfresco/alfresco-content-repository-community:7.0.0 Removing image ...
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.ymlfile 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-composefolder 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:
To bring the system down and cleanup the containers run the following command:
If you have issues running
docker-compose upafter deleting a previous Docker Compose cluster, try replacing step 4 in the initial Docker Compose instructions with:
docker-compose down && docker-compose build --no-cache && docker-compose up
Note: Make sure that the
docker-compose uppart of the command uses the format you chose in step 4.
Stop the session by using
Remove the containers (using the
docker-compose down --rmi all
Try allocating more memory resources, as advised in
For example, in Docker, change the memory setting in Preferences (or Settings) Resources > Advanced > Memory to at least 8GB. Make sure you restart Docker and wait for the process to finish before continuing.
Go back to step 4 in the initial Docker Compose instructions to start the deployment again.
Note: Keep in mind that 8GB is much lower than the required minimum, and may need to be adapted for your environment. You’ll need a machine with at least 13GB of memory to distribute among the Docker containers.