Installation Guide

Requirements

To install EasyDCIM, prepare a server with:

  • Debian 12 “bookworm” or Debian 13 “trixie”
  • root or sudo access
  • outbound access to:
    • apt.easydcim.com
    • docker-registry.easydcim.com
    • license.easydcim.com
  • free ports required by the selected deployment mode

For the default installation workflow, the host should be ready for:

  • EasyDCIM App: 80, 443, 3306, 6388, 6390, 8086, 3000
  • Local Remote Agent installed together with the App: 8080, 8081, 3307, 6379
  • Local Client Area installed together with the App: 8444, 8443

Docker is installed automatically by easydcim-control if needed.

Installation steps

1. Install the easydcim-control package

Recommended method:

curl -fsSL https://apt.easydcim.com/easydcim-repo.gpg | sudo tee /usr/share/keyrings/easydcim.gpg > /dev/null

echo "deb [signed-by=/usr/share/keyrings/easydcim.gpg] https://apt.easydcim.com bookworm-stable main" | sudo tee /etc/apt/sources.list.d/easydcim.list

sudo apt update && sudo apt install easydcim-control

2. Run the EasyDCIM installation

sudo easydcim-control app install --key 'LICENSE_KEY'

The license key can be found in your client area under Licenses.

What the installer does

The installation workflow automatically:

  • verifies the license
  • downloads the EasyDCIM package and Docker appliance files
  • prepares Docker configuration and application environment files
  • starts the required containers
  • initializes the database
  • creates the first administrator account
  • installs and registers the local Remote Agent, if enabled
  • installs the local Client Area, if enabled

At the end of the process, the command prints:

  • the backend URL
  • the generated administrator username
  • the generated administrator password

To guarantee stable operation and high performance, both the EasyDCIM server and Remote Agent servers should meet specific hardware requirements. These demands scale with the number of devices and network interfaces managed in the system.

  • OS: Debian 12 or Debian 13
  • Memory (RAM): Minimum 8 GB
  • CPU: Minimum 4 cores / 8 threads
  • Storage: We strongly recommend using SSD or NVMe drives for both servers, as they provide significantly better read/write throughput, which is crucial during data polling and graph generation.

EasyDCIM Server Requirements

This is the central application server responsible for managing:

  • the database layer, storing and querying all infrastructure and client data,
  • the backend/API HTTP server, serving the admin panel, client area, and handling external integrations,
  • asynchronous queues, monitoring services, and time-series storage running inside the Docker stack.

Recommended specs:

  • CPU: 4 cores / 8 threads or more
  • RAM: At least 16 GB
  • Storage: SSD or NVMe (high I/O throughput is critical)
  • Network: Stable internet connection with open required ports

Remote Agent Server Requirements

Remote agents are responsible for executing the Polling Process, which runs every 5 minutes and collects data directly from physical infrastructure (e.g., switches, servers).

  • Polling can be I/O- and CPU-intensive, especially with a large number of network devices.
  • These agents must operate reliably without introducing delays to data collection.

Recommended specs:

  • CPU: 4 cores / 8 threads or more
  • RAM: At least 8 GB
  • Storage: SSD or NVMe
  • Network: Direct access to monitored devices; must allow communication with the EasyDCIM server

After installation

Useful post-installation commands:

easydcim-control app status
easydcim-control app logs
easydcim-control agent status
easydcim-control client status

If you are migrating an older host-based deployment to EasyDCIM 1.25.0+, use the migration workflow described in Migration guide from old to new server.