Advanced Search

Deployment Manual / Version 2101

Table Of Contents

Deployment Manual

Copyright CoreMedia GmbH © 2021

CoreMedia GmbH

Ludwig-Erhard-Straße 18

20459 Hamburg

International

All rights reserved. No part of this manual or the corresponding program may be reproduced or copied in any form (print, photocopy or other process) without the written permission of CoreMedia GmbH.

Germany

Alle Rechte vorbehalten. CoreMedia und weitere im Text erwähnte CoreMedia Produkte sowie die entsprechenden Logos sind Marken oder eingetragene Marken der CoreMedia GmbH in Deutschland. Alle anderen Namen von Produkten sind Marken der jeweiligen Firmen.

Das Handbuch bzw. Teile hiervon sowie die dazugehörigen Programme dürfen in keiner Weise (Druck, Fotokopie oder sonstige Verfahren) ohne schriftliche Genehmigung der CoreMedia GmbH reproduziert oder vervielfältigt werden. Unberührt hiervon bleiben die gesetzlich erlaubten Nutzungsarten nach dem UrhG.

Licenses and Trademarks

All trademarks acknowledged.

June 09, 2021

1.1. Audience

1.2. Typographic Conventions

1.3. CoreMedia Services

1.3.1. Registration
1.3.2. CoreMedia Releases
1.3.3. Documentation
1.3.4. CoreMedia Training
1.3.5. CoreMedia Support

1.4. Changelog

2. Deployment Archive

2.1. Quickstart

2.2. Deployment Archive Structure

2.3. Building the Deployment Archive

2.4. Configuring the Deployment Archive

2.5. Running the deployment script

2.6. Validating the Installation

2.7. Customize the Deployment Archive

2.8. Deployment Archive Reference

2.8.1. Service and Logfile Names
2.8.2. Installation Paths
2.8.3. Port Conventions

2.9. Deployment Archive Migration Relevant Changes

3. Docker Setup

3.1. Docker Images Build Process

3.1.1. The Maven Structure
3.1.2. The java-application-base Image

3.2. Docker Container Startup

3.2.1. Startup Entrypoint and Command chain
3.2.2. Health Check

3.3. Container Configuration

3.3.1. Build Time Configuration
3.3.2. Start Time Configuration
3.3.3. Runtime Configuration

3.4. Containerized Tools

3.4.1. Running the Tools
3.4.2. Configuring the Tools
3.4.3. Examples with confd rendered configuration
3.4.4. Examples with mounted configuration

4. CoreMedia Properties Overview

4.1. Content Application Engine Properties

4.1.1. General CAE Properties
4.1.2. Delivery CAE Properties
4.1.3. Http Cache Control Properties
4.1.4. CORS Properties
4.1.5. Blob Transformation properties
4.1.6. Renamed CAE Properties

4.2. Content Server Properties

4.2.1. General Content Server Properties
4.2.2. CORBA Properties
4.2.3. Properties for the Publisher
4.2.4. Properties for the Connection to the Database
4.2.5. Properties for Replicator Configuration
4.2.6. Properties for Timezone and IOR
4.2.7. Renamed Properties

4.3. Headless Server Properties

4.3.1. Headless Server Spring Boot Properties
4.3.2. Persisted Query Properties
4.3.3. Remote Service Adapter Properties
4.3.4. Properties of External Frameworks
4.3.5. Renamed Properties

4.4. Workflow Server Properties

4.5. Studio Properties

4.5.1. Studio Configuration
4.5.2. Preview URL Service Properties
4.5.3. Content Security Policy Configuration
4.5.4. Content Hub Configuration
4.5.5. Feedback Hub Configuration
4.5.6. Editorial Comments Configuration

4.6. Commerce Hub Properties

4.7. Elastic Social Properties

4.7.1. General Elastic Social Properties
4.7.2. MongoDB Properties
4.7.3. Counter Properties
4.7.4. Task Queue Properties
4.7.5. Elastic Social Solr Properties
4.7.6. Renamed Properties

4.8. Importer Properties

4.9. Search Related Properties

4.9.1. Content Feeder Properties
4.9.2. CAE Feeder Properties

4.10. UAPI Client Properties

4.10.1. Unified API Spring Boot Client Properties
4.10.2. Renamed Properties

4.11. Cache Properties

4.12. Image Transformation Properties

List of Figures

2.1. Attribute Structure
2.2. CMS Deployment Ports

List of Tables

1.1. Typographic conventions
1.2. Pictographs
1.3. CoreMedia manuals
1.4. Changes
2.1. Service Names
2.2. Service Installation Paths
2.3. Tools Installation Paths
2.4. Component Port Prefix
2.5. Protocol / Service Port Suffix
2.6. Third-Party Services
4.1. Configuration Properties with Prefix cae
4.2. Delivery Properties
4.3. Configuration Properties with Prefix cache.control
4.4. Configuration Properties with Prefix cae.cors
4.5. Further Configuration Properties
4.6. Renamed CAE Configuration Properties
4.7. Content Server Properties
4.8. CORBA Properties
4.9. Publisher Properties
4.10. SQL Properties
4.11. Replicator Properties
4.12. capclient.properties
4.13. Renamed Content Server Properties
4.14. Headless Server Properties
4.15. Persisted Query Properties
4.16. Headless Server Remote Properties
4.17. Headless Server External Framework Properties
4.18. Renamed Headless Server Properties
4.19. Workflow Server Properties
4.20. Studio Properties
4.21. Preview URL Service Properties
4.22. Content Security Policy Related Studio Properties
4.23. Content Hub Properties
4.24. Feedback Hub Properties
4.25. Editorial Comments Properties
4.26. Commerce Hub Properties
4.27. Elastic Social Properties
4.28. MongoDb Properties
4.29. Counters Properties
4.30. Task-Queues Properties
4.31. Elastic Solr Properties
4.32. Renamed Elastic Social Properties
4.33. Properties of the cm-xmlimport.properties file
4.34. Properties of the cm-xmlimport.properties file
4.35. Content Feeder Solr Configuration Properties
4.36. Properties for login
4.37. Partial update configuration
4.38. Feeder Batch Configuration Properties
4.39. Properties to feed additional items
4.40. Properties to specify content types.
4.41. Include property types
4.42. Feeder Tika Configuration Properties
4.43. Feeder Core Configuration Properties
4.44. Error Handling Configuration Properties
4.45. Renamed Content Feeder Configuration Properties
4.46. Configuration of general properties independent from the type of the search engine
4.47. Feeder Tika Configuration Properties
4.48. CAE Feeder Solr Configuration Properties
4.49. Renamed Content Feeder Configuration Properties
4.50. UAPI Spring Boot Client Properties
4.51. Renamed UAPI Spring Boot Client Properties
4.52. Cache Properties
4.53. Image Transformation Properties

Preface

Search Results

Table Of Contents