Use this information to quickly start up Content Services using Docker Compose. Due to the limited capabilities of Docker Compose, this deployment method is recommended for development and test environments only.

To deploy Content Services 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 repository locally or download one of the docker-compose.yml files (e.g. 6.1.N-docker-compose.yml), and then change directory to the project folder:

   Code copied to clipboard.
    git clone https://github.com/Alfresco/acs-deployment.git
    cd acs-deployment
   

   Note: Make sure that the following ports are free on your computer: 5432, 8080, 8083. These ports are set in the docker-compose.yml file - refer to the host:container port definitions.

   See the Alfresco/acs-deployment project README for more information.

2. Change directory to the location of your docker-compose.yml file.

3. Log in to Quay.io using your credentials:

   Code copied to clipboard.
    docker login quay.io
   

   Alfresco customers can request Quay.io credentials by logging a ticket with Alfresco Support. These credentials are required to pull private (Enterprise-only) Docker images from Quay.io.

4. Deploy Content Services, including the repository, Share, Postgres database, Search Services, etc.:

   Code copied to clipboard.
    docker-compose -f 6.1.N-docker-compose.yml up
   

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

   Code copied to clipboard.
    ...
    Creating docker-compose_postgres_1              ... done
    Creating docker-compose_share_1 ...
    Creating docker-compose_digital-workspace_1 ...
    Creating docker-compose_sync-service_1      ...
    Creating docker-compose_solr6_1             ...
    Creating docker-compose_alfresco_1          ...
    Creating docker-compose_activemq_1          ...
    Creating docker-compose_shared-file-store_1 ...
    Creating docker-compose_proxy_1             ...
    Creating docker-compose_imagemagick_1       ...
    Creating docker-compose_alfresco-pdf-renderer_1 ...
    Creating docker-compose_libreoffice_1           ...
    Creating docker-compose_transform-router_1      ...
    Creating docker-compose_tika_1                  ...
    Attaching to docker-compose_postgres_1, docker-compose_tika_1, docker-compose_alfresco_1, docker-compose_digital-workspace_1, ...
   

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

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

   Code copied to clipboard.
    ...
    alfresco_1 | 2019-02-21 11:50:46,000  WARN ... The Alfresco Content Services license will expire in 2 days.
    alfresco_1 | 2019-02-21 11:50:50,341  INFO ... Starting 'Transformers' subsystem, ID: [Transformers, default]
    alfresco_1 | 2019-02-21 11:50:50,600  INFO ... Startup of 'Transformers' subsystem, ID: [Transformers, default] complete
    ...
   

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

6. 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	http://localhost:8083/solr

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

   If you’re using the Docker Toolbox, run the following command to find the IP address:

   Code copied to clipboard.
    docker-machine ip
   

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

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:

      Code copied to clipboard.
       docker-compose images
      

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

      Code copied to clipboard.
               Container                           Repository                            ...       Size
       --------------------------------------------------------------------------------------------------
       docker-compose_activemq_1            alfresco/alfresco-activemq                   ...   545.9 MB
       docker-compose_alfresco_1            alfresco/alfresco-content-repository         ...   1.52 GB
       docker-compose_digital-workspace_1   quay.io/alfresco/alfresco-digital-workspace  ...   33.3 MB
       docker-compose_postgres_1            postgres                                     ...   312.5 MB
       docker-compose_proxy_1               alfresco/alfresco-acs-nginx                  ...   20.42 MB
       docker-compose_share_1               alfresco/alfresco-share                      ...   785.5 MB
       docker-compose_shared-file-store_1   alfresco/alfresco-shared-file-store          ...   651.1 MB
       docker-compose_solr6_1               alfresco/alfresco-search-services            ...   1.07 GB
       docker-compose_sync-service_1        quay.io/alfresco/service-sync                ...   773.4 MB
       docker-compose_transform-router_1    quay.io/alfresco/alfresco-transform-router   ...   600.5 MB
       ...
      

   2. List the running containers:

      Code copied to clipboard.
       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>:

      Code copied to clipboard.
       docker-compose logs <service-name>
       docker container logs <container-name>
      

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

      Code copied to clipboard.
       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.

      Code copied to clipboard.
       docker-compose logs --tail=25 share
       docker container logs --tail=25 docker-compose_share_1
      

      Check for a success message:

      Code copied to clipboard.
       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:

   Code copied to clipboard.
    ^CGracefully stopping... (press Ctrl+C again to force)
    Stopping docker-compose_transform-router_1        ... done
    Stopping docker-compose_proxy_1                   ... done
    Stopping docker-compose_sync-service_1            ... done
    Stopping docker-compose_activemq_1                ... done
    Stopping docker-compose_share_1                   ... done
    Stopping docker-compose_alfresco_1                ... done
    Stopping docker-compose_digital-workspace_1       ... done
    Stopping docker-compose_postgres_1                ... done
    Stopping docker-compose_shared-file-store_1       ... done
    Stopping docker-compose_solr6_1                   ... done
    Stopping docker-compose_alfresco-pdf-renderer_1   ... done
    Stopping docker-compose_libreoffice_1             ... done
    Stopping docker-compose_tika_1                    ... done
    Stopping docker-compose_imagemagick_1             ... done
   

5. Alternatively, you can open a new terminal window, change directory to the docker-compose folder, and run:

   Code copied to clipboard.
    docker-compose down
   

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

   Code copied to clipboard.
    Stopping docker-compose_transform-router_1       ... done
    ...
    Removing docker-compose_transform-router_1       ... done
    Removing docker-compose_proxy_1                  ... done
    Removing docker-compose_sync-service_1           ... done
    Removing docker-compose_alfresco-pdf-renderer_1  ... done
    Removing docker-compose_shared-file-store_1      ... done
    Removing docker-compose_postgres_1               ... done
    Removing docker-compose_activemq_1               ... done
    Removing docker-compose_share_1                  ... done
    Removing docker-compose_solr6_1                  ... done
    Removing docker-compose_imagemagick_1            ... done
    Removing docker-compose_libreoffice_1            ... done
    Removing docker-compose_tika_1                   ... done
    Removing docker-compose_alfresco_1               ... done
    Removing docker-compose_digital-workspace_1      ... done
    Removing network docker-compose_default
   

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:

      Code copied to clipboard.
       docker-compose stop
      

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

      Code copied to clipboard.
       docker-compose restart
      

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

      Code copied to clipboard.
       docker-compose start
      

   4. Stop all running containers, and remove them and the network:

      Code copied to clipboard.
       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:

      Code copied to clipboard.
       Stopping docker-compose_transform-router_1 ... done
       ...
       Removing docker-compose_transform-router_1 ... done
       ...
       Removing network docker-compose_default
       Removing image alfresco/alfresco-content-repository:6.1.1
       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.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 one of the Enterprise Compose files in this project deploys the following system:

Configure

The Docker Compose file provides some default configuration. This section lists the full set of environment variables exposed by each of the containers in the deployment.

Alfresco Content Repository (alfresco)

Alfresco Share (share)

Alfresco Digital Workspace (digital-workspace)

Alfresco Search Services (solr6)

Alfresco Transform Router (transform-router)

Alfresco Transform Core AIO (transform-core-aio)

Alfresco Shared File Store (shared-file-store)

Alfresco Sync Service (sync-service)

Alfresco Proxy (proxy)

Customize

To customize the Docker Compose deployment, for example applying AMPs, we recommend following the best practice of creating your own custom Docker image(s). The Customization guidelines walks you through this process.

Cleanup

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

Code copied to clipboard.
docker-compose down

Troubleshooting

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

   Code copied to clipboard.
    docker-compose down && docker-compose build --no-cache && docker-compose up
   

2. Stop the session by using CONTROL+C.

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

   Code copied to clipboard.
    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 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: You’ll need a machine with at least 13GB of memory to distribute among the Docker containers.

Reference

The table below shows the location of the Dockerfile for each container used in this deployment.