Setup Guide
Before connecting to an SMB share, ensure the server is accessible and you have valid credentials configured.
Prerequisites
- An accessible SMB file server (Windows Server, NAS appliance, or Samba host) reachable over TCP port 445
- A configured SMB share on the server that your account has permission to access
- Either NTLMv2 credentials (username, password, and domain) or a Kerberos principal and keytab file
Configure NTLMv2 credentials
NTLMv2 is the default authentication method for most Windows and Samba environments.
- Identify the Windows domain or workgroup name. If no domain is in use, the domain is typically
WORKGROUP. - Create or locate a user account that has read/write access to the target share.
- Note the username, password, and domain — these map directly to the
credentialsfield in the connector configuration.
note
Domain-joined environments use the Active Directory domain name (e.g., CORP). Standalone Samba servers often use WORKGROUP or the server's own name.
Configure Kerberos authentication
Kerberos authentication is used in domain environments that require stronger mutual authentication.
- Obtain a Kerberos principal in
user@REALMformat (e.g.,[email protected]) from your domain administrator. - Request a keytab file for the principal, or confirm you can authenticate with a password.
- Locate the Kerberos configuration file (
krb5.conf) on the machine that will run the connector — typically at/etc/krb5.confon Linux. - Ensure the machine's clock is synchronized with the domain controller (Kerberos requires clocks to be within 5 minutes of each other).
Identify the share name and path
All paths used by the connector are relative to the configured share root.
- Connect to the server with a file explorer or
smbclientto confirm the share exists and is accessible. - Note the exact share name (e.g.,
reports) and the subdirectory paths you will read from or write to.
tip
Use smbclient -L //<server> -U <username> to list available shares on a server.
Next steps
- Action Reference - Available operations
- Trigger Reference - Event-driven integration