Skip to main content

πŸš€ First Walkthrough

After creating the bootable media (Create Bootable Media) and starting the server for the first time, the console shows the IPv4 address assigned to the server:

root@MOS:~

MOS running MOS 0.6.2-stable - built on Devuan GNU/Linux

IPv4: 192.168.1.51

MOS Login: β–Š

No console login is required. Once the system is fully booted, open the WebUI at the displayed address, for example http://192.168.1.51/. The first start redirects to the setup wizard at /firstSetup.


1. πŸ” Root Password​

The first step is to set the root password. This password is used for SSH and console access to the server.

Root Password Setup

Enter and confirm the desired root password in the two input fields:

  • Root Password β€” Enter the root password
  • Confirm Root Password β€” Re-enter the same password for confirmation

Click Next to proceed to the next step.

note

The root password is required for direct system access via SSH or the physical console. The WebUI uses a separate login covered in the next step.


2. 🌐 Web Login & Settings​

The second step configures the WebUI administrator account and display preferences.

Web Login & Settings

Fill in the following fields:

  • Username β€” The WebUI administrator username
  • Web Password β€” Password for WebUI access
  • Confirm Web Password β€” Re-enter the same password for confirmation

Additional settings:

  • Samba User β€” Enable Samba access for this account (enabled by default)
  • Language β€” Select the display language (default: English)
  • Byte unit β€” Select byte unit format (default: Binary)
  • Theme β€” Select the interface theme: Auto, Light, or Dark (default: Auto)
  • UI Color β€” Choose the primary UI color from the palette

Click Finish to complete the initial setup.


3. πŸ”‘ Login​

After completing the setup wizard, you are redirected to the MOS Portal login screen.

Login Screen

A notification appears at the bottom confirming:

βœ… First setup successfully completed

Enter your credentials to log in:

  • Username β€” The WebUI administrator username configured in the previous step
  • Password β€” The WebUI password configured in the previous step

Click Login to access the MOS WebUI.


4. πŸ“Š Dashboard​

After logging in, you are taken to the MOS Dashboard which provides an overview of your system.

Dashboard

The Dashboard displays the following information:

  • OS β€” System information including platform, name, version, hostname, uptime, architecture, MOS version, channel, build, kernel, frontend, and API version
  • Processor β€” CPU details including brand, architecture, cores, temperature, and current load
  • System Load History β€” Current, 1-minute, 5-minute, and 15-minute load averages with a history graph
  • Pools β€” Storage pool status (currently showing "No pools available")
  • Network β€” Network interface information including type, state, IPv4 address, speed, and MAC address with a traffic graph
  • Memory β€” Memory usage statistics showing installed, usable, used, and free memory with a visual bar
  • Disks β€” Disk status (currently showing "No disks in pools available")

5. 🌐 Network Configuration​

One of the first settings to configure is the network interface. Click the menu icon (three horizontal lines) in the top-left corner to open the sidebar navigation.

Menu

Select Settings from the menu to access the system configuration page.

Settings

Navigate to Network β†’ Network Interfaces to configure your network adapter.

Network Interfaces

The Network Interfaces page allows you to configure:

  • Interface β€” The physical network interface (e.g., eth0)
  • Enabled β€” Toggle to enable or disable the interface
  • Type β€” Select the interface type (ethernet or bridged)
  • IPv4 DHCP β€” Toggle automatic IP assignment via DHCP
  • Enable IPv6 β€” Toggle IPv6 support
  • VLAN β€” Add VLAN interfaces with VLAN ID, MTU, and optional IPv4/IPv6 configuration
⚠️ Network Configuration Safety

When applying network changes, MOS protects you from accidental lockouts.

After applying a new network configuration:

  • MOS starts a 60 second confirmation timer
  • You must click Accept to confirm the new configuration

If the configuration is not confirmed within 60 seconds:

  • The previous network configuration will be automatically restored

This prevents losing access to the WebUI due to incorrect network settings.

For detailed network configuration options, including static IP assignment, VLANs, and advanced settings, refer to the Network Configuration documentation.


5.1 🌐 GitHub Token Setup​

To improve reliability and avoid GitHub API rate limits when downloading templates and containers, configure a GitHub Personal Access Token in MOS.

Settings β†’ Network β†’ Token

Example:

Token

GitHub Token Setup​

  1. Log in to GitHub
  2. Click your profile picture (top right)
  3. Select Settings
  4. Scroll down and open Developer settings
  5. Go to Personal access tokens
  6. Select Fine-grained tokens
  7. Click Generate new token
Recommended settings
  • Expiration: No expiration
  • Repository access: Public repositories (Read-only access to public repositories)

Token Usage in MOS​

  • Copy the generated token
  • Paste the token directly into the GitHub Token field in MOS (found under Settings β†’ Network β†’ Token)
Benefits
  • Avoids GitHub API rate limits
  • Improves reliability of template and container downloads

6. βš™οΈ System Settings​

The System Settings page contains essential system configuration options. Navigate to Settings β†’ System Configuration β†’ System to access these settings.

6.1 πŸ–₯️ General Settings​

System Settings - General

Configure basic system parameters:

  • Hostname β€” The system hostname (default: MOS)
  • Keymap β€” Keyboard layout for console access (default: us)
  • Timezone β€” System timezone (default: Europe/London)
  • CPU Governor β€” CPU frequency scaling policy (default: ondemand; falls back to performance if the CPU does not support it)
  • Global Spindown β€” Disk idle time before spin-down in minutes (default: 20)
  • Persist History β€” Toggle to preserve command history across reboots
  • Web UI HTTP Port β€” The port for the WebUI (default: 80)
  • Network Interfaces β€” Select which network interface to use for the WebUI

6.2 πŸ”Š Display & Notification Sound​

System Settings - Display

Configure display and notification behavior:

Update Settings:

  • Update Checks β€” Enable automatic update checking
  • Update Check Schedule β€” Define when update checks occur

Display Settings:

  • Powersave β€” Enable display power-saving mode
  • Powerdown β€” Time before display powers down in minutes (default: 60)
  • Timeout β€” UI inactivity timeout in minutes (default: 30)

Notification Sounds:

  • Sound on reboot β€” Play sound when system reboots
  • Sound on shutdown β€” Play sound when system shuts down
  • Sound on startup β€” Play sound when system starts

6.3 πŸ’Ύ Memory & Binary Format Settings​

System Settings - Memory

Configure memory management and binary format support:

Swapfile:

  • Enable Swapfile β€” Use a swap file for additional virtual memory
  • Swapfile Path β€” Location of the swap file
  • Swapfile Size β€” Size of the swap file
  • Swapfile Priority β€” Priority relative to other swap devices (default: -2)

Zswap:

  • Zswap Enabled β€” Compress memory pages before swapping
  • Shrinker Enabled β€” Enable the zswap shrinker
  • Zswap Max Pool Percent β€” Maximum memory percentage for zswap pool (default: 20)
  • Zswap Compressor β€” Compression algorithm (default: zstd)
  • Zswap Accept Threshold Percent β€” Threshold for accepting pages (default: 90)

Binfmt:

  • Enable Binfmt β€” Support for additional binary formats
  • Binfmt Architectures β€” Supported additional architectures

6.4 πŸ• Time & Proxy Settings​

System Settings - Time & Proxy

Configure time synchronization and network proxy:

Date & Time:

  • Currently β€” Shows the current system date and time
  • NTP Enabled β€” Enable network time synchronization
  • NTP Mode β€” Synchronization mode (default: iburst)
  • NTP Servers β€” List of NTP servers for time sync (default: 0.pool.ntp.org, 1.pool.ntp.org)

Proxy:

  • HTTP Proxy β€” HTTP proxy server address
  • HTTPS Proxy β€” HTTPS proxy server address
  • FTP Proxy β€” FTP proxy server address
  • No Proxy β€” Addresses/domains that bypass the proxy

For detailed information about all system settings, refer to the System Settings documentation.


7. πŸ›οΈ MOS Hub​

The MOS Hub is an integrated application hub similar to an app store for MOS. It provides access to plugins, Docker templates, and Docker Compose templates that can be deployed directly from the WebUI.

Navigate to Settings β†’ System Configuration β†’ MOS Hub Settings to configure the hub.

MOS Hub Settings

Configure the MOS Hub settings:

  • MOS Hub β€” Toggle to enable or disable the integrated MOS Hub
  • Initial Update β€” Toggle automatic refresh of repositories on each new session (login or new WebUI session)
  • Update Schedule β€” Define when the MOS Hub automatically updates using cron syntax (default: 15 7 * * * β€” every day at 07:15)

For detailed information about the MOS Hub, including how to deploy applications, refer to the MOS Hub documentation.


8. πŸ’Ύ Install to Disk​

If you installed MOS from a USB stick and want to permanently install it to an internal disk, use the Install to Disk option. Navigate to Settings β†’ Hardware β†’ Boot to access the boot configuration.

Boot Settings

Click Install to Disk to install the system bootloader and copy the /boot contents to a selected disk.

warning

After the installation finishes, shutdown or reboot your server immediately. All further changes after "Install to Disk" will not be saved.

The recommended procedure:

  1. Click Install to Disk and select your target device
  2. Shutdown your server
  3. Remove the old boot media (USB stick)
  4. Start your server
  5. Change the boot order in your BIOS if necessary to boot from the new disk

When clicking Install to Disk, you can configure:

  • Device β€” The target disk where the bootloader will be installed
  • Filesystem β€” The filesystem for the boot installation (ext4 recommended for HDD/SSD/NVME)
  • Extra Partition β€” Optionally create an additional partition for storage pools, Docker data, or shares
  • Set backup label on new device β€” Write the MOS backup label to the new boot device
  • Restore from file (MOS Backup) β€” Restore the boot configuration from a MOS Backup file (requires the MOS Backup Plugin)

For detailed information, refer to the Boot documentation.


9. πŸ”„ System Update​

The System Update option allows you to update the MOS firmware to a newer version. Navigate to Settings β†’ System β†’ Update system to access the update dialog.

Update System Dialog

The update dialog displays:

  • MOS Version β€” Currently installed version (e.g., 0.6.2-stable)
  • MOS Channel β€” Current update channel (e.g., stable)
  • MOS Kernel β€” Current kernel version (e.g., 6.18.60-mos)

Select your target firmware:

  • Channel β€” Choose the update channel:

    • alpha β€” Early access releases
    • beta β€” Pre-release versions
    • stable β€” Production-ready releases (recommended)
  • Release β€” Select the specific version to install:

    • latest β€” Most recent version in the selected channel
    • Or choose a specific version from the list (e.g., 0.6.2-stable, 0.6.1-stable, etc.)
  • Update Kernel β€” Toggle to include kernel updates with the firmware update

  • Update Plugins β€” Toggle to update installed plugins together with the firmware

Click Ok to start the update process, or Cancel to close the dialog without updating.

tip

It is recommended to check for updates regularly to ensure your system has the latest security patches and features.


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