mos-docs

MOS Docs

Welcome to the official documentation of MOS.

MOS is a lightweight operating system based on Devuan, designed specifically for small, energy‑efficient home servers.

The primary goal of MOS is to provide a simple, reliable, and low‑overhead platform for self‑hosting, virtualization, and homelab environments.

This project started as a personal solution, and at some point I decided to release it publicly to see if it resonates with others.
MOS is still evolving, but the core ideas are already in place.

---

🔒 Open Source & Privacy

MOS is and will always remain fully open source.

No data is collected. There is no telemetry, no tracking, and no usage reporting of any kind. Everything runs locally and stays fully under your control.

---

Target Audience

MOS is intended for:

• Homelab users
• Self‑hosters
• Developers
• Anyone looking for a minimal, efficient server OS with modern tooling

---

🏠 Introduction MOS

• Overview of the OS

• System Architecture

• Network Ports used by MOS

📦 Installation

• Releases / Changelog

• Create Bootable Media

• Testing MOS in a VM

🧭 Quick Start

• WebUI Overview

• Start Network Configuration

• Create a Storage Pool

• Start the First Container

• Create the First VM

• Create the First Shares

🚀 System Startup

• Pre-Start Script

• Post-Start Script

• Pool Mount Scripts

⚙️ System Management

🔁 System Updates

• OS Updates

• Rollback Procedures

💻 System Configuration

• System Settings

• Cron Jobs

• Reading Logs

• MOS HUB

• MOS Notify

🗂 Virtualization

• Docker Service

• LXC Service

• VM Service

🌐 Network

• Basic Configuration (DHCP, Static)

• Interfaces & Bonds

• Token

🌐 Hardware

• Drivers

• Boot

• Sensors

💾 Storage

📚 Storage Pools

• Creating Pools

🧲 Filesystems

• Supported Filesystems

📂 Shares

• SMB/NFS Configuration

• Access Control

• Attributes

🐳 Container

Docker

• Enable Docker

• Manage Images & Containers

• Logs & Monitoring

• Networking for Containers

• Volumes & Persistence

• Compose / Stack Management

LXC

• Create LXC Containers

• Snapshots & Backups

• Networking & Storage for LXC

🖥️ Virtual Machines

• Create VMs

• CPU & RAM Configuration

• Virtual Networks

• Virtual Disks

• GPU Passthrough

• USB Passthrough

• Snapshots

👤 User & Access Management

• Create Users

• Permissions & Roles

🔌 API

• API Overview

📦 Plugins

• MOS Plugin Repository

🏬 MOS Hub

• Creating Your Own MOS Hub Repository

📖 Advanced Usage

• Docker Local Host Access (Host Shim)

• Disable MD5 Verification

• Early Boot Script (boot.sh)

🔄 Migration

• Import Data from Other Systems

• Docker Import

• LXC Import

• VM Import

• Pool Migration

• Import Network Configuration

---

Repositories & Documentation

Related repositories and components of the MOS ecosystem:

MOS Documentation

• MOS Docs

Frontende and API

• MOS Frontend
• MOS API

Base OS:

• MOS Kernel
• MOS rootfs

Base Packages:

• MOS Docker
• MOS LXC
• MOS QEMU

MOS Specific Packages:

• MOS Notify
• MOS image-sha
• MOS mergerfs
• MOS SnapRAID
• MOS docker-watchdog

MOS Misc Custom Repositories:

• MOS Boot Files
• MOS GRUB

---

Parts of this documentation were created with the assistance of AI tool, all AI-generated content has undergone review, but it may still contain inaccuracies, omissions, or outdated information.

This site is open source. Improve this page.