Installation and Upgrade
This guide covers installing and upgrading Rumi Admin.
Prerequisites
Operating System: macOS (x86_64 or ARM64) or Linux (x86_64 or ARM64)
Disk Space: At least 1GB free for installation
Network: Access to downloads.n5corp.com (for remote installation)
A running Rumi Agent instance (for system management and telemetry)
Quick Start
Standard Installation
curl -fsSL https://downloads.n5corp.com/rumi/admin/latest/install.sh | bashThis installs the latest version to ~/rumi/rumi-admin.
Installation with Custom Location
curl -fsSL https://downloads.n5corp.com/rumi/admin/latest/install.sh | bash -s -- \
--install-dir=/opt/rumiInstallation Options
--install-dir=DIR
Installation directory (default: $HOME/rumi)
--force
Skip confirmation prompts
--verbose
Enable verbose output
--download-only
Download distribution only (no installation)
Specific Version Installation
To install a specific version instead of latest:
Directory Structure
After installation, the following structure is created:
Key Directories
current/
Symlink pointing to the active release
data/
Persistent configuration that survives upgrades
releases/
All installed versions
Configuration
Automatic Configuration Bootstrap
On first startup, Rumi Admin automatically bootstraps configuration files from the release directory to the data directory:
ecosystem.json— Main configuration filegrafana/conf/server.ini— Grafana server configuration
These files are only copied if they don't already exist, preserving your customizations across upgrades.
ecosystem.json
The ecosystem.json file is the central configuration file. It is located in the data directory (data/ecosystem.json) and controls:
apps
Node.js application settings (port, clustering, memory limits)
agents
Default Rumi Agent connections
proxy
Proxy port configuration
ldap
LDAP authentication settings (optional)
okta
Okta SSO settings (optional)
See the Admin Configuration Reference for the full configuration format.
Environment Variables
RUMI_ADMIN_DATA_DIR
Override the default data directory location
Starting and Stopping
Start Rumi Admin
Options:
--verbose— Show detailed output--foregroundor-f— Run in foreground mode (for Docker)
Stop Rumi Admin
Startup Sequence
On startup, Rumi Admin:
Sources
setenv.shto configure the environmentBootstraps
ecosystem.jsonandserver.iniif not presentSpawns a Grafana child process
Waits for Grafana to become ready
Starts the Node.js HTTP server on the configured port
Creates a Grafana API key for internal access
Creates the default InfluxDB data source
Loads the pre-built dashboards
Upgrading
Standard Upgrade
To upgrade to the latest version:
The installer automatically:
Detects the existing installation
Preserves your configuration in the
data/directoryInstalls the new version in
releases/Updates the
currentsymlink to point to the new version
Rollback to Previous Version
If you need to rollback to a previous version:
Checking Installed Version
Listing All Installed Versions
Docker Deployment
Rumi Admin can be deployed as a Docker container.
Building the Docker Image
Running the Container
Docker Configuration
Base image
Ubuntu 22.04
Exposed port
8001
Data volume
/home/rumi/rumi-admin/data
Health check
curl http://localhost:8001
The container uses the --foreground flag to keep the process in the foreground for Docker's process management.
Verifying the Installation
After starting Rumi Admin, open a browser and navigate to http://localhost:8001. You should see the Rumi Admin dashboard.
To verify from the command line:
Troubleshooting
Server Won't Start
Check if the server is already running by accessing
http://localhost:8001Check for port conflicts:
Review the logs in
current/logs/install.log
Configuration Not Applied
Ensure you're editing the configuration in the data/ directory, not in the releases/ directory. The release directory contains only templates.
Grafana Not Starting
Check that the Grafana configuration (data/grafana/conf/server.ini) is valid. If corrupted, you can delete it and restart — a fresh copy will be bootstrapped from the release.
Last updated

