Mirror App Migration to PoolParty 10

24/04/26

This guide explains how to migrate existing Mirror App installations to dockerized PoolParty 10 environments.

Before beginning the migration, ensure the following requirements are met:

PoolParty 10 Add-ons must be deployed. The Mirror App service is defined in the addons.yaml file, alongside all other add-ons. For more information, refer to the add-on services installation guide.
The core PoolParty migration (9.7.1 to 10) must be completed.
Secure a backup of your Server-map.json configuration file from the old Mirror App installation.
An ApiUser must be created on the PoolParty 10 instance and target projects must reside in the same PoolParty group as the ApiUser.
Note
You must have an ApiAdmin user created on the target PoolParty 10 server.

Stop the Mirror App service:

docker compose -f docker-compose.yaml -f addons.yaml stop mirror-app

The Server-map.json file defines your source and target environments. You must either modify the default template (found in files/Server-map.json) or restore your backed-up version.

Map the volume in your addons.yaml file under the mirror-app block:
```
volumes:
  - ./files/Server-map.json:/app/Server-map.json
```

Ensure the source and targets match your new infrastructure.

Note

Use the keyword ID (the project identifier in the URL) to match projects between source and target.

{
  "source": {
    "host": "https://<source-server-url>",
    "name": "Authoring",
    "user": "apiuser",
    "password": "poolparty",
    "export_parameters": {
        "modules": [ "concepts", "blacklistedTerms" ]
    },
    "comment": "Role: API User; Groups: Mirror"
  },
  "targets": [
    {
      "host": "https://<target-server-url>",
      "name": "Production 01",
      "user": "apiadmin",
      "password": "poolparty",
      "comment": "Role: API Admin; Groups: Public"
    }
  ]
}

Configure PoolParty UI Integration by registering the Mirror App as an external service in the Semantic Middleware Configurator:
1. Login to PoolParty and navigate to the Semantic Middleware Configurator tab.
2. Go to External Services>Services
3. Declare the service with the following parameters:
  - Name: Project Sync (or your preferred display name)
  - URL: https://<your-server-domain>/PoolParty/mirror/ui
  - Export Type: Select no data export
  - Image Field: https://<your-server-domain>/PoolParty/mirror/ui/logo.svg

Start the Mirror App:

docker compose -f docker-compose.yaml -f addons.yaml up -d mirror-app

Navigate to https://<your-server-domain>/PoolParty/mirror/ui
Ensure the source, target, and projects are reflected accurately.
Execute mirroring and test the sync between servers.
Tip
For mirroring to work, the target server must have an empty project with the same Keyword ID as the source. In the URI https://<source-server-url>/ADFproject/<UUID>, the Keyword ID is ADFproject. Set this value in the Project Identifier field during project creation on the target server.

In this section: