1 - Data Backup

How to backup your data

Stop server and copy the .db and .data directory to a safe location. You might need sudo rights for this.

2 - Logs

Where to find logs and how to manage them.

Application Logs

In the .logs directory, you can find all the logs generated by the server.

Container Logs

There are also some logs generated by OCI containers. You can find them in the /var/lib/docker/containers (or equivalent if you are using something else) directory. For database, 10x 10mb files are retained. For application, 10x 100mb files are retained.

3 - Setup on Windows

Running CDM-Server on Windows using WSL2

Prerequisites

  • Latest Windows Version with WSL2 Support
    • Recommended: Windows Server 2022
    • Should Work: Windows 11 23H2+
  • Access to Windows Store
  • Internet Connection

Installation Steps

  1. Install: Ubuntu LTS on Windows Store
    • Alternatively, open Windows Store, Search for Ubuntu (by Canonical Group Limited) and Install it
  2. Open Ubuntu from START and follow the instructions to set up your user inside WSL Ubuntu
  3. Install Docker Engine with Docker Compose Plugin
  4. Once done, optionally type: cd ~ && mkdir cdm && cd cdm
  5. Now that you have a working linux inside windows, you can follow the CDM-Server installation on linux steps: See here
  6. After the installation, you can find the CDM-Server in ~/cdm directory

Troubleshooting

  • I can access CDM-Server from the server computer but not from other devices
    • Check your firewall settings and make sure the port is open
    • The specified CDM_HOST should resolve to the server’s IP address
  • I want to run CDM-Server as a service in Ubuntu

4 - Bill of Materials

Software Bill of Materials for CDM-Server

CDM-Server SBOM

We provide the SBOM in OWASP’s CycloneDX v1.5/v1.6 format which has been officially ratified as an Ecma International standard.

You can find the SBOM for CDM-Server here:

Additional Information

  • CDM-Server utilizes Java 21 (Temurin 21.0.5)
  • CDM-Server utilizes PostgreSQL v16.4 (postgres:16-alpine)
  • CDM-Server docker image utilizes Ubuntu 24.04

5 - Install Self-Signed Certificate

How to Install Self-Signed Certificate on the Client

Manual Installation Steps

First, you receive the certificate from the administrator. Then, you can install it using the following steps:

Right Click on Certificate

Install Certificate

Select Location

Proceed Installation

Review

Confirm Warning

6 - Create PFX

How to Create a PFX File from CER/KEY Files

At the moment, we only support .pfx file for custom certificates. If you have a different format, you can convert it to .pfx using the following command:

openssl pkcs12 -export -out cdm-server.pfx -inkey example.key -in example.cer -certfile fullchain.cer

Where:

  • example.key: Your private key file.
  • example.cer: Your certificate file.
  • fullchain.cer: The additional CA certificate chain.