Installation

Installation

Follow below steps to get started with the installation

Note

This guide assumes you are using Docker on a Linux OS Please make sure Docker is installed and active before proceeding. See our requirements page for more details.

Step 1. Download install files

1. Log in to your CodeHarbor Portal:
2. Download following files:
   • Under Downloads section:
     • latest Report-Engine container images (report-engine-vx.x.x.tar.gz)
     • docker-compose.yml
   • Under License section:
     • license.key
3. Place the above files in the same directory

   mkdir report-engine
   cd report-engine/

The file structure will look like this:

• Directoryreport-engine

  • report-engine-v1.0.3.tar.gz
  • license.key
  • docker-compose.yml

Step 2. Import container images

gunzip -c report-engine-v0.0.3.tar.gz | docker load

Depending on your system performance, this process may take several minutes.

Example output

Loaded image: report-engine/web:1.0.0
Loaded image: report-engine/app:1.0.0
Loaded image: report-engine/worker:1.0.0

Tip

Use the correct version number in the command based on the downloaded version file.

Step 3. Update environment variables

Update the POSTGRES_PASSWORD in the docker-compose.yml file before bootstrapping the application.

docker-compose.yml

  db:
    container_name: report-engine-db
    image: postgres:17
    restart: always
    environment:
      POSTGRES_PASSWORD: ""
      POSTGRES_PASSWORD: "Report-Engine123!"
      POSTGRES_USER: "report-engine"
      POSTGRES_DB: "report-engine"
    volumes:
      - report_engine_db:/var/lib/postgresql/data

Tip

Optional: You can use your own Redis and PostgreSQL instances instead of the default containers provided.

Step 4. Start Report-Engine

docker compose up -d

You can now start configuring your Report-Engine instance by accessing the web interface at http://<your-server-ip>. See our configuration guide here.