Skip to content
CodeHarbor Docs

Upgrades

Installation

Section titled “Installation”

Follow below steps to get started with the installation

Step 1. Download upgrade files

Section titled “Step 1. Download upgrade files”
  1. Log in to your CodeHarbor Portal:
  2. Download following files:
    • Latest Report-Engine container images (report-engine-vx.x.x.tar.gz)
  3. Place the new version (container images) on the server which is running the Report-Engine application

Make sure you still have the docker-compose.yml & license.key file present from previous installation:

  • Directoryreport-engine
    • license.key
    • docker-compose.yml

Step 2. Import container images

Section titled “Step 2. Import container images”
Terminal window
gunzip -c report-engine-v1.0.4.tar.gz | docker load

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

Example output Loaded image: report-engine/web:1.0.4
Loaded image: report-engine/app:1.0.4
Loaded image: report-engine/worker:1.0.4

Step 3. Use new versions (optional)

Section titled “Step 3. Use new versions (optional)”

If you are a fixed version of Report-Engine (see advanced configuration) you need to update the container version in your docker-compose.yml file to ensure the new images will be used.

docker-compose.yml
services:
  web:
    container_name: report-engine-web
    image: codeharbor/report-engine-web:1.0.3
    image: codeharbor/report-engine-web:1.0.4
    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:1.0.3
    image: codeharbor/report-engine-app:1.0.4
    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:1.0.3
    image: codeharbor/report-engine-worker:1.0.4
    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:1.0.3
    image: codeharbor/report-engine-worker:1.0.4
    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

Step 4. Re-start Report-Engine

Section titled “Step 4. Re-start Report-Engine”
Terminal window
docker compose up -d

Now all containers will restart with the latest version. It’s possible that the startup takes a bit longer because of database migrations. This will only occur the first time the application starts after the upgrade.