SMB / Windows shares

Mount an SMB share served by a NAS, Windows, or Samba, with file reads, writes, and directory management.

Adapter type: smb. See Common configuration for mounting instructions.

Setup

Enable SMB, create a share, and grant both share and filesystem permissions to the account.
For \\nas.example.com\media\movies, set server: nas.example.com, share: media, and root: /movies.
Make sure Foxel can reach TCP port 445. Mounting the share on the host first is unnecessary.

Configuration

Field	Type	Required	Default	Description
`server`	string	Yes	—	SMB hostname or IP without smb://, share name, or slashes.
`share`	string	Yes	—	Share name, for example media.
`port`	number	No	`445`	Service port.
`username`	string	No	—	Remote account username.
`password`	password	No	—	Remote account password.
`root`	string	No	`"/"`	Directory on the backend, separate from the mount path displayed in Foxel.
`timeout`	number	No	`30`	Request or connection timeout in seconds.

Example

This is a config object. In the admin form, fill the corresponding fields rather than pasting the whole object. Replace credential placeholders with your own values.

json

{
  "server": "nas.example.com",
  "share": "media",
  "port": 445,
  "username": "foxel",
  "password": "YOUR_PASSWORD",
  "root": "/movies",
  "timeout": 30
}

Behavior and limitations

server and share must be individual path components without slashes or a full UNC path.
root is a directory inside the share; / exposes the share root.
Leave credentials blank only if the server permits guests. Domain accounts can use DOMAIN\user as the username.

Troubleshooting

Timeout: check container DNS, routing, and port 445 on the server firewall.
Share not found: use the share name, rather than the NAS volume name or a full folder path.
Access denied: check both SMB share permissions and filesystem ACLs.

References

External documentation provides service and authorization context. Use this page and the current Foxel adapter for configuration fields and limitations.