Skip to content

Running the CxReports Docker Application

This guide outlines the steps to run the CxReports Docker application, which has a dependency on a Postgres database, using Docker Compose.


Docker Compose Configuration

Create a new folder on your machine and save the docker-compose.yml file in it. Below is the file that defines the codaxy/cx-reports service and its database dependency:

    image: codaxy/cx-reports:latest
      - db
      - ./logs:/app/Logs
      - "80:8080"
    restart: always
      - source: appsett_app
        target: /app/appsettings.Production.json

    image: postgres
      - postgres_data:/var/lib/postgresql/data
      POSTGRES_DB: cxreports # Replace with your database name
      POSTGRES_USER: postgres # Replace with your database user
      POSTGRES_PASSWORD: password # Replace with your database password
    restart: always

    file: ./appsettings.Production.json


CxReports runs internally on port 8080, so you need to map it to desired port on your machine. In the example above, we mapped it to port 80.

Application Configuration

  1. Create a new folder named logs in the same root directory.
  2. Create a new file named appsettings.Production.json in it with the following content to it:
  "ConnectionStrings": {
    "Database": "Host=db;Database=cxreports;Username=postgres;Password=password"
  "Encryption": {
    "Key": "6F761C152A69C34B655BFF6226116AD4",
    "Vector": "A9B2BC02C2FDDE88"
  "RootUser": {
    "Email": "[email protected]",
    "Password": "password",
    "DisplayName": "First User"

RootUser is the first user that will be created in the system. You can change the email and password to your liking.


You should replace the default encryption parameters to protect sensitive data stored in the database, i.e. license keys, database connection strings, etc.

To generate a new encryption key and vector, run the following bash command:

openssl enc -aes-128-cbc -k secret -P -md sha1

This command will generate 32 chars long key (key) and vector (iv). The vector should be 16 characters long, so use just the first 16 chars. Replace the values in the appsettings.Production.json file with the values you get from the command.


Key is 32 chars long and vector should be 16 chars long, so use the first 16 chars of the newly generated vector (iv).

Final directory structure should look like this:

├── appsettings.Production.json
├── docker-compose.yml
└── logs
  1. Run the following command in the same directory to start the application:
docker-compose up -d
  1. Open your browser and navigate to http://localhost:80 to access the application.
  2. To stop the application, run the following command:
docker-compose down

Path Base

Path Base is a feature that allows you to host the application under a subdirectory. For example, if you want to host the application under, you need to set the PathBase property in the appsettings.Production.json file:

  "PathBase": "/reports"

SMTP Configuration

To configure SMTP settings, edit the appsettings.Production.json file and add the following section:

  "SmtpServer": {
    "From": "[email protected]",
    "DisplayName": "Company Report",
    "Host": "",
    "Port": 25,
    "Username": "username",
    "Password": "password",
    "EnableSsl": true,
    "DegreeOfParallelism": 4

DegreeOfParallelism is the maximum number of concurrent emails that can be sent. If not specified, the default value is 1.