For the complete documentation index, see llms.txt. This page is also available as Markdown.

Managing Systems

This guide covers deploying, managing, archiving, and restoring systems through the Rumi Admin web interface.

Overview

Rumi Admin provides a visual interface for managing the lifecycle of Rumi systems. It communicates with one or more Rumi Agents to perform system operations.

Connecting to Agents

Before managing systems, Rumi Admin must be connected to at least one Rumi Agent:

  • Default agents are configured in ecosystem.json and loaded automatically at startup.

  • Additional agents can be added, updated, or removed through the Admin UI. Agent registrations are stored in the SQLite database shared with Grafana.

Each agent provides access to the systems it manages. The Admin UI aggregates systems across all connected agents.

Deploying Systems

To deploy a new system:

  1. Navigate to the system management section.

  2. Upload a XAR file through the UI.

  3. Select the target agent to deploy to.

  4. The XAR is uploaded to the Agent's POST /xars/unpack endpoint, which unpacks it and creates the system.

Once deployed, the system appears in the system list and is available for script execution and lifecycle management.

System Operations

Viewing Systems

The Admin UI displays all systems from all connected agents, showing:

  • System name.

  • Available containers and their status.

  • Available scripts.

Archiving Systems

To archive a system that is no longer actively used:

  1. Select the system.

  2. Choose the archive operation.

  3. The system is moved to the .archived/ directory on the Agent.

Archived systems are retained but no longer active.

Restoring Systems

To restore a previously archived system:

  1. Navigate to the archived systems view.

  2. Select the system to restore.

  3. The system is moved back to the active systems/ directory.

Deleting Systems

To permanently remove a system:

  1. Select the system.

  2. Choose the delete operation.

  3. The system is permanently removed from the Agent.

Permission Control

Rumi Admin supports restricting command-and-control access:

  • Per-user — The disable_cnc flag can be set per user to provide read-only monitoring access.

  • Global — The global_disable_cnc setting disables command-and-control for all non-admin users.

When command-and-control is disabled, users can view system status and dashboards but cannot execute scripts, deploy XARs, or invoke commands.

Last updated