← All repositories

IceWhaleTechZimaOS

2,633
0
View on GitHub
2,633 stars116 forksShellUpdated 21d ago7viewswww.zimaspace.com/zimaos
nasoperating-systemos

ZimaOS

ZimaOS is a Linux-based NAS operating system built by IceWhaleTech on Buildroot, evolving from their CasaOS project. It ships as an installer image for any x86-64 UEFI machine — including ZimaBoard, ZimaBlade, ZimaCube, and generic Intel NUC hardware — with a web-based management dashboard, a curated Docker app store, and built-in RAID, remote access, file sharing, and virtualization features. The repo is the distribution channel for installer images; build sources live in the broader IceWhaleTech ecosystem.

Showcase

ZimaOS feature image
ZimaOS OverviewOpen
ZimaOS vs CasaOS differences
ZimaOS vs CasaOS DifferencesOpen
ZimaOS dashboard
Web DashboardOpen
RAID wizard
RAID Setup WizardOpen
Encryption folder overview
Encryption FolderOpen

Features

  • App Store with 800+ apps — one-click Docker container install; Jellyfin, Plex, Immich, Home Assistant, OpenWebUI, Pi-hole, Nextcloud, Paperless-ngx, Radarr, and more. Third-party community stores add hundreds more.
  • RAID 0 / 1 / 5 / 6 / JBOD — 3-click visual wizard; no CLI required. ZFS available via command line.
  • P2P remote access — Zima Client auto-configures encrypted P2P tunnels; no port forwarding, no cloud relay.
  • Cloud drive mounting — Google Drive, OneDrive, Dropbox mounted directly into the file manager alongside local disks.
  • SMB / NFS / iSCSI / DLNA — network file sharing for Windows, macOS, Linux, and DLNA-compatible TVs.
  • ZVM virtual machine — one-click Windows/Linux install inside the NAS OS; supports .img, .qcow2, .vmdk, .vdi images.
  • AES-256-GCM encrypted folders — self-developed Zima-OFS filesystem, timed auto-lock, non-recoverable by design (v1.5.4+).
  • Local LLM hosting — deploy DeepSeek R1, Ollama models, or OpenWebUI from the app store; GPU passthrough supported.
  • AI camera NVR — Frigate + Ollama for motion detection with natural-language scene descriptions.
  • 3-2-1 backup system — Zima Backup app covers local, LAN, and cloud destinations.
  • Thunderbolt DAS — direct attach at 20 Gbps on ZimaCube Pro (no extra config).
  • OTA and offline updates — Buildroot-based update mechanism, stable and rollback-capable.
  • 28 languages — UI localised by community contributors.
  • Multi-user — folder-level access control, local-only account system (no email/phone registration).
  • Proxmox VE installation — ISO image available for VM deployment in homelab environments.
  • Pricing — Free (4 disks, 3 users); Plus $29 lifetime (unlimited disks and users).

Documentation

Quick start

# 1. Download the installer image from GitHub Releases
#    https://github.com/IceWhaleTech/ZimaOS/releases/latest
# 2. Flash to USB with Balena Etcher
# 3. Boot target x86-64 machine from USB in UEFI mode
# 4. Follow on-screen installer, select target disk, reboot
# 5. Install ZimaClient on laptop to auto-discover and connect
#    https://find.zimaspace.com/

Tags

Maturity
BetaBetaActively developed but pre-1.0 — no stable release tagged yet.View all repositories tagged
Persona
DevOps EngineerDevOps EngineerEngineers deploying containerized services and managing infrastructure.View all repositories taggedHomelab EnthusiastHomelab EnthusiastSelf-hosters and homelab builders running personal servers at home.View all repositories tagged
License Category
UnknownUnknownNo LICENSE file detected and no licenseInfo from the GitHub API.View all repositories tagged
Built With
CasaOSCasaOSDerived from CasaOS, adding system-level NAS features on top.View all repositories taggedBuildrootBuildrootOS image built using the Buildroot embedded Linux build system.View all repositories tagged
Security Posture
UnratedUnratedOSSF Scorecard has not yet scanned this repository — security posture is unknown.View all repositories tagged
Maintainer Model
Company-backedCompany-backedDeveloped and funded by a commercial company.View all repositories tagged
Form Factor
NAS OSNAS OSA complete operating system for Network Attached Storage devices.View all repositories tagged
Platform
WebWebRuns in the browser — renders to DOM/SVG/Canvas in a web page.View all repositories taggedServerServerRuns on server or bare-metal hardware, not a hosted cloud service.View all repositories tagged
Use case
Data Backup StrategyData Backup StrategyWhen I'm worried about losing irreplaceable photos and documents, I want a NAS with built-in RAID and a 3-2-1 backup tool that covers local, LAN, and cloud destinations, so I have multiple copies of my data with minimal setup.View all repositories taggedSelf-Hosted Media ServerSelf-Hosted Media ServerWhen I have a large library of movies and TV shows on external drives, I want to self-host a media server on my own hardware, so I can stream content to any screen in my home or remotely without a subscription fee.View all repositories taggedHome Surveillance NVRHome Surveillance NVRWhen I have IP cameras at home and want to record and analyze footage locally, I want to deploy an NVR on my NAS with optional AI scene descriptions, so I don't have to pay cloud camera subscription fees and my footage stays private.View all repositories taggedSelf-Hosted Photo BackupSelf-Hosted Photo BackupWhen I want to stop paying for Google Photos and keep my photos private, I want to run Immich on my own NAS, so I can have auto-upload, facial recognition, and map views without my data leaving my home.View all repositories taggedLocal LLM AssistantLocal LLM AssistantWhen I want to experiment with large language models without sending my data to the cloud, I want to deploy an LLM locally on my NAS hardware, so I can have a private AI assistant accessible across my home network.View all repositories taggedPrivate Cloud StoragePrivate Cloud StorageWhen my files are scattered across Google Drive, Dropbox, and multiple devices, I want a personal NAS that mounts all cloud services and local storage in one file manager, so I can manage everything from one interface and migrate data between providers.View all repositories taggedNetwork-Wide Ad BlockingNetwork-Wide Ad BlockingWhen I want to block ads for every device on my home network without configuring each device individually, I want to run Pi-hole on my NAS as a DNS server, so all devices automatically have ad blocking without browser extensions.View all repositories taggedHome NAS ServerHome NAS ServerWhen I want to store all my files in one place accessible from any device at home, I want to run a personal NAS OS with a friendly web interface, so I can access movies, photos, and documents without relying on cloud subscriptions.View all repositories taggedSmart Home HubSmart Home HubWhen I want to run Home Assistant for smart home control without depending on cloud services, I want a NAS OS where I can install Home Assistant with one click alongside my other self-hosted apps, so my home automation keeps working even without internet.View all repositories taggedDocker App HomelabDocker App HomelabWhen I want to self-host productivity apps like Nextcloud, Pi-hole, and Paperless-ngx, I want a NAS OS with a one-click app store that handles Docker configuration automatically, so I can run these services without learning Docker CLI.View all repositories tagged
Ecosystem
LinuxLinuxBuilt on the Linux kernel; uses Linux subsystems and tooling.View all repositories taggedDockerDockerRuns and manages Docker container workloads.View all repositories tagged
Status
ActiveActiveReceives recent commits and releases, issues are being addressed.View all repositories tagged
Features
Local LLM HostingLocal LLM HostingDeploy and run large language models locally via Ollama and OpenWebUI.View all repositories taggedAI Camera NVRAI Camera NVRNetwork video recorder with AI object detection and natural-language scene descriptions.View all repositories taggedVirtual Machine HostVirtual Machine HostBuilt-in KVM-based VM manager with one-click Windows and Linux install.View all repositories taggedZFS SupportZFS SupportZFS filesystem available via CLI for advanced storage configurations.View all repositories taggedFolder EncryptionFolder EncryptionAES-256-GCM encrypted folders with timed auto-lock.View all repositories taggedP2P Remote AccessP2P Remote AccessEncrypted peer-to-peer remote access without port forwarding or cloud relay.View all repositories taggedOTA UpdatesOTA UpdatesOver-the-air system updates with offline update fallback.View all repositories taggedMulti-User Access ControlMulti-User Access ControlFolder-level permissions for multiple users on a shared NAS device.View all repositories taggedSMB / NFS / iSCSI SharingSMB / NFS / iSCSI SharingNetwork file sharing via SMB, NFS, iSCSI, and DLNA protocols.View all repositories taggedDocker App StoreDocker App StoreCurated one-click Docker container app store with 800+ applications.View all repositories taggedCloud Drive IntegrationCloud Drive IntegrationMount Google Drive, OneDrive, Dropbox alongside local disks in a unified file manager.View all repositories taggedRAID ManagementRAID ManagementGUI-based RAID 0/1/5/6/JBOD setup and management without CLI.View all repositories tagged

Documentation

21 pages indexed · 1,485 words
  • READMEZimaOS README — Public Evaluation Programgithub.com/IceWhaleTech/ZimaOS/blob/main/README.md

    ZimaOS is evolved from CasaOS. Built using Buildroot with stable OTA update functionality. Supports ZimaBoard, ZimaBoard2, ZimaBlade, ZimaCube, and generic x86-64 with UEFI.

    Distribution Features:

    • Lightweight and memory-efficient
    • Minimized I/O
    • Over The Air (OTA) updates
    • Offline updates
    • Better disk management capabilities

    Installation: Download installer image, flash with Balena Etcher to USB, boot from USB in UEFI mode, install to target disk. Also installable on Proxmox VE.

  • Welcome to Zima Space — ZimaOS Overviewwww.zimaspace.com/docs/zimaos

    ZimaOS is a full personal cloud OS developed by the Zima team based on CasaOS. It is a complete operating system with system-level support for remote access, RAID configuration, and essential features like OTA updates. Designed for ZimaCube, focusing on stability, unified data management, and local LLM capabilities.

    Unlike traditional NAS devices that often feature complex setups, ZimaOS offers a sleek and elegant design philosophy, tailored for home and SOHO environments. The CasaOS community has grown to include over 20,000 Discord community users. The store features hundreds of third-party applications covering media servers, music servers, downloaders, web scrapers, web servers, git servers, smart home technologies, and more.

    Key insight: CasaOS serves as a personal cloud application hub enabling easy deployment. ZimaOS builds on this to establish a robust, complete operating system featuring RAID setup, remote access, a cloud-like file manager, automatic backups, and unified management of cloud and NAS data.

  • ZimaOS — A Simplified, Focused and Open NAS OSwww.zimaspace.com/zimaos

    ZimaOS: A Simplified, Focused and Open NAS OS. Supports all X86-64 hardware.

    Core capabilities:

    • File management: mount cloud drives (Google Drive, OneDrive, Dropbox), USB drives, mobile backups, LAN/WAN access, Thunderbolt DAS support
    • RAID: JBOD, RAID 0, 1, 5, 6 supported. Setup in 3 clicks.
    • Remote Access: P2P encrypted, no cloud relay, auto-configured via Zima Client
    • App Store: 800+ apps, one-click Docker container install, third-party stores
    • ZVM: built-in virtual machine — one-click Windows/Linux install
    • Backup: 3-2-1 backup strategy, cross-cloud/local/LAN backup
    • Privacy: local account system, no email/phone required, P2P networking, AES-256-GCM encrypted folders (v1.5.4+)
    • Multi-user: folder-level access control for families/small teams
    • 28 languages supported, 43,000+ community members
    • Free tier: core features, 4 disks, 3 members. Plus: $29 lifetime, unlimited disks/users.
  • Get Started with ZimaOSwww.zimaspace.com/docs/zimaos/get-started.html

    ZimaOS design focuses on simplicity and language consistency. The Zima client application establishes all connections between laptop/iMac and ZimaCube, providing foundation for access, high-speed transfers, and remote experiences.

    Key features covered in onboarding:

    • File management system
    • App store and installable applications
    • Device management and network settings
    • Multiple RAID types

    Remote Access: Once you install the Zima Client application and scan to connect to ZimaOS for the first time, your remote access channel is already set up. P2P communication, data encrypted end-to-end. No additional configurations necessary.

    Samba Share: Right-click any folder in Files to create a LAN share. Combined with Zima Client remote access, enables remote editing of files.

    Cloud Storage Integration: Add Google Drive, Dropbox, OneDrive, or local Samba shared folders with one click.

    RAID: RAID 0, RAID 1, RAID 5 supported natively. ZFS available via system-level interfaces.

    ZVM: Virtualization — use NAS as Windows desktop host, Debian dev environment, or routing system.

    App Store: 100+ privatized apps including Plex, Jellyfin, Home Assistant, Homebridge, OpenWeb UI, Stable Diffusion.

  • Features — Build Data Stationwww.zimaspace.com/docs/zimaos/features.html

    Remote Access: P2P communication using Network ID, encrypted data transfer. Access from anywhere without cloud forwarding or data leakage.

    Shared Storage: Storage types: USB, Single Disk, RAID. ZimaOS supports SMB multi-user configuration with read/write permissions. After sharing, provides connection address for Mac/Windows connection.

    App Store: One-click installation — port mapping and path settings handled automatically. App store includes nearly 100 official apps + 8 third-party stores with ~500 more apps. Categories: video, album management, backup, file systems, team collaboration, ad blocking. Custom installation via Docker Hub YAML import also supported.

  • Remote Access — Data On-the-Gowww.zimaspace.com/docs/zimaos/remote-access.html

    ZimaOS remote access uses P2P communication via Zima Client app. After first successful connection, device automatically saves connection information. No additional configurations needed for subsequent remote access. Connect via Network ID for second-device access scenarios. Data transfer between laptop and ZimaCube is encrypted, ensuring peer-to-peer data transmission.

  • RAID Options in ZimaOSwww.zimaspace.com/docs/zimaos/raid-options.html

    ZimaOS supports: RAID 0 (speed/capacity, no redundancy), RAID 1 (mirroring, high safety), RAID 5 (balanced — performance, capacity, single-disk failure tolerance), RAID 6 (dual parity, two-disk failure tolerance), JBOD (flexible, maximum capacity, no redundancy).

    Complex RAID configurations simplified into 3-step visual wizard — no commands or configuration files. ZFS also supported for advanced needs. Recommended to pair with 3-2-1 backup strategy.

  • Cloud Drive Integration — Seamless Cloud and Edge Data Managementwww.zimaspace.com/docs/zimaos/cloud-drive-connect.html

    ZimaOS cloud integration: connect Google Drive, OneDrive, and Dropbox into single unified interface. Unified Data Access — access all cloud data from ZimaOS, reducing time managing multiple accounts. Local mounting of cloud drives improves data access speed. Supports batch migration between cloud providers. Multi-device synchronization — edit on one device, sync to NAS automatically.

  • How to Install ZimaOSwww.zimaspace.com/docs/zimaos/how-to-install-zimaos.html

    ZimaOS is a lightweight NAS operating system designed for generic x86-64. Requirements: x86-64 device with at least 25GB storage, USB drive (4GB+), UEFI boot mode enabled, Secure Boot disabled.

    Installation steps:

    1. Download .img installer from GitHub Releases
    2. Flash to USB with Balena Etcher
    3. Boot from USB in UEFI mode
    4. Select target disk, confirm installation
    5. Remove USB, reboot to ZimaOS
    6. Access via ZimaClient or web browser at device IP

    Also installable on Proxmox VE via ISO image.

  • Install ZimaOS on Proxmox VEwww.zimaspace.com/docs/zimaos/install-zimaos-on-proxmox-ve.html

    ZimaOS ISO image can be deployed as a virtual machine on Proxmox VE (PVE). Supports PVE 6.x/7.x/8.x/9.x. Requires: x86_64 CPU with virtualization, 2+ CPU cores, 4GB+ RAM, 32GB+ storage, UEFI/OVMF VM BIOS.

    Ideal for testing, learning, evaluation, and lightweight usage scenarios. Advantages: faster setup, easy environment replication via snapshots, flexible resource allocation.

  • Encryption Folder in ZimaOSwww.zimaspace.com/docs/zimaos/folder-encryption.html

    Available from v1.5.4. ZimaOS uses self-developed filesystem based on Zima-OFS with AES-256-GCM encryption. Streaming encryption/decryption for dual-layer protection.

    Features: original directory experience (looks like normal folder), performance-oriented design (batch write optimization, large file chunking), cross-device auto-recognition, timed auto-lock.

    Non-recoverability by design: bucket metadata keys exist only in original config files. Rebuilding database or reinstalling system cannot restore access. ZimaOS does not upload, back up, or retain any user encryption keys.

  • Deploy DeepSeek R1 on ZimaOSwww.zimaspace.com/docs/zimaos/deploy-deepseek-r1.html

    ZimaOS supports one-click deployment of local LLMs via OpenWebUI + Ollama from the App Store. Example: Deepseek R1:14B requires GPU with 16GB+ VRAM. Install OpenWebUI from App Store, pull model from Ollama.com, chat interface immediately available across all local network devices.

    'Installation as easy as a mobile app, deploy once and use everywhere.' ZimaCube Pro Creator Pack comes with NVIDIA RTX 2000 Ada GPU (16GB VRAM) pre-installed with ZimaOS. Supports edge AI use cases: knowledge management, creative brainstorming, programming assistance, smart home control.

  • Frigate + Ollama AI Camera Surveillance on ZimaOSwww.zimaspace.com/docs/zimaos/frigate-ollama-setup.html

    ZimaOS supports deploying Frigate NVR combined with Ollama LLaVA model for AI-powered camera surveillance with natural language descriptions. Frigate identifies targets (people, cars, animals) in RTSP camera streams. Ollama generates natural language descriptions of detected events.

    Requirements: RTSP cameras, GPU for inference, 6GB+ storage for AI models. Installation via App Store (Ollama) + custom Docker Compose YAML import (Frigate). Use case: home security with AI scene descriptions, NVR with semantic search.

  • NFS File Sharing on ZimaOSwww.zimaspace.com/docs/zimaos/nfs-on-zimaos.html

    ZimaOS supports SAMBA (GUI + CLI), NFS (CLI, v1.3.2+), and FTP protocols. NFS configuration via /etc/exports — works on ZimaOS/Ubuntu, macOS, Windows 11. SMB multi-user configuration with read/write permissions available via admin panel. iSCSI also supported for virtualized storage environments.

  • iSCSI Storage on ZimaOSwww.zimaspace.com/docs/zimaos/iscsi-guide.html

    ZimaOS supports iSCSI (Internet Small Computer System Interface) for transmitting SCSI commands over network. Use cases: data centers, virtualized environments, backup and recovery. Supports LUN creation, iSCSI target setup, ACL access control. Available from ZimaOS 1.2.5+. Clients: Windows iSCSI Initiator, Linux iscsiadm.

  • Pi-hole Deployment on ZimaOSwww.zimaspace.com/docs/zimaos/pi-hole-setup.html

    ZimaOS App Store includes Pi-hole — network-level ad blocking via DNS. One-click install from App Store. Configure router DNS to ZimaOS IP for network-wide ad blocking. Supports DNSSEC. Pi-hole deploys as Docker container within ZimaOS.

  • Migrate from CasaOS to ZimaOSwww.zimaspace.com/docs/zimaos/casaos-to-zimaos-migration.html

    Migration from CasaOS to ZimaOS: three-stage process. 1) File Transfer via LAN sharing (SMB) — supports TrueNAS, Unraid, Synology DSM, macOS SMB shares. 2) App Migration via CTOZ open-source tool — one-click migration of Docker containers and AppData, including Jellyfin/Immich configs. 3) Advanced system configurations require manual reconfiguration.

    ZimaOS is also Docker-based, accepts Docker Compose YAML import. CasaOS must be ≥0.4.4 for CTOZ compatibility.

  • Migrate from Synology to ZimaCubewww.zimaspace.com/docs/zimaos/synology-to-zimacube-migration.html

    ZimaOS is compatible with SMB/SAMBA sharing from Synology DSM. Migration: connect Synology as network device via SMB in ZimaOS Files, then copy/paste or use Migrate function. Both ZimaOS and Synology DSM use SMB, making file sharing and transfer straightforward.

  • ZimaOS v1.5.1 Release Noteswww.zimaspace.com/docs/zimaos/v-1-5-1.html

    v1.5.1 focuses on stability. Fixes: RAID name with spaces display, docker image pull strategy, disk display on RAID creation, NTFS migration, ZVM Arch/Debian image links. Optimizations: root directory selection in backups, improved Docker image pull strategy, faster new version pulling.

  • ZimaOS V1.5.0 Release Noteswww.zimaspace.com/docs/zimaos/v-1-5-0.html

    ZimaOS hits 1,000,000+ downloads. New: Zima Backup app with powerful backup features, app start/stop status display on launch panel, GPU allocation option in App Settings. Fixed: timezone display, app memory limit display, cloud storage retrieval speed, search memory consumption. 43,000 community members on Discord.

  • How to Watch Videos Anywhere with Jellyfin Media Serverwww.zimaspace.com/docs/zimaos/media-server-setup-with-jellyfin.html

    Set up Jellyfin as a self-hosted media server on ZimaOS to stream movies, TV shows, and music to any device on your home network. Install via the Docker app store; configure libraries, transcoding, and remote access. Replaces Plex/Netflix-style streaming with a private, self-hosted media server. Supports HEVC, H.264, web/mobile/TV clients.