Skip to content

File Sharing SMB

gitsync edited this page Oct 4, 2026 · 2 revisions

SMB shares give Windows, macOS, and Linux clients access to your datasets over the network.

SMB Shares page

Creating a share

New SMB Share

Click + New Share and fill in:

Field Description
Name The share name clients will see
Path A dataset mountpoint (e.g. /mnt/tank/documents) — or a MergerFS union
Comment Optional description
Browseable Whether the share appears in network browsing
Guest OK Allow unauthenticated access
Time Machine macOS Time Machine target (with optional quota)
Recycle Bin Deleted files go to .recycle/ with configurable retention
Per-user access Read/Write or Read-Only per portal user

The portal writes the Samba configuration and reloads the service automatically.

Global Samba configuration

Click Configure to open global settings:

Setting Description
Workgroup Windows workgroup name (default WORKGROUP)
Server string Description shown in network browsing
Home dataset Dataset used for per-user home folders
TCP throughput socket options Adds TCP_NODELAY IPTOS_THROUGHPUT SO_RCVBUF=131072 SO_SNDBUF=131072 — best for Gigabit+ networks with large sequential transfers

Users, passwords, home folders

  • SMB uses its own password database, separate from the portal login. New portal users get their SMB password set automatically; admins can reset any SMB password from the share page, and users can change their own from their profile.
  • Enable SMB Home Folder on a user account to give them a personal directory under the home dataset — each user sees only their own.
  • The smb-only role creates users that can authenticate to Samba but cannot log into the portal — perfect for family members or scanners.

Active sessions

The SMB Shares page lists currently connected clients per share with client IP and username.

File Browser

Every share row's ⋮ menu includes Browse Files — manage the share's content right from the portal. See File Browser.

Connecting from clients

  • Windows: \\<server-ip>\documents in Explorer
  • macOS: Finder → Go → Connect to Server → smb://<server-ip>/documents
  • Linux: mount -t cifs //<server-ip>/documents /mnt/x -o username=alice

Related pages

Clone this wiki locally