Skip to content
CodeHarbor Docs

Advanced Configuration

Custom SSL certificates

Section titled “Custom SSL certificates”

When Report-Engine is started for the first time, it will generated a self-signed certificate. If you wish to use your own certificate this can be configured in the docker-compose.yml file.

Make sure you have the certificate & key files present at the report-engine directory.

  • Directoryreport-engine
    • report-engine-v1.0.3.tar.gz
    • license.key
    • docker-compose.yml
    • custom-ssl.pem
    • custom-ssl.key
Terminal window
chmod 101:101 custom-ssl.pem custom-ssl.key

Now we can update the the docker-compose.yml file to instruct the web container to use the custom SSL files during startup.

docker-compose.yml
services:
  web:
    container_name: report-engine-web
    image: codeharbor/report-engine-web
    restart: unless-stopped
    volumes:
      - report_engine_storage:/var/www/storage
      - ./custom-ssl.pem:/etc/nginx/ssl/custom-ssl.pem:ro
      - ./custom-ssl.key:/etc/nginx/ssl/custom-ssl.key:ro
    environment:
      SSL_CERT_PATH: '/etc/nginx/ssl/custom-ssl.pem'
      SSL_KEY_PATH: '/etc/nginx/ssl/custom-ssl.key'
    ports:
      - 80:80
      - 443:443
    depends_on:
      - app

After the docker-compose.yml file has been updated you can restart the containers to ensure the changes are applied.

Terminal window
docker compose up -d

Specific versions

Section titled “Specific versions”

There are multiple version tags available with each release.

  • Latest version (latest)
  • Major versions (1.0)
  • Minor versions (1.0.3)

By default the latest tag is used and should be sufficient for most use cases. This will also ensure smooth upgrades when the new versions are loaded in the server.

If you wish to run a specific version of Report-Engine or lock it to a major version, you can use the available tags. You can always check which versions are available and loaded in your system by using the command docker images That should give similar like below

Terminal window
IMAGE                                    ID             DISK USAGE   CONTENT SIZE   EXTRA
codeharbor/report-engine-app:1.0         d95d3e0ca78e        799MB          340MB
codeharbor/report-engine-app:1.0.1       b252ef921bcf        799MB          340MB
codeharbor/report-engine-app:1.0.3       d95d3e0ca78e        799MB          340MB
codeharbor/report-engine-app:latest      d95d3e0ca78e        799MB          340MB
codeharbor/report-engine-web:1.0         e4d810bc5f79        149MB         72.7MB    U
codeharbor/report-engine-web:1.0.1       e4d810bc5f79        149MB         72.7MB    U
codeharbor/report-engine-web:1.0.3       e4d810bc5f79        149MB         72.7MB    U
codeharbor/report-engine-web:latest      e4d810bc5f79        149MB         72.7MB    U
codeharbor/report-engine-worker:1.0      4e46cc8cdf3e        844MB          362MB
codeharbor/report-engine-worker:1.0.1    ba321a91e3fa        844MB          362MB
codeharbor/report-engine-worker:1.0.3    4e46cc8cdf3e        844MB          362MB
codeharbor/report-engine-worker:latest   4e46cc8cdf3e        844MB          362MB
postgres:17                              00bc86618629        639MB          161MB    U
redis:alpine                             28c9c4d75969        100MB         27.5MB    U
docker-compose.yml
services:
  web:
    container_name: report-engine-web
    image: codeharbor/report-engine-web
    image: codeharbor/report-engine-web:1.0.3
    restart: unless-stopped
    volumes:
      - report_engine_storage:/var/www/storage
    ports:
      - 80:80
      - 443:443
    depends_on:
      - app


  app:
    container_name: report-engine-app
    image: codeharbor/report-engine-app
    image: codeharbor/report-engine-app:1.0.3
    restart: unless-stopped
    volumes:
      - report_engine_storage:/var/www/storage
      - report_engine_cache:/var/www/bootstrap/cache
      - report_engine_env:/var/www/env
      - ./license.key:/var/www/license.key:ro
    depends_on:
      - cache
      - db


  worker:
    container_name: report-engine-worker
    image: codeharbor/report-engine-worker
    image: codeharbor/report-engine-worker:1.0.3
    restart: unless-stopped
    volumes:
      - report_engine_storage:/var/www/storage
      - report_engine_cache:/var/www/bootstrap/cache
      - report_engine_env:/var/www/env
      - ./license.key:/var/www/license.key:ro
    depends_on:
      - app


  housekeeper:
    container_name: report-engine-housekeeper
    image: codeharbor/report-engine-worker
    image: codeharbor/report-engine-worker:1.0.3
    restart: unless-stopped
    environment:
      MODE: housekeeper
    volumes:
      - report_engine_storage:/var/www/storage
      - report_engine_cache:/var/www/bootstrap/cache
      - report_engine_env:/var/www/env
      - ./license.key:/var/www/license.key:ro
    depends_on:
      - app

After the docker-compose.yml file has been updated you can restart the containers to load the specific version of Report-Engine.

Terminal window
docker compose up -d