EasyDCIM Documentation
Back Home
Free Trial Request Get Started

Docker Management with easydcim-control

Installation & Configuration

# Docker Management with easydcim-control

EasyDCIM 1.25.0 and newer is managed as a Docker-based stack. The supported operational interface is the easydcim-control CLI, which installs, updates, migrates, backs up, restores, and manages the following components:

  • EasyDCIM App
  • Remote Agent
  • Client Area

This replaces the older host-based workflow built around standalone installer scripts, direct Apache configuration, and direct service management on the host.

# Requirements

Before using easydcim-control, prepare a host 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

Docker is installed automatically by the CLI if it is not present yet.

# Installing easydcim-control

wget -qO- 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

# Main commands

# EasyDCIM App

easydcim-control app install --key LICENSE_KEY
easydcim-control app update
easydcim-control app status
easydcim-control app logs
easydcim-control app restart

# Remote Agent

easydcim-control agent install
easydcim-control agent update
easydcim-control agent status
easydcim-control agent logs

# Client Area

easydcim-control client install --mode external --backend-url "https://panel.example.com" --app-token "TOKEN"
easydcim-control client update
easydcim-control client status
easydcim-control client logs

# Running application commands inside containers

For maintenance commands that still belong to the EasyDCIM or Remote Agent application, use shell passthrough through easydcim-control.

# EasyDCIM App

easydcim-control app shell -- php artisan <COMMAND>

Example:

easydcim-control app shell -- php artisan user:reset [email protected]

# Remote Agent

easydcim-control agent shell -- php artisan <COMMAND>

# Backup and restore

# EasyDCIM App

easydcim-control app backup
easydcim-control app restore
easydcim-control app restore /opt/backups/app/<TIMESTAMP>

# Remote Agent

easydcim-control agent backup
easydcim-control agent restore
easydcim-control agent restore /opt/backups/agent/<TIMESTAMP>

Backups are stored under /opt/backups/ and are managed separately for the App and the Remote Agent.

# Migration from legacy host-based installations

If your deployment still runs directly on the host instead of Docker, use the built-in migration commands:

easydcim-control app migrate
easydcim-control agent migrate

easydcim-control app migrate is intended for the main EasyDCIM server and automatically migrates a detected local Remote Agent. Use agent migrate separately for standalone Remote Agent hosts.

# SSL management

# EasyDCIM App

easydcim-control app ssl install <fullchain.pem> <privkey.pem> <domain>
easydcim-control app ssl letsencrypt install <domain>
easydcim-control app ssl letsencrypt renew
easydcim-control app ssl letsencrypt remove

# Client Area

easydcim-control client ssl install <fullchain.pem> <privkey.pem>
easydcim-control client ssl letsencrypt install <domain>
easydcim-control client ssl letsencrypt renew
easydcim-control client ssl letsencrypt remove