Documentation Center

High-level installation process

The following steps summarize the essential steps in the overall process for installing Tridion Docs. If you are installing the product in a production environment, various departments within your organization would take care of various parts of the installation.

Step 1: Check hardware prerequisites for Content Manager

Before you start installing, check if the hardware you intend to use meets the minimal hardware requirements: : Content Manager hardware requirements.

Step 2: Create the Content Manager database

  1. Create the database for Content Manager:
    1. Ensure that the software prerequisites for Content Manager database are met: Content Manager software requirements.
    2. Create and install the Content Manager database: Configuring Microsoft SQL Server or Configuring Oracle RDBMSs.
    3. Don't forget to run the Database Upgrade Tool, when the application server is installed, to ensure that your database matches the application version. More information can be found here: DBUpgradeTool (DBUT) overview.

Step 3: Create additional databases for Content Manager features

To implement security for Content Manager clients, you need to create three additional databases:

  1. Create the Access Management database: Creating the Access Management database

    Tridion Access Management (or simplyAccess Management) provides implementors with a simplified approach to identity management and gives administrators a central location for ongoing management of access to applications.

  2. Create the Backend for Frontend database: Creating the Backend for Frontend database

    Backend for Frontend, or BFF, refers to an architectural pattern that uses a middle layer between the frontend clients and the backend. BFF also refers to the layer itself and each client has a dedicated BFF. A single BFF database is used for the various BFFs.

  3. Create the Tridion Docs Identity Provider database: Creating the Tridion Docs Identity Provider database

    Tridion Docs provides the Tridion Docs Identity Provider as a sample identity provider that OpenID Connect protocol and makes it easy to get started with Access Management.

To implement the Metrics feature for Content Manager, you need to create theMetrics database: Creating the Metrics database

Metrics is a feature that gives customers a variety of metrics, extracted from the content they create. The feature extracts technical documentation metrics that consist of productivity metrics as well as a Return on Investment value, which is based on the level of content reuse that is measured. Gathered data is collected and aggregated in the Metrics database. The Metrics web service fetches the data from the database and serves it up to its clients.

Step 4: Install and configure Content Manager

  1. Ensure that all software prerequisites for Content Manager are met (application server, clients, etc.): Content Manager software requirements.
  2. Prepare for installation by extracting the CD and completing inputparameters.xml; more information can be found here: Preparing the inputparameters.xml file.
  3. Use InstallTool.exe to install the application server: Executing the InstallTool
  4. Enable Draft Space and Review Space : Enabling Draft Space and Enabling Review Space.
  5. Configure Content Manager.

Step 5: Content Delivery - Install the databases for Content Delivery and Discovery Service

  1. Make sure that all software prerequisites for Content Delivery database are met (system, browsers, etc.): Prerequisites for Content Delivery microservices.
  2. Obtain a license for Content Delivery from your RWS representative.
  3. Create and install the databases: Installing the Content Delivery relational databases and OpenSearch indexes.

Step 6: Install Content Delivery microservices

  1. Make sure that all software prerequisites for Content Delivery are met (system, browsers, etc.): Prerequisites for Content Delivery microservices.
  2. Follow the steps in Installing a Content Delivery microserviceto install the microservices.

Step 7: Install Dynamic Delivery presentation environment

Dynamic Delivery presentation environment can either be DXA for Dynamic Documentation, or an environment you have implemented on your own. For the Dynamic Documentation environment:

  1. Make sure that all the components of Content Delivery have been installed.
  2. Follow the steps to install DXA listed in the DXA documentation: Digital Experience Accelerator.
  3. To build your own presentation environment based on the Dynamic Documentation, refer to the RWS GitHub project (https://github.com/RWS/dd-webapp-custom-examples) for Dynamic Documentation. Use its Getting Started Guides and Customization examples to get started with a Maven project based on the Maven archetype for Dynamic Documentation. It is currently only possible to build a Java web application.

Step 8: Check Dynamic Delivery output formats and check out a topic

  1. Check the Content Manager's Dynamic Delivery format properties in Settings > System > Output Formats: The Discovery Service should have correct value for URL (Unified Delivery Platform discovery URL field), Client ID and Client Secret.
  2. Check out a topic from Organize Space.