Local Volumes
Store files directly on vSAN, benefiting from inline deduplication and tiered storage placement
The VergeOS NAS (Network Attached Storage) service provides file-level storage and access within a VergeOS environment. Unlike traditional NAS appliances that require dedicated hardware, the VergeOS NAS runs as a VM-based service — a purpose-built virtual machine deployed from a standard recipe. This architecture means file services inherit all the benefits of the VergeOS platform: vSAN deduplication, snapshots, high availability, and multi-tenancy.
Each VergeOS system or tenant can run its own NAS service instance, providing isolated file storage with independent configuration, security policies, and share definitions.
Local Volumes
Store files directly on vSAN, benefiting from inline deduplication and tiered storage placement
Remote Volumes
Mount external NFS or CIFS file systems and present them as local resources within VergeOS
CIFS/SMB & NFS Shares
Expose volumes to clients via industry-standard file sharing protocols with granular access controls
VM Export Volumes
Export VM snapshots in portable formats for third-party backup or compliance workflows
The NAS service is not a kernel-level feature — it runs as a dedicated virtual machine provisioned from the built-in NAS VM Recipe. This VM hosts the Samba (CIFS/SMB) and NFS daemons, manages volume mounts, and handles authentication.
Key architectural points:
Setting up a NAS follows a clear sequence:
When creating a NAS service, you configure:
| Setting | Description |
|---|---|
| Name | Must be unique among all VMs in this VergeOS cloud |
| Cores / RAM | Default 4 cores / 4 GB — increase for heavy antivirus or sync workloads |
| Network | Internal or external network the NAS will be accessible on |
| IP Address Type | DHCP (recommended with static reservation) or Static |
| Hostname | Computer name (appears in AD if domain-joined); best to match the VM name |
| Domain | Required for CIFS/Samba — defaults to “workgroup” if left blank |
| Timezone / NTP | Defaults to system settings; critical for AD Kerberos authentication |
After submitting, power on the NAS service and verify it reaches Online status on the NAS Service dashboard.
Local volumes are EXT4 file systems stored within the VergeOS vSAN. They consume vSAN storage and benefit from inline deduplication, encryption (if enabled at the vSAN level), and tiered placement.
Navigate to NAS → Volumes → New and configure:
Once created, the volume appears on the NAS Service dashboard. Files can be browsed via the Browse option, and the volume must be exposed through shares for client access.
CIFS (Common Internet File System) shares provide file access for Windows, macOS, and Linux clients using the SMB protocol. Multiple shares can be created on a single volume with different security settings.
Navigate to NAS → Volumes, select a volume, then CIFS Shares → New:
| Setting | Description |
|---|---|
| Name | Share name visible to clients |
| Share Path | Subdirectory within the volume (blank = entire volume) |
| Valid Users | Restrict access to specific users (one per line) |
| Valid Groups | Restrict access to specific groups (one per line) |
| Allowed Hosts | IP, hostname, domain, netgroup, or subnet (one per line) |
| Denied Hosts | Explicitly block specific hosts |
| Read Only | Deny write operations |
| Browseable | Show in network share listings (disabled by default) |
| Admin Users | Users with full administrative access to the share |
| Force User / Force Group | Override connecting user identity for all file operations |
| Advanced Configuration Options | Raw Samba parameters for special-case scenarios |
NFS (Network File System) shares provide file access primarily for Linux and Unix clients. NFS shares are configured per-volume and offer fine-grained control over host access and identity mapping.
Navigate to NAS → Volumes, select a volume, then NFS Shares → New:
| Setting | Description |
|---|---|
| Name | Share identifier |
| Share Path | Subdirectory within the volume (blank = entire volume) |
| Allow Everyone | Grant access to all hosts |
| Allowed Hosts | IP, FQDN, or wildcard (e.g., *.companyabc.com) |
| Data Access | Read Only or Read and Write |
| User/Group Squashing | No Squashing (default), Squash Root (map root to anonymous), Squash All (map all users to anonymous) |
| Anonymous User ID / Group ID | UID/GID assigned to anonymous connections |
| Asynchronous | Improves performance but risks data loss on unclean server restart |
| No ACLs | Disable access control lists |
Remote volumes mount external NFS or CIFS file systems into the VergeOS NAS, making them accessible as if they were local. This is useful for:
//10.10.2.2/fshare or //file-01/corp)server01:/export/svrdata)After creation, verify the volume status shows Online on the volume dashboard. If mounting fails, check the Logs section at the bottom of the dashboard for error details.
The Verge.io VM Export volume type provides a controlled way to export VM snapshots for third-party backup, compliance, or portability purposes.
Each export produces timestamped folders containing VM snapshots. Export formats include:
.ybvm — VergeOS-native JSON-based format.ovf — Open Virtualization Format for broad compatibilityFor application-consistent exports, VMs must have the VergeOS Guest Agent installed. The guest agent coordinates with the operating system (VSS on Windows) to flush buffers and freeze the filesystem before the snapshot is taken.
VM exports are commonly automated using:
For environments with Windows Active Directory, the NAS service can join an AD domain using Winbind. This enables AD users and groups to authenticate against CIFS shares without maintaining separate credentials on the NAS.
| Setting | Description |
|---|---|
| Guest User Mapping | How to handle invalid credentials (reject, treat as guest) |
| Workgroup | Short-form domain name (e.g., COMPANYNAME) |
| Realm | Long-form domain name (e.g., companyname.local) |
| Server Type | Set to Member |
| AD Username / Password | Domain admin with object creation rights |
After joining, verify with the Winbind diagnostic tool (NAS dashboard → Diagnostics → Winbind):
wbinfo -t — test trust relationship with the domainwbinfo -u — list domain userswbinfo -g — list domain groupsCommon causes of join failures:
whoami on a domain member to confirm the short-form, and systeminfo for the full domainFor a new VergeOS deployment requiring file-level storage:
net use) and Linux (mount -t nfs / mount -t cifs)The VergeOS NAS service transforms file-level storage from a separate infrastructure concern into an integrated platform feature. By running as a VM recipe on the same vSAN that hosts all other workloads, the NAS benefits from deduplication, snapshots, and the full VergeOS operational model — while providing the CIFS/SMB and NFS interfaces that clients and applications expect.
| Volume Type | Storage Location | Use Case |
|---|---|---|
| Local (EXT4) | VergeOS vSAN | General file storage, home directories, application data |
| Remote CIFS | External SMB share | Data migration, backup ingestion, hybrid access |
| Remote NFS | External NFS export | Data migration, legacy integration |
| VM Export | VergeOS vSAN | Third-party backup, compliance, VM portability |