Install using Docker Compose - Alfresco Content Services - 23.4 - 23.4 - Ready - Alfresco - external

Alfresco Content Services

Platform
Alfresco
Product
Alfresco Content Services
Release
23.4
License

Use this information to quickly start up Content Services 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 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. Download the docker-compose.yml file by accessing the Content Services Download Trial page, which will give you a 30-day license.

    If you already have a valid license file for Content Services, you can apply it directly to the running system. See Upload new license for more details.

    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.
    Note:

    The Download Trial is usually updated to the most recent version of Content Services. The latest published version on our website is labelled Version 23.1.1 - November 2023.

  2. Save the docker-compose.yml file in a local folder. For example, you can create a folder acs_trial.
  3. Change directory to the location of your docker-compose.yml file.
  4. Log in to Quay.io using your credentials:
     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.

  5. Deploy Content Services, 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 network "acs_trial_default" with the default driver
     Creating volume "acs_trial_shared-file-store-volume" with default driver
     Creating acs_trial_control-center_1     ... done
     Creating acs_trial_activemq_1           ... done
     Creating acs_trial_sync-service_1       ... done
     Creating acs_trial_solr6_1              ... done
     Creating acs_trial_digital-workspace_1  ... done
     Creating acs_trial_share_1              ... done
     Creating acs_trial_postgres_1           ... done
     Creating acs_trial_alfresco_1           ... done
     Creating acs_trial_shared-file-store_1  ... done
     Creating acs_trial_proxy_1              ... done
     Creating acs_trial_transform-router_1   ... done
     Creating acs_trial_transform-core-aio_1 ... done
     Attaching to acs_trial_postgres_1, acs_trial_control-center_1, acs_trial_sync-service_1, acs_trial_share_1, acs_trial_digital-workspace_1, acs_trial_alfresco_1, acs_trial_solr6_1,    acs_trial_activemq_1, acs_trial_shared-file-store_1, acs_trial_proxy_1, acs_trial_transform-router_1, acs_trial_transform-core-aio_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.

  6. Wait for the logs to complete, showing messages:
     ...
     alfresco_1 | ...  INFO  ... Starting 'Transformers' subsystem, ID: [Transformers, default]
     alfresco_1 | ...  INFO  ... Startup of 'Transformers' subsystem, ID: [Transformers, default] complete
     ...
    

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

  7. Open your browser and check everything starts up correctly:
    Service Endpoint
    Administration and REST APIs http://localhost:8080/alfresco
    Digital Workspace http://localhost:8080/workspace
    Share http://localhost:8080/share
    Search Services administration http://localhost:8083/solr
    Sync Service health check http://localhost:9090/alfresco/healthcheck
    Admin Console http://localhost:8080/alfresco/s/enterprise/admin

    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.

    For more information on Search Services administration, see Search Services administration.

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