Documentation

Everything you need.
All in one place.

Comprehensive guides covering installation, configuration, and administration. From getting started to advanced operations.

📥

Installation Guide

Boot from ISO, install to a dedicated USB/SSD, configure networking, and prepare your system for storage operations.

Read Guide →
📖

Admin Guide

The complete reference for day-to-day administration: pools, datasets, shares, clustering, and troubleshooting.

Read Guide →
⚙️

Options Guide

Understand boot options, kernel parameters, and OviOS-specific configuration flags to tailor your deployment.

Read Guide →
💾

Live-OS Guide

Run OviOS entirely from RAM with a persistent ZFS pool on separate storage drives. Perfect for minimal boot footprints.

Read Guide →
🌐

ovios-web Guide

Access the web-based management console for pool monitoring, dataset management, and service configuration.

Read Guide →
🔁

Replication Guide (retadm)

Set up automated replication between OviOS systems using the retadm tool for high availability and disaster recovery.

Read Guide →

Quick Reference

Common commands and workflows at a glance.

Using smb commands

ovios-shell ➤ smb-user list
smbuser:1001:
ovios-shell ➤ smb-export list

Active SMB Shares
Dataset                                  Status
-------------------------------------------------------
data/ns                                  on
data/smbshare                            on

ovios-shell ➤

Show LUN mappings

ovios-shell ➤ lun mappings
ID   TARGET IQN                                 LUN   PATH         STATUS
--   ----------                                 ---   ----         ------
1    iqn.2026-03.org.ovios:0xo30fecif1y-tg-01   1     /esx/lun34   ACTIVE
5    iqn.2026-03.org.ovios:5nm5h6nlgaap-dwqe    1     /esx/lun4    IDLE
9    iqn.2026-03.org.ovios:9yoz69ixbnft-tg2     1     /esx/lungf   IDLE

Show all services status

ovios-shell ➤ service status-all

[ OviOS System Dashboard ]
SERVICE      STATUS             WORKLOAD / DETAILS
-------      ------             ------------------
SNMPD        OFFLINE   -
SNMPTRAPD    OFFLINE   -
AUDITD       OFFLINE   -
NFS          OFFLINE   -
ISCSI        ONLINE    6 Active Sessions
SSH          ONLINE    Listening on port 22
OVIOS-WEB    OFFLINE   -
MULTIPATHD   OFFLINE   -
COCKPIT      OFFLINE   -
SMARTD       OFFLINE   -
S3           ONLINE    -
SMB          OFFLINE   -
CRON         OFFLINE   -
NTP          OFFLINE   -

ovios-shell ➤

Enabling iSCSI

ovios-shell ➤ options iscsi
option iscsi.address           None
option iscsi.debug             off
option iscsi.enable            off
option iscsi.port              3260
ovios-shell ➤ options iscsi.enable 1
Configuration iscsi.enable updated.
ovios-shell ➤ options iscsi
option iscsi.address           None
option iscsi.debug             off
option iscsi.enable            on
option iscsi.port              3260
ovios-shell ➤
ovios-shell ➤ service iscsi status
Service iscsi is: Running
ovios-shell ➤