SMB

In CloudMount

Local network only, or through a VPN. On recent Android versions, CloudMount needs the Nearby devices permission for this.
Names are case-insensitive.
CloudMount can find SMB servers on your local network that announce themselves.

At a glance

Capability	Support
rclone support tier	Tier 2: Stable
Checksums	None
Modification times	Kept, to 1 ms
Case-insensitive names	Yes
Duplicate names allowed	No
Server-side copy	No
Server-side move and rename	Yes
Folder move and rename	Yes, in one step
Free space reporting	Yes
Empty folders	Yes
Change notifications	No
Uploads of unknown size	Yes
Public links	No

SMB is a communication protocol to share files over network.

This relies on go-smb2 library for communication with SMB protocol.

command.) You may put subdirectories in too, e.g. remote:item/path/to/dir.

Notes

The first path segment must be the name of the share, which you entered when you started to share on Windows. On smbd, it’s the section title in smb.conf (usually in /etc/samba/) file. You can find shares by querying the root if you’re unsure (e.g. rclone lsd remote:).

You can’t access the shared printers from rclone, obviously.

You can’t use Anonymous access for logging in. You have to use the guest user with an empty password instead. The rclone client tries to avoid 8.3 names when uploading files by encoding trailing spaces and periods. Alternatively, the local backend on Windows can access SMB servers using UNC paths, by \\server\share. This doesn’t apply to non-Windows OSes, such as Linux and macOS.

Options

Standard options

The wizard asks for these when you add the drive.

host

SMB server hostname to connect to.

E.g. “example.com”.

Type: string · Required

user

SMB username.

Leave blank to use the current user name.

Type: string

port

SMB port number.

Type: int · Default: 445

pass

SMB password.

NB Input to this must be obscured - see rclone obscure.

Type: string

domain

Domain name for NTLM authentication.

Type: string · Default: WORKGROUP

spn

Service principal name.

Rclone presents this name to the server. Some servers use this as further authentication, and it often needs to be set for clusters. For example:

cifs/remotehost:1020

Leave blank if not sure.

Type: string

use_kerberos

Use Kerberos authentication.

If set, rclone will use Kerberos authentication instead of NTLM. This requires a valid Kerberos configuration and credentials cache to be available, either in the default locations or as specified by the KRB5_CONFIG and KRB5CCNAME environment variables.

Type: bool · Default: false

Advanced options

The wizard shows these under Advanced options. Most drives work without changing any of them.

idle_timeout

Max time before closing idle connections.

If no connections have been returned to the connection pool in the time given, rclone will empty the connection pool.

Set to 0 to keep connections indefinitely.

Type: Duration · Default: 1m0s

hide_special_share

Hide special shares (e.g. print$) which users aren’t supposed to access.

Type: bool · Default: true

case_insensitive

Whether the server is configured to be case-insensitive.

Always true on Windows shares.

Type: bool · Default: true

kerberos_ccache

Path to the Kerberos credential cache (krb5cc).

Overrides the default KRB5CCNAME environment variable and allows this instance of the SMB backend to use a different Kerberos cache file. This is useful when mounting multiple SMB with different credentials or running in multi-user environments.

Supported formats:

FILE:/path/to/ccache – Use the specified file.
DIR:/path/to/ccachedir – Use the primary file inside the specified directory.
/path/to/ccache – Interpreted as a file path.

Type: string

encoding

The encoding for the backend.

See the encoding section in the overview for more info.

Type: Encoding · Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot

description

Description of the remote.

Type: string