Install Prelude CPE Manager

The following instructions describe how to deploy Prelude CPE manager using Docker.

Before starting, make sure :

• your host is matching the minimum requirements
• docker and docker compose are installed (Docker Installation Guide)
• you have your registry account credentials and namespace (if you don't have an Arolo registry account, contact us)

You are ready to start !

The following guide is considering that you are installing Prelude in the /opt/prelude-cm folder.

Requirements

To run Prelude CPE Manager we recommend:

• 8 GB of memory
• 6 vCPU
• 100GB of disk

Validate registry authentication

Start by validating that you can connect to Arolo container registry.

docker login registry.arolo-solutions.com

Then, enter you username and password. If authentication failed, please contact us.

Create the files

Create the following folders:

mkdir volumes
mkdir certs

First you need to create a docker-compose.yml file in your install directory.

services:
  db:
    image: postgres:17.6-alpine
    restart: unless-stopped
    env_file:
      - .env
    volumes:
      - ./volumes/db:/var/lib/postgresql/data
  web-ui:
    image: registry.arolo-solutions.com/<namespace>/prelude-cpe-manager:1.0
    restart: unless-stopped
    volumes:
        - ./pcm-config.json:/app/config.json
        - ./certs:/app/certs
    ports:
        - 443:443
    depends_on:
        - db

Then, create the .env file with your own password:

POSTGRES_PASSWORD=not-safe-klnav12asdfvIA-23HRGWD!SCaxc-change-me
POSTGRES_USER=prelude
POSTGRES_DB=prelude_cpe_manager

Finally, create the config file pcm-config.json and replace the placeholder by your values:

{
  "debug": true,
  "timezone": "Europe/Paris",
  "gweb": {
    "routers": [
      {
        "name": "default",
        "address": "0.0.0.0:443",
        "default": true,
        "secure": {
          "certificate": "certs/<cert-file>.crt",
          "key": "certs/<cert-key-file>.key"
        }
      }
    ],
    "database": {
      "postgre": {
        "host": "db",
        "username": "prelude",
        "password": "<previously-defined-password>",
        "dbname": "prelude_cpe_manager",
        "port": 5432,
        "sslmode": false
      }
    },
    "key": "<32-chars-random-string>"
  },
  "app": {
    "external-url": "https://<public-ip>"
  }
}

Start Prelude CPE Manager

Pull all the containers images:

docker compose pull

Make sure, that all images have been pulled.

$ docker compose pull
[+] Pulling 2/2
 ✔ db Pulled
 ✔ prelude-cpe-manager Pulled

Run Prelude CPE Manager

docker compose up -d

Migrate the database models :

docker compose run --entrypoint="/app/prelude-cpe-manager migrate" web-ui
docker compose up -d --remove-orphans

Expected output :

NAME                    IMAGE                                                               COMMAND                  SERVICE       CREATED          STATUS          PORTS
prelude-cm-db-1         postgres:17.6-alpine                                                "docker-entrypoint.s…"   db            1 minute ago     Up 1 minute     5432/tcp
prelude-cm-web-ui-1     registry.arolo-solutions.com/<namespace>/prelude-cpe-manager:1.0    "/app/prelude-gatewa…"   web-ui        1 minute ago     Up 1 minute     0.0.0.0:443->443/tcp, [::]:443->443/tcp

Create Prelude CPE Manager superuser:

docker compose exec -it web-ui /app/prelude-cpe-manager user create -u admin -e john.doe@arolo-solutions.com -p <password>

Open https://host-fqdn/ in your web browser and try to log in with the superuser credentials.

Initial Configuration

Coming soon...