Web Monitoring Interface

Real-time visibility into your OviOS storage node — pools, targets, shares, services, and system health at a glance
OviOS Linux 6.2 ovios-web HTTPS · Port 8443

1 Overview

ovios-web is a lightweight HTTPS monitoring interface built into OviOS. It gives you real-time visibility into storage pools, iSCSI targets, NFS and SMB shares, service states, capacity usage, and system metrics — all from a browser.

ℹ️

Monitoring only — not a management UI. All storage administration (pools, volumes, LUNs, iSCSI, NFS, SMB, S3, and so on) is done through the ovios-shell CLI. The web interface is for observation and reporting.

🗄️

Storage Pools

Health status and capacity usage for every ZFS pool.

🔌

iSCSI Targets

Active targets with mapped LUNs and initiator connection state.

📁

SMB & NFS Shares

Active shares, connected clients, and protocol version in use.

⚙️

Services

Live running status and enabled state (from options) for all OviOS services.

📊

Capacity Bar

Aggregate capacity view across all pools.

📄

Storage Report

Generate and download a full storage health report as a PDF.

🔬

System Deep Dive

Detailed system metrics, disk utilization, and I/O statistics.

🔄

Cluster Sync Logs

Configuration sync status when autosync and replication are active.

2 Enabling the Service

The web interface is disabled by default. Enable it with a single options command:

options ovios-web.enable on

Once enabled, manage it like any other OviOS service using the service command:

service ovios-web start
service ovios-web stop
service ovios-web restart
service ovios-web status

Or using the interactive service manager:

service   # select ovios-web from the menu

Example restart output:

ovios-shell ➤ service ovios-web restart

Executing restart on ovios-web...

ovios-shell ➤

3 Accessing the Interface

The web interface is served over HTTPS on port 8443 by default. Open a browser and navigate to:

🔒 https://<ovios-ip>:8443
ℹ️

New in 6.2: HTTPS works out of the box. If no certificate is installed, a self-signed one is generated on first start in /etc/ovios/certs/ (your browser will ask you to accept it once). To use your own certificate, replace cert.pem and key.pem there and restart the service. The dashboard header shows the OviOS version and whether the node runs live or installed, stateless or stateful.

Default Credentials

Username Default Password
oviosadm ovios
⚠️

Change the default password before exposing the interface on a production or network-accessible system.

Changing the Password

ovios-shell ➤ passwd oviosadm
New password:
Retype new password:
Password updated successfully for oviosadm.

4 Configuration

Changing the Port

The default port 8443 can be changed by editing the systemd service unit. This requires dropping into the system shell:

  1. Switch to the system shell:
    su-ovios
  2. Edit the service file:
    sudo vim /etc/systemd/system/ovios-web.service
    Find and update this line to your desired port:
    Environment=OVIOS_WEB_PORT=8443
  3. Reload systemd and restart the service:
    sudo systemctl daemon-reload
    Then from ovios-shell:
    service ovios-web restart
⚠️

The service file is not part of the saved OviOS configuration: on a stateless node (booted from USB, ISO or PXE) the change is lost at the next boot, and reinstalling OviOS restores the default port.

ZFS Root & RAM Mode

ℹ️

If OviOS is installed on a ZFS root filesystem (rather than ext4) or running in LiveOS RAM mode, the rpool and bpool (if imported) will also be monitored and shown in the pools section alongside your storage pools.

5 Main Dashboard View

The main dashboard is divided into panels that update in real time. Each panel covers a distinct area of the system. Below is a walkthrough of each.

💡

The health indicator in the header shows HEALTHY while all pools are healthy, and also when no pools exist yet. It changes to a red ALERT: CHECK POOLS when any pool reports a problem (pool health shows the details).

6 Storage Pools

The pools panel displays all imported ZFS pools with their current health state and capacity. For each pool you can see:

  • Pool name and overall health status (ONLINE, DEGRADED, FAULTED)
  • Size, allocated and free space, and capacity percentage
⚠️

A DEGRADED pool means one or more disks have failed. The pool is still operational but has no redundancy — replace the failed disk immediately before another failure causes data loss.

7 iSCSI Targets

The iSCSI panel lists all active targets and their mapped LUNs. For each target you can see the IQN, mapped LUN paths, sizes, and current initiator connection state.

ℹ️

Empty targets do not appear here. A target with no LUNs mapped to it is not shown in the web interface. Map at least one LUN to a target using lun map or lun_setup for it to become visible.

8 SMB & NFS Shares

The shares panel shows all active file shares across both protocols side by side.

🪟
SMB Shares

Lists all active SMB/CIFS shares, currently connected users, and session count.

🐧
NFS Exports

Lists all active NFS exports, connected clients, and the NFS protocol version in use (v3 / v4).

9 Services

The services panel shows the state of every OviOS service across two dimensions:

Column What It Shows
Enabled Whether the service is configured to start — reflects the options setting (e.g. nfs.enable on)
Running Whether the service process is currently active — updated live

A service can be enabled but not running (it crashed or was manually stopped) or running but not enabled (started manually for a session). Both columns together give the full picture.

Prometheus

When the Prometheus metrics service is running, a Prometheus button appears in the dashboard header. It opens http://<ovios-ip>:9090 in a new tab, and the service also shows in the services panel as PROMETHEUS.

options prometheus.enable on   # start now and at every boot
service prometheus status       # or start | stop | restart | logs

10 Capacity Bar & Cluster Sync

Capacity Bar

The capacity bar at the bottom of the main view aggregates storage usage across all pools. It shows total used versus total size of your data pools (the system pools rpool and bpool are not counted). The bar turns orange above 80% and red above 90%. Use the pools panel for per-pool figures.

⚠️

ZFS performance degrades above 80% pool utilization. The capacity bar highlights pools approaching this threshold. Plan expansion before any pool reaches 75%.

Cluster Sync Logs

When autosync.enable is on and replication is configured, the sync log panel shows the status of automatic configuration synchronization between replication partners. This lets you confirm that your standby node's configuration is current without logging into it manually.

options autosync.enable on   # enable to activate the sync log panel

11 System Deep Dive

Click System in the interface to switch to the deep dive view. This section provides detailed performance and hardware metrics beyond the summary panels on the main dashboard.

📈
System Metrics

Per-core CPU utilization, active and cached memory, swap usage, the CPU model, core count, kernel version and uptime, and the top processes by CPU.

💾
Disk Utilization

Utilization (busy time) per disk and partition, with read and write operation counts — useful for identifying hot disks or bottlenecks within a pool.

📉
Main view metrics

The main view adds total CPU, memory, ZFS ARC size, and network throughput (in and out, plus the total since boot), refreshed every few seconds.

12 Actions

The web interface exposes a small set of system actions. These require appropriate authentication and, for destructive operations, confirmation.

ℹ️

6.2: if an action fails, the dashboard now shows the error instead of silently doing nothing. Reboot, Shutdown and Restore Config only accept requests from the dashboard itself, so another website open in your browser cannot trigger them. Scripts that call the API directly (for example curl -X POST .../api/v1/sys/restore) keep working.

Action Description Notes
Backup Config Creates a configuration archive of your OS options, network, iSCSI, SMB (including users) and NFS services in RAM until you download it locally. It does not create a backup to disk like sync-config backup-only
Restore Config Upload a .tar.gz backup archive to restore the system configuration. Useful for RAM mode recovery without CLI access
Storage Report Generates a comprehensive PDF health report covering pools, disks, LUNs, shares, ARC stats, and recommendations. Downloads immediately to your browser
Reboot Gracefully reboots the OviOS node. Requires confirmation
Shutdown Gracefully powers off the OviOS node. Requires confirmation
💡

The PDF storage report is an easy way to share a point-in-time snapshot of system health with a team or for record-keeping. It includes automated findings and recommendations based on current pool, disk, ARC, and network state.