Skip to content

Installation

Jump to bottom
Tommaso Caiazzi edited this page Apr 7, 2026 · 2 revisions

Installation Guide

This guide covers installing the IXP Digital Twin components for both development and production environments.

Prerequisites

Before installing the IXP Digital Twin, ensure you have:

  • Docker (version 20.10 or later) and Docker Compose (version 2.0 or later)
  • Git for cloning repositories
  • Kathará (for network emulation) - Installation instructions
  • Sufficient system resources:
    • Minimum: 4GB RAM, 2 CPU cores, 10GB disk space
    • Recommended: 8GB RAM, 4 CPU cores, 20GB disk space

Component Architecture

The IXP Digital Twin consists of three main repositories:

  1. ixp-digital-twin - Core emulation engine
  2. ixp-digital-twin-dashboard - Configuration and monitoring interface
  3. ixp-quarantine-dashboard - Customer onboarding interface

Installation Steps

1. Clone the Repositories

Create a working directory and clone all required repositories:

mkdir ixp-digital-twin-workspace
cd ixp-digital-twin-workspace

# Clone the core digital twin
git clone git@github.com:KatharaFramework/ixp-digital-twin.git

# Clone the main dashboard
git clone git@github.com:KatharaFramework/ixp-digital-twin-dashboard.git

# Clone the quarantine dashboard
git clone git@github.com:KatharaFramework/ixp-quarantine-dashboard.git

2. Install the Main Dashboard

The main dashboard provides configuration and monitoring capabilities.

Development Installation

cd ixp-digital-twin-dashboard
docker compose -f docker-compose-dev.yml up --build

Note: Use the --build flag only on the first run.

The dashboard will be available at http://localhost:5174/

Production Installation

For production deployments:

  1. Configure production settings by creating a docker-compose.yml file from the docker-compose-prod.yml template.
  2. Ensure to properly set the environment variables and the ports.
  3. In production, the dashboard is exposed by the reverse proxy on ports 8080 (HTTP) and 8443 (HTTPS).
  4. To run the production environment:
cd ixp-digital-twin-dashboard
bash run_prod.sh

3. Install the Quarantine Dashboard

The quarantine dashboard manages customer onboarding and validation.

Development Installation

cd ixp-quarantine-dashboard
docker compose -f docker-compose-dev.yml up --build

Note: Use the --build flag only on the first run.

The quarantine dashboard will be available at http://localhost:5173/

Production Installation

For production deployments:

  1. Configure production settings by creating a docker-compose.yml file from the docker-compose-prod.yml template.
  2. Ensure to properly set the environment variables and the ports.
  3. To run the production environment:
cd ixp-digital-twin-dashboard
docker compose up --build

Note: Use the --build flag only on the first run.

Docker Images

The digital twin uses specialized Docker images for route servers. We ship several pre-built images, for more details on the available images, please see the Docker-Images repository or the official Docker Hub.

To build a custom Docker image (e.g., with a different version of Bird), see Build a Custom Docker Image.

Clone this wiki locally