Network Drive Connector #

Register Network Drive Connector #

curl -XPUT "http://localhost:9000/connector/network_drive?replace=true" -d '{
  "name": "Network Drive Connector",
  "description": "Scan and extract metadata from network shared files.",
  "category": "cloud_storage",
  "icon": "/assets/icons/connector/network_drive/icon.png",
  "tags": [
    "filesystem",
    "storage",
    "web"
  ],
  "url": "http://coco.rs/connectors/network_drive",
  "assets": {
    "icons": {
      "default": "/assets/icons/connector/network_drive/icon.png"
    }
  },
  "processor": {
    "enabled": true,
    "name": "network_drive"
  }
}'

Use network_drive as a unique identifier, as it is a builtin connector.

Use the Network Drive Connector #

The Network Drive Connector allows you to index data from your SMB/CIFS shares into your system. Follow these steps to set it up:

Configure Network Drive Client #

To configure your Network Drive connection, you’ll need to provide the server details and credentials. This setup allows your application to securely authenticate with and access files within a specified network share.

First, you’ll need your server information and credentials:

endpoint: This is the IP address and port of your SMB server (e.g., 192.168.1.100:445).

share: This is the name of the shared folder you want to access.

username: The username for authenticating to the share.

password: The password for the specified user.

domain: (Optional) The domain for NTLM authentication, often WORKGROUP.

Next, you can specify which folders and files to index:

paths: An array of strings representing the subdirectories to scan within the share. If you want to scan the entire share, you can use ["."] or [""].

extensions: An array of strings defining specific file extensions to include (e.g., ["pdf", "docx"]). If this list is empty or omitted, all file types in the specified paths will be considered.

Datasource Configuration #

Each datasource has its own sync configuration and Network Drive settings:

curl -H 'Content-Type: application/json' -XPOST "http://localhost:9000/datasource/" -d '{
    "name": "My Shared Documents",
    "type": "connector",
    "enabled": true,
    "connector": {
        "id": "network_drive",
        "config": {
            "endpoint": "your-smb-server:445",
            "share": "documents",
            "username": "your-username",
            "password": "your-password",
            "domain": "WORKGROUP",
            "paths": ["."],
            "extensions": ["pdf", "docx", "txt"]
        }
    },
    "sync": {
        "enabled": true,
        "interval": "5m"
    }
}'

Supported Config Parameters for Network Drive Connector #

Below are the configuration parameters supported by the Network Drive Connector:

Datasource Config Parameters #