Documentation

Install DCIM

Install DCIM on a server that already meets the system requirements.
The installer prepares the host, activates the license, downloads the signed release and starts the dashboard. Use a clean server whenever possible.
Your client area shows the license key. Run the installer command and enter the license key when prompted. If the command already includes ?key=..., the installer uses that key directly.

Installer command

Run this command on the server, then paste the license key from your client area.
curl -fsSL "https://dcim.sh/install" | sudo bash

Run the installer

  1. 01Configure DNS for the same domain registered on the order. A record > dcim.example.com > IP.
  2. 02Connect to the server over SSH.
  3. 03Run the installer command as root or with sudo.
  4. 04Wait 1-5min while DCIM installs all dependencies and starts the services.
  5. 05Save the dashboard URL, admin email and temporary admin password printed at the end.

Check the installation

  1. 01Open the dashboard URL in your browser.
  2. 02Run command dcimctl status on the server.
  3. 03Confirm api, dash, db and proxy are running.
  4. 04Confirm the license sync timer is active.

After installation

  1. 01Sign in with the temporary admin password.
  2. 02Change the admin password.
  3. 03Review system settings before adding inventory.
  4. 04Keep the license key private and stored safely.

Installation video

dcimctl utilities

After installation, DCIM creates dcimctl on the server. Use it to check the installation, start or stop services, update the product, sync the license and collect diagnostics.
Commands that change the installation should be run with sudo. Read-only checks such as dcimctl status and dcimctl license can normally be run without it.
Service and update commands
dcimctl status
sudo dcimctl start
sudo dcimctl stop
sudo dcimctl restart
sudo dcimctl update
Run dcimctl status after install, update or restore. It should show the core services api, dash, db and proxy as running.
License commands
dcimctl license
sudo dcimctl license --sync
sudo dcimctl license --sync <license_key>
The license is synced automatically by dcim-license-sync.timer. Use the manual sync command after billing, plan or license changes.
First admin recovery
sudo dcimctl reset-admin --password <new_password>
sudo dcimctl reset-admin --email <new_email>
Use these commands if the first admin password was lost or the first admin email must be changed from the server.
Restore and support
sudo dcimctl restore /path/to/dcim-backup.tar.gz
sudo dcimctl support-bundle
Restore must use a full DCIM backup archive. The support bundle is diagnostic only; it is not a backup.

Fresh reinstall reset

Use reset only when the current local installation should be removed before a fresh install.
Destructive reset command
sudo dcimctl reset
dcimctl reset removes /opt/dcim, DCIM containers, volumes, images, license sync units and the dcimctl symlink. It does not release the license instance.

Next page

After DCIM is installed, continue with the first setup guide.