Container Access Portal

Repository/Image	Description
`xr-dev/xr-ds`	Development Deployment Server, typically nightly builds
`xr-dev/xr-e`	Development Platform, typically nightly builds
`xr-release/xr-ds`	Release Deployment Server, Official Release
`xr-release/xr-e`	Release Platform, Official Release

Podman and Podman Compose installed

Access to XR container images (authentication completed via ECR script)

Configuration files (settings and license)

The Podman compose commands should be run from a parent directory that contains both the compose files and the config/ folder:

your-project-directory/           ← Run podman-compose commands from here
├── podman-compose-xr-ds.yml
├── podman-compose-xr-platform.yml
├── podman-compose-full.yml
└── configs/
    ├── xr-e/
    │   ├── settings.json
    │   └── licence.json
    └── xr-ds/
        ├── settings.json
        └── license.json

Create the following directory structure and files:

./configs/
├── xr-e/
│   ├── settings.json
│   └── licence.json
└── xr-ds/
    ├── settings.json
    └── license.json

Example xr-e Settings

File: ./configs/xr-e/settings.json

Loading xr-e settings...

Example xr-ds Settings

File: ./configs/xr-ds/settings.json

Loading xr-ds settings...

Option 1: xr-ds Only

Use this option to deploy only the xr-ds service with MongoDB.

Loading podman-compose-xr-ds.yml...

# Update configs/xr-ds/settings.json with your MongoDB connection details
podman-compose -f podman-compose-xr-ds.yml up -d

Option 2: xr-ds + xr-e

Use this option for a complete XR platform with MongoDB.

Loading podman-compose-xr-platform.yml...

# Update configs/xr-ds/settings.json with your MongoDB connection details
podman-compose -f podman-compose-xr-platform.yml up -d

Option 3: xr-ds + xr-e + MongoDB (Full Stack)

Use this option for a complete self-contained XR platform with MongoDB included.

Loading podman-compose-full.yml...

podman-compose -f podman-compose-full.yml up -d

After deployment:

xr-e (XR Editor): http://localhost:8080 (available in options 2 and 3)

xr-ds (XR Deployment Server): http://localhost:8100 (available in all options)

MongoDB: localhost:27017 (only exposed in option 3)

Basic Operations

# Start services in detached mode
podman-compose -f podman-compose-full.yml up -d

# Stop services
podman-compose -f podman-compose-full.yml down

# View running services
podman-compose -f podman-compose-full.yml ps

# Follow logs
podman-compose -f podman-compose-full.yml logs -f

# Restart a specific service
podman-compose -f podman-compose-full.yml restart xr-ds

Pod Management

Podman Compose creates pods for related containers:

# List pods
podman pod list

# Inspect pod details
podman pod inspect <pod-name>

# Stop entire pod
podman pod stop <pod-name>

# Remove pod and containers
podman pod rm <pod-name>

Volume Management

# List volumes
podman volume list

# Inspect volume
podman volume inspect <volume-name>

# Remove unused volumes
podman volume prune

Docker and Docker Compose installed

Access to XR container images (authentication completed via ECR script)

Configuration files (settings and license)

The Docker compose commands should be run from a parent directory that contains both the compose files and the config/ folder:

your-project-directory/           ← Run docker compose commands from here
├── docker-compose-xr-ds.yml
├── docker-compose-xr-platform.yml
├── docker-compose-full.yml
└── configs/
    ├── xr-e/
    │   ├── settings.json
    │   └── licence.json
    └── xr-ds/
        ├── settings.json
        └── license.json

Create the following directory structure and files:

./configs/
├── xr-e/
│   ├── settings.json
│   └── licence.json
└── xr-ds/
    ├── settings.json
    └── license.json

xr-e Settings

File: ./configs/xr-e/settings.json

Loading xr-e settings...

xr-ds Settings

File: ./configs/xr-ds/settings.json

Loading xr-ds settings...

Option 1: xr-ds Only

Use this option to deploy only the xr-ds service with MongoDB.

Loading docker-compose-xr-ds.yml...

# Update configs/xr-ds/settings.json with your MongoDB connection details
docker compose -f docker-compose-xr-ds.yml up -d

Option 2: xr-ds + xr-e

Use this option for a complete XR platform with MongoDB.

# docker-compose-xr-platform.yml
version: '3.8'

services:
  xr-e:
    image: 915149977821.dkr.ecr.eu-west-2.amazonaws.com/xr-dev/xr-e
    ports:
      - "8080:8080"
    volumes:
      - ./configs/xr-e/settings.json:/var/www/html/settings/settings.json:ro
      - ./configs/xr-e/licence.json:/var/www/html/php/data/licence.json:ro
    restart: unless-stopped
    networks:
      - xr-network

  xr-ds:
    image: 915149977821.dkr.ecr.eu-west-2.amazonaws.com/xr-dev/xr-ds
    ports:
      - "8100:8100"
    volumes:
      - ./configs/xr-ds/settings.json:/usr/xr/jeremy/settings/settings.json:ro
      - ./configs/xr-ds/license.json:/usr/xr/jeremy/settings/license.json:ro
    depends_on:
      - xr-e
    restart: unless-stopped
    networks:
      - xr-network

networks:
  xr-network:
    driver: bridge

# Update configs/xr-ds/settings.json with your MongoDB connection details
docker compose -f docker-compose-xr-platform.yml up -d

Option 3: xr-ds + xr-e + MongoDB (Full Stack)

Use this option for a complete self-contained XR platform with MongoDB included.

# docker-compose-full.yml
version: '3.8'

services:
  mongo:
    image: mongo:latest
    ports:
      - "27017:27017"
    volumes:
      - mongo-data:/data/db
      - mongo-config:/data/configdb
    environment:
      - MONGO_INITDB_ROOT_USERNAME=admin
      - MONGO_INITDB_ROOT_PASSWORD=password
    restart: unless-stopped
    networks:
      - xr-network

  xr-e:
    image: 915149977821.dkr.ecr.eu-west-2.amazonaws.com/xr-dev/xr-e
    ports:
      - "8080:8080"
    volumes:
      - ./configs/xr-e/settings.json:/var/www/html/settings/settings.json:ro
      - ./configs/xr-e/licence.json:/var/www/html/php/data/licence.json:ro
    restart: unless-stopped
    networks:
      - xr-network

  xr-ds:
    image: 915149977821.dkr.ecr.eu-west-2.amazonaws.com/xr-dev/xr-ds
    ports:
      - "8100:8100"
    volumes:
      - ./configs/xr-ds/settings.json:/usr/xr/jeremy/settings/settings.json:ro
      - ./configs/xr-ds/license.json:/usr/xr/jeremy/settings/license.json:ro
    depends_on:
      - mongo
      - xr-e
    restart: unless-stopped
    networks:
      - xr-network

volumes:
  mongo-data: {}
  mongo-config: {}

networks:
  xr-network:
    driver: bridge

docker compose -f docker-compose-full.yml up -d

After deployment:

xr-e (XR Editor): http://localhost:8080 (available in options 2 and 3)

xr-ds (XR Deployment Server): http://localhost:8100 (available in all options)

MongoDB: localhost:27017 (only exposed in option 3)

Basic Operations

# Start services in detached mode
docker compose -f docker-compose-full.yml up -d

# Stop services
docker compose -f docker-compose-full.yml down

# View running services
docker compose -f docker-compose-full.yml ps

# Follow logs
docker compose -f docker-compose-full.yml logs -f

# Restart a specific service
docker compose -f docker-compose-full.yml restart xr-ds

Container Management

Docker Compose manages containers as individual units:

# List containers
docker ps

# Inspect container details
docker inspect <container-name>

# Stop specific container
docker stop <container-name>

# Remove container
docker rm <container-name>

Volume Management

# List volumes
docker volume list

# Inspect volume
docker volume inspect <volume-name>

# Remove unused volumes
docker volume prune

Available Containers

Command Line Authentication

XR Container Deployments

Podman Compose Deployment

Working Directory Structure

Configuration Files

Deployment Options

Podman Management Commands

Docker Compose Deployment

Working Directory Structure

Configuration Files

Deployment Options

Docker Management Commands