Movatterモバイル変換

[0]ホーム
URL:

In: content-servicesIn: All docs
Close
Alfresco Content Services

Install using Docker Compose

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 installDocker, then follow the steps below. Make sure that you’ve reviewed theprerequisites before continuing.

  1. Download thedocker-compose.yml file by accessing the Content ServicesDownload Trial page, which will give you a 30-day license.

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

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

  2. Save thedocker-compose.yml file in a local folder.

    For example, you can create a folderacs-trial.

  3. Change directory to the location of yourdocker-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 withAlfresco 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 acs-trial_shared-file-store_1 ... done Creating acs-trial_share_1             ... done Creating acs-trial_alfresco_1          ... done Creating acs-trial_digital-workspace_1 ... done Creating acs-trial_postgres_1          ... done Creating acs-trial_proxy_1             ... Creating acs-trial_sync-service_1      ... done Creating acs-trial_solr6_1             ... done Creating acs-trial_activemq_1          ... done Creating acs-trial_transform-core-aio_1 ... Creating acs-trial_transform-router_1   ... Creating acs-trial_proxy_1              ... done Creating acs-trial_transform-core-aio_1 ... done Creating acs-trial_transform-router_1   ... done Attaching to acs-trial_shared-file-store_1, acs-trial_share_1, acs-trial_alfresco_1, acs-trial_digital-workspace_1, acs-trial_postgres_1, acs-trial_sync-service_1, acs-trial_solr6_1, acs-trial_activemq_1, acs-trial_proxy_1, acs-trial_transform-core-aio_1, acs-trial_transform-router_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 runningdocker-compose up -d.

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

     ... alfresco_1 | 2021-03-18 15:44:21,010  INFO  ... Starting 'Transformers' subsystem, ID: [Transformers, default] alfresco_1 | 2021-03-18 15:44:21,294  INFO  ... Startup of 'Transformers' subsystem, ID: [Transformers, default] complete ...

    SeeTroubleshooting if you encounter errors whilst the system is starting up.

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

    ServiceEndpoint
    Administration and REST APIshttp://localhost:8080/alfresco
    Sharehttp://localhost:8080/share
    Digital Workspacehttp://localhost:8080/workspace
    Search Services administrationhttp://localhost:8083/solr
    Sync Service health checkhttp://localhost:9090/alfresco/healthcheck

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

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

     docker-machine ip

  8. Log in as theadmin user. Enter the default administrator passwordadmin.

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 thedocker-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 yourdocker-compose.yaml file:

               Container                           Repository                          ...     Size ---------------------------------------------------------------------------------------------- acs-trial_activemq_1             alfresco/alfresco-activemq                     ...   716.3 MB acs-trial_alfresco_1             quay.io/alfresco/alfresco-content-repository   ...   1.484 GB acs-trial_digital-workspace_1    quay.io/alfresco/alfresco-digital-workspace    ...   35.96 MB acs-trial_postgres_1             postgres                                       ...   314.2 MB acs-trial_proxy_1                alfresco/alfresco-acs-nginx                    ...   21.86 MB acs-trial_share_1                quay.io/alfresco/alfresco-share                ...   743.2 MB acs-trial_shared-file-store_1    quay.io/alfresco/alfresco-shared-file-store    ...   658.2 MB acs-trial_solr6_1                alfresco/alfresco-search-services              ...   1.148 GB acs-trial_sync-service_1         quay.io/alfresco/service-sync                  ...   800 MB acs-trial_transform-core-aio_1   alfresco/alfresco-transform-core-aio           ...   1.579 GB acs-trial_transform-router_1     quay.io/alfresco/alfresco-transform-router     ...   611.4 MB

    2. List the running containers:

       docker-compose ps

      You should see a list of the services defined in thedocker-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 acs-trial_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 acs-trial_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 usingCONTROL+C in the same window as the running services:

     ^CGracefully stopping... (press Ctrl+C again to force) Stopping acs-trial_transform-core-aio_1 ... done Stopping acs-trial_transform-router_1   ... done Stopping acs-trial_proxy_1              ... done Stopping acs-trial_shared-file-store_1  ... done Stopping acs-trial_alfresco_1           ... done Stopping acs-trial_solr6_1              ... done Stopping acs-trial_share_1              ... done Stopping acs-trial_digital-workspace_1  ... done Stopping acs-trial_activemq_1           ... done Stopping acs-trial_postgres_1           ... done Stopping acs-trial_sync-service_1       ... done

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

     docker-compose down

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

     Stopping acs-trial_transform-core-aio_1 ... done Stopping acs-trial_transform-router_1   ... done ... Removing acs-trial_transform-core-aio_1 ... done Removing acs-trial_transform-router_1   ... done Removing acs-trial_proxy_1              ... done Removing acs-trial_shared-file-store_1  ... done Removing acs-trial_alfresco_1           ... done Removing acs-trial_solr6_1              ... done Removing acs-trial_share_1              ... done Removing acs-trial_digital-workspace_1  ... done Removing acs-trial_activemq_1           ... done Removing acs-trial_postgres_1           ... done Removing acs-trial_sync-service_1       ... done Removing network acs-trial_default

  6. You can use a few more commands to explore the services when they’re running. Change directory todocker-compose before running these:

    1. Stop all the running containers:

       docker-compose stop

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

       docker-compose restart

    3. Starts the containers that were started withdocker-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 bydocker-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 acs-trial_transform-core-aio_1 ... done ... Removing acs-trial_transform-core-aio_1 ... done ... Removing network acs-trial_default Removing image alfresco/alfresco-content-repository:7.0.0 Removing image ...

See theDocker documentation for more on using Docker.

Deployment project in GitHub

See theAlfresco/acs-deployment GitHub project for more details.

  • In this project, you’ll find several Docker Compose files. The defaultdocker-compose.yml file contains the latest work-in-progress deployment scripts, and installs the latestdevelopment version of Content Services.
  • To deploy a specific released version of Content Services, severalmajor.minor Docker Compose files are provided in thedocker-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 theCustomization guidelines for more.

Using one of the Enterprise Compose files in this project deploys the following system:

Docker Compose - Enterprise

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)

PropertyDescription
JAVA_TOOL_OPTIONSAdding this environment variable, allows to set sensitive values (like passwords) that are not passed as arguments to the Java Process.
JAVA_OPTSA set of properties that are picked up by the JVM inside the container. Any Content Services property can be passed to the container using the format-Dproperty=value (e.g.-Ddb.driver=org.postgresql.Driver).

Note: If you are using Alfresco Transform Service 1.4 or newer, and you want to do IPTC metadata extraction,then you need tobootstrap the IPTC Content Model manuallyinto Content Services.

Alfresco Share (share)

PropertyDescription
JAVA_OPTSA set of properties that are picked up by the JVM inside the container
REPO_HOSTShare needs to know how to register itself with Alfresco. The default value islocalhost
REPO_PORTShare needs to know how to register itself with Alfresco. The default value is8080
CSRF_FILTER_REFERERCSRF Referrer
CSRF_FILTER_ORIGINCSRF Origin

Alfresco Digital Workspace (digital-workspace)

PropertyDescription
BASE_PATHThe default value is./
APP_CONFIG_OAUTH2_HOSTThe address of the Identity Service including the realm name configured
APP_CONFIG_AUTH_TYPEThe authentication type. To use Single Sign-on mode you must change this property to OAUTH. The default value isBASIC
APP_CONFIG_OAUTH2_CLIENTIDThe name of the client configured for Digital Workspace
APP_CONFIG_OAUTH2_REDIRECT_SILENT_IFRAME_URIThe address that Digital Workspace uses to refresh authorization tokens
APP_CONFIG_OAUTH2_REDIRECT_LOGINThe URL to redirect to after a user is successfully authenticated
APP_CONFIG_OAUTH2_REDIRECT_LOGOUTThe URL to redirect to after a user successfully signs out
APP_BASE_SHARE_URLBase Share URL. For example{protocol}//{hostname}{:port}/workspace/#/preview/s
AUTH_TYPEThe authentication type. To use Single Sign-on mode you must change this property to OAUTH. The default value isBASIC
PROVIDERThe default value isALL
ENVIRONMENT_SUFFIXOnly for Process Cloud instance. The default value is_CLOUD
API_HOST 
API_CONTENT_HOST 
API_CONTENT_HOST_LOCALThe default value ishttp://localhost:8080
API_PROCESS_HOST 
OAUTH_HOST 
IDENTITY_HOSTThe address of the Identity Service including the realm name configured.
E2E_HOSTThe default value ishttp://localhost
E2E_PORTThe default value is80
API_HOST_CLOUD 
API_CONTENT_HOST_CLOUD 
API_PROCESS_HOST_CLOUD 
OAUTH_HOST_CLOUD 
IDENTITY_HOST_CLOUD 
E2E_HOST_CLOUDThe default value ishttp://localhost
E2E_PORT_CLOUDThe default value is4200
APP_CONFIG_APPS_DEPLOYEDThe name of the deployed application (e.g."[{"name": "<the name of the deployed application>"}]")

Alfresco Search Services (solr6)

PropertyDescription
SOLR_ALFRESCO_HOSTSolr needs to know how to register itself with Alfresco. The default value isalfresco
SOLR_ALFRESCO_PORTSolr needs to know how to register itself with Alfresco. The default value is8080
SOLR_SOLR_HOSTAlfresco needs to know how to call solr. The default value issolr6
SOLR_SOLR_PORTAlfresco needs to know how to call solr. The default value is8983
SOLR_CREATE_ALFRESCO_DEFAULTSCreate the default alfresco and archive cores. The default value isalfresco,archive
SOLR_OPTSOptions to pass when starting the Java process
SOLR_HEAPThe Java heap assigned to Solr. The default value is2g
SOLR_JAVA_MEMThe exact memory settings for Solr. Note that SOLR_HEAP takes precedence over this. The default value is-Xms2g -Xmx2g
MAX_SOLR_RAM_PERCENTAGEThe percentage of available memory (an integer value) to assign to Solr. Note that SOLR_HEAP and SOLR_JAVA_MEM take precedence over this. The default value is2
SEARCH_LOG_LEVELThe root logger level (ERROR,WARN,INFO,DEBUG orTRACE). The default value isINFO
ENABLE_SPELLCHECKWhether spellchecking is enabled or not (true orfalse)
DISABLE_CASCADE_TRACKINGWhether cascade tracking is enabled or not (true orfalse). Disabling cascade tracking will improve performance, but result in some feature loss (e.g. path queries)
ALFRESCO_SECURE_COMMSWhether communication with the repository is secured (https ornone). SeeAlfresco Search Services implementation for more details. The default value isnone
SOLR_SSL_KEY_STOREPath to SSL key store. SeeAlfresco Search Services Docker Compose steps for more details
SOLR_SSL_KEY_STORE_PASSWORDPassword for key store. SeeAlfresco Search Services Docker Compose steps for more details
SOLR_SSL_KEY_STORE_TYPEKey store type. SeeAlfresco Search Services Docker Compose steps for more details. The default value isJCEKS
SOLR_SSL_TRUST_STOREPath to SSL trust store. SeeAlfresco Search Services Docker Compose steps for more details
SOLR_SSL_TRUST_STORE_PASSWORDPassword for trust store. SeeAlfresco Search Services Docker Compose steps for more details
SOLR_SSL_TRUST_STORE_TYPETrust store type. SeeAlfresco Search Services Docker Compose steps for more details. The default value isJCEKS
SOLR_SSL_NEED_CLIENT_AUTHThis variable is used to configure SSL (true orfalse). SeeAlfresco Search Services Docker Compose steps for more details
SOLR_SSL_WANT_CLIENT_AUTHThis variable is used to configure SSL (true orfalse). SeeAlfresco Search Services Docker Compose steps for more details

Alfresco Transform Router (transform-router)

PropertyDescription
JAVA_OPTSA set of properties that are picked up by the JVM inside the container
ACTIVEMQ_URLActiveMQ URL (in this case, the name of the container is used). The default value isnio://activemq:61616
ACTIVEMQ_USERActiveMQ user. The default value isadmin
ACTIVEMQ_PASSWORDActiveMQ password. The default value isadmin
TRANSFORM_REQUEST_QUEUEThe default value isorg.alfresco.transform.t-request.acs
TRANSFORM_REPLY_QUEUEThe default value isorg.alfresco.transform.t-reply.acs
TRANSFORM_ENGINE_REPLY_QUEUEThe default value isorg.alfresco.transform.engine.t-reply.acs
JMS_LISTENER_CONCURRENCYThe default value is1-10
IMAGEMAGICK_URLURL for the ImageMagick T-Engine
PDF_RENDERER_URLURL for the PDF Renderer T-Engine
LIBREOFFICE_URLURL for the LibreOffice T-Engine
TIKA_URLURL for the Tika T-Engine
MISC_URLURL for the Miscellaneous T-Engine
CORE_AIO_URLURL for the All-In-One T-Engine
FILE_STORE_URLURL for the Shared File Store
IMAGEMAGICK_QUEUEName of the queue used by the ImageMagick T-Engine. The default value isorg.alfresco.transform.engine.imagemagick.acs
PDF_RENDERER_QUEUEName of the queue used by the PDF Renderer T-Engine. The default value isorg.alfresco.transform.engine.alfresco-pdf-renderer.acs
LIBREOFFICE_QUEUEName of the queue used by the LibreOffice T-Engine. The default value isorg.alfresco.transform.engine.libreoffice.acs
TIKA_QUEUEName of the queue used by the Tika T-Engine. The default value isorg.alfresco.transform.engine.tika.acs
MISC_QUEUEName of the queue used by the Miscellaneous T-Engine. The default value isorg.alfresco.transform.engine.misc.acs
CORE_AIO_QUEUEName of the queue used by the All-In-One Core T-Engine. The default value isorg.alfresco.transform.engine.aio.acs
TRANSFORMER_ENGINE_PROTOCOLThis value can be one of the following (http, jms). The default value isjms
TRANSFORMER_ROUTES_FILE_LOCATIONThe default value istransformer-pipelines.json
MAX_TRANSFORM_RETRIESThe default value is3
INITIAL_RETRY_TIMEOUTThe default value is10000
INCREASE_RETRY_TIMEOUTThe default value is10000
MAX_IN_MEMORY_SIZEDouble default limit to 512KiB. The default value is524288
HOSTNAMEThe default value ist-router

Alfresco Transform Core AIO (transform-core-aio)

PropertyDescription
JAVA_OPTSA set of properties that are picked up by the JVM inside the container
ACTIVEMQ_URLActiveMQ URL (in this case, the name of the container is used)
FILE_STORE_URLShared file store URL (in this case, the name of the container is used)
TRANSFORM_ENGINE_REQUEST_QUEUEName of the queue. The default value isorg.alfresco.transform.engine.aio.acs
PDFRENDERER_EXELocation of the PDF Renderer binary. The default value is/usr/bin/alfresco-pdf-renderer
LIBREOFFICE_HOMELocation of the LibreOffice installation. The default value is/opt/libreoffice6.3
IMAGEMAGICK_ROOTLocation of the ImageMagick installation. The default value is/usr/lib64/ImageMagick-7.0.10
IMAGEMAGICK_DYNLocation of the ImageMagick dynamic libraries. The default value is/usr/lib64/ImageMagick-7.0.10/lib
IMAGEMAGICK_EXELocation of the ImageMagick binary. The default value is/usr/bin/convert
IMAGEMAGICK_CODERSLocation of the ImageMagick coders folder
IMAGEMAGICK_CONFIGLocation of the ImageMagick configuration folder

Alfresco Shared File Store (shared-file-store)

PropertyDescription
JAVA_OPTSA set of properties that are picked up by the JVM inside the container
fileStorePathShared File Store content storing path. The default value is/tmp/Alfresco
scheduler.contract.pathCleanup Scheduler contract path. The default value is/tmp/scheduler.json
scheduler.content.age.millisContent retention period. The default value is86400000
scheduler.cleanup.intervalCleanup Scheduler interval. The default value is86400000

Alfresco Sync Service (sync-service)

PropertyDescription
JAVA_OPTSA set of properties that are picked up by the JVM inside the container. Any Sync Service property can be passed to the container using the following format-Dproperty=value (e.g.-Dsql.db.username=alfresco).

For a complete list of properties that can be passed throughJAVA_OPTS environment variable, check Alfresco Sync Serviceconfiguration

Alfresco Proxy (proxy)

PropertyDescription
ADW_URLDigital Workspace URL inside network. The default value ishttp://digital-workspace
REPO_URLRepository URL inside network. The default value ishttp://alfresco:8080
SHARE_URLShare URL inside network. The default value ishttp://share:8080
SYNCSERVICE_URLSync service URL inside network. The default value ishttp://sync-service:9090
ACCESS_LOGSets theaccess_log value. Set tooff to switch off logging

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). TheCustomization guidelines walks you through this process.

Cleanup

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

docker-compose down

Troubleshooting

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

     docker-compose down && docker-compose build --no-cache && docker-compose up

  2. Stop the session by usingCONTROL+C.

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

     docker-compose down --rmi all

  4. Try allocating more memory resources, as advised indocker-compose.yml.

    For example, in Docker, change the memory setting inPreferences (orSettings)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 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.

Reference

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

ContainerDockerfile location
alfrescohttps://github.com/Alfresco/acs-packaging/blob/master/docker-alfresco/Dockerfile
sharehttps://github.com/Alfresco/share/blob/master/packaging/docker/Dockerfile
solr6https://github.com/Alfresco/InsightEngine/blob/master/search-services/packaging/src/docker/Dockerfile
digital-workspacehttps://github.com/Alfresco/alfresco-digital-workspace-app/blob/develop/Dockerfile
activemqhttps://github.com/Alfresco/alfresco-docker-activemq/blob/master/Dockerfile
sync-servicehttps://github.com/Alfresco/dsync-services/blob/master/service-sync/packaging/docker/Dockerfile
transform-routerhttps://github.com/Alfresco/alfresco-transform-service/blob/master/alfresco-transform-router/src/main/docker/Dockerfile
transform-core-aiohttps://github.com/Alfresco/alfresco-transform-core/blob/master/alfresco-transform-core-aio/alfresco-transform-core-aio-boot/Dockerfile
shared-file-storehttps://github.com/Alfresco/alfresco-shared-file-store/blob/master/controller/Dockerfile
proxyhttps://github.com/Alfresco/acs-ingress/blob/master/Dockerfile

Edit this page

Suggest an edit on GitHub
By clicking "Accept Cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts.View Cookie Policy.
[8]ページ先頭
©2009-2025 Movatter.jp