Use this information to quickly start up Content Services (including Transform Service) using Docker Compose. Due to the limited capabilities of Docker Compose, this deployment method is only recommended for development and test environments.
To check which branch tag corresponds to a specific Content Services release, review the released versions in GitHub. Choose a version from the left column that corresponds to the required Content Services version you want to deploy.
!!! Note Check the prerequisites for your operating system, both for Docker and Docker Compose, using the links provided.
- Clone the project locally, and then change directory to the project folder:
bash
git clone --branch x.y.z https://github.com/Alfresco/acs-deployment.git
cd acs-deployment/docker-compose
!!! Note
Replace the version number `x.y.z` with the tag that matches the Content Services version you want to
> deploy. For example, if you want Content Services 7.2.0, then select tag `v5.2.0`.
!!! 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.
-
Log in to Quay.io using your credentials:
docker login https://quay.ioYou'll need your Quay.io account credentials to access the Docker images. If you don't already have these credentials, contact Alfresco Support.
-
(OPTIONAL) Make sure the Docker Compose file use the following versions of Transform Router, Transform Core AIO T-Engine, and Shared file store:
transform-router:
mem_limit: 512m
image: quay.io/alfresco/alfresco-transform-router:1.5.3
environment:
JAVA_OPTS: " -XX:MinRAMPercentage=50 -XX:MaxRAMPercentage=80"
ACTIVEMQ_URL: "nio://activemq:61616"
CORE_AIO_URL: "http://transform-core-aio:8090"
FILE_STORE_URL: "http://shared-file-store:8099/alfresco/api/-default-/private/sfs/versions/1/file"
ports:
- "8095:8095"
links:
- activemq
transform-core-aio:
image: alfresco/alfresco-transform-core-aio:2.6.0
mem_limit: 1536m
environment:
JAVA_OPTS: " -XX:MinRAMPercentage=50 -XX:MaxRAMPercentage=80"
ACTIVEMQ_URL: "nio://activemq:61616"
FILE_STORE_URL: "http://shared-file-store:8099/alfresco/api/-default-/private/sfs/versions/1/file"
ports:
- "8090:8090"
links:
- activemq
shared-file-store:
image: quay.io/alfresco/alfresco-shared-file-store:1.5.3
mem_limit: 512m
environment:
JAVA_OPTS: " -XX:MinRAMPercentage=50 -XX:MaxRAMPercentage=80"
scheduler.content.age.millis: 86400000
scheduler.cleanup.interval: 86400000
ports:
- "8099:8099"
volumes:
- shared-file-store-volume:/tmp/Alfresco/sfs
-
Deploy Content Services, including the repository, Share, Postgres database, Search Services, and Transform Service:
docker-compose upThis 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_digital-workspace_1 ... done Creating docker-compose_solr6_1 ... done Creating docker-compose_shared-file-store_1 ... done Creating docker-compose_sync-service_1 ... done Creating docker-compose_alfresco_1 ... done Creating docker-compose_share_1 ... done Creating docker-compose_postgres_1 ... done Creating docker-compose_activemq_1 ... done Creating docker-compose_proxy_1 ... done Creating docker-compose_transform-router_1 ... done Creating docker-compose_transform-core-aio_1 ... done Attaching to docker-compose_digital-workspace_1, docker-compose_shared-file-store_1, docker-compose_alfresco_1,As an alternative, you can also start the containers in the background by running
docker-compose up -d. -
Wait for the logs to show messages:
alfresco_1 | 2022-06-02 11:50:46,808 WARN ... The Alfresco Content Services license will expire in 2 days. alfresco_1 | 2022-06-02 11:50:50,938 INFO ... Starting 'Transformers' subsystem, ID: [Transformers, default] alfresco_1 | 2022-06-02 11:50:50,371 INFO ... Startup of 'Transformers' subsystem, ID: [Transformers, default] completeIf you encounter errors whilst the system is starting up:
- Stop the session (by using
CONTROL+C). - Remove the container using
--rmi all. This 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. - 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 8GB. Make sure you restart Docker and wait for the process to finish before continuing. - Go back to step 5 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.
- Stop the session (by using
-
Open your browser and check everything starts up correctly:
| Service | Endpoint |
| Administration and REST APIs | http://localhost:8080/alfresco |
| Share | http://localhost:8080/share |
| Digital Workspace | http://localhost:8080/workspace |
| Search Services administration (see this page for info on how to login) | http://localhost:8083/solr |
| Transform Router configuration | http://localhost:8095/transform/config |
| ActiveMQ Admin Web Console | http://localhost:8161/admin |
- Log in as the
adminuser. Enter the default administrator passwordadmin.
You can use a number of commands to check that the system started correctly, see below.
See the Alfresco/acs-deployment GitHub project documentation for the prerequisites and detailed setup.