Only this pageAll pages
Powered by GitBook
Couldn't generate the PDF for 112 pages, generation stopped at 100.
Extend with 50 more pages.
1 of 100

Couchdrop Knowledge Base

Loading...

Features

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Connections

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Administration

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Walkthroughs

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Inbound FTPs

Learn about Inbound FTP and FTPs with Couchdrop

Couchdrop acts as an FTP and FTPs server out of the box.

Introduction to FTP

File Transfer Protocol (FTP) is one of the oldest methods of moving files between computers over a network. It uses a client-server model where users connect to an FTP server to upload, download, or manage files.

While simple and widely supported, traditional FTP sends data - including usernames and passwords - in plain text, making it insecure by modern standards.

For this reason, secure alternatives such as FTPS (FTP over SSL/TLS) or SFTP (SSH File Transfer Protocol) are often preferred.

Despite its limitations, FTP is still used in many legacy systems and workflows because of its simplicity and broad compatibility.

FTP in Couchdrop

Couchdrop gives you FTP without the servers. In minutes, you can spin up secure, cloud-hosted FTP endpoints that connect directly to your existing storage like Dropbox, Google Drive, OneDrive, or S3. Your partners still use FTP exactly as they always have - but you get cloud-native flexibility, enterprise-grade security, and zero infrastructure to manage. It’s the simplest way to modernize FTP​

Getting Started with Couchdrop

Inbound FTP is supported by default in Couchdrop accounts - but you will need to configure FTP users for access.​

Others

Connect Providers/Partners

Enabling FTPs

Learn about enabling FTP access to Couchdrop

Unlike SFTP, FTP is disabled by default in Couchdrop. This is because FTP is comparitively buggy and insecure and so we do not recommend using it where there are other options.

Enabling FTPs

To enable FTPs access, you must be an administrator or the owner in Couchdrop.

  • Login to Couchdrop's web app

  • Click SFTP Server

  • Click FTP Connectivity

  • Click Enable FTP

This setting will activate immediately.

Users will need to be authorised to access Couchdrop via FTP

Connect IPaaS

Learn about connecting Couchdrop to IPaaS platforms

HTTP

Logging and Debugging

Learn about logging and debugging with regards to Windows file servers

The Windows agent has a collection of logfiles that can be useful for debugging issues. Our support team might also ask for them from time to time.

You can find the default location for the logs here:

C:\Users\%username%\AppData\Local\CouchdropCloudConnector

You can also jump directly to the local logs and configuration file within the settings (gear) within the Couchdrop agent.

Welcome

Couchdrop is the leading Cloud SFTP server delivered as a SaaS platform. Learn all about Couchdrop with our Documentation here

Getting Started

Most Couchdrop users are interested in one core feature of Couchdrop

Common Questions

Box

Learn how to configure a connection to Box with Couchdrop

Introduction

Connecting to Box is fast to set up and fully supported in Couchdrop.

Requirements

To connect to Box in Couchdrop you will need:

  • A licensed Box account

  • Access as a Team Admin (if connecting to other Box users in the organization)

Configuration Steps

  1. Log in to Couchdrop and add a new storage connection

  2. Provide a name for the connection. This is how the Box connection will appear in Couchdrop

  3. Select Box from the list of available connections

  4. Choose Authorize Now and grant access to Couchdrop. Check "As Team Admin" if you wish to connect to folders from other users in the organization

Egnyte

Learn how to connect Couchdrop to Egnyte

Introduction

Connecting to Egnyte is fast to set up and fully supported in Couchdrop.

Requirements

To connect to Egnyte in Couchdrop you will need:

  • A licensed Egnyte account

  • A folder in Google Drive

  • Your Egnyte Domain

Configuration Steps

  1. Log in to Couchdrop and add a new storage connection

  2. Provide a name for the connection. This is how the Egnyte connection will appear in Couchdrop

  3. Select Egnyte from the list of available connections

  4. Type in your Egnyte domain without egnyte.com (yourdomain.egnyte.com)

Amazon S3

Learn how to configure a connection to Amazon S3 with Couchdrop

Introduction

Connecting Couchdrop to an Amazon S3 bucket is done using an IAM keyset. It can be completed in a few minutes if you have the right access in AWS.

Requirements

To connect to Amazon S3 in Couchdrop you will need:

  • An S3 Bucket already configured

  • An AWS IAM Key

  • An AWS IAM Secret

  • The AWS region

Configuration Steps

  1. Log in to Couchdrop and add a new storage connection

  2. Select Amazon S3 from the list of available connections

  3. Provide the details above

  4. Click Test Connection

Inbound SFTP

Learn about using Couchdrop as an SFTP server.

Couchdrop acts as an SFTP server out of the box and supports thousands of users in a single tenant and Petabytes of data through our cloud storage integrations.

Introduction to SFTP

Secure File Transfer Protocol (SFTP) is a secure and reliable method of transferring files between systems over a network. Unlike traditional FTP, which sends data in plain text, SFTP encrypts both authentication credentials and file data using the Secure Shell (SSH) protocol. This ensures that sensitive information remains protected during transit.

SFTP in Couchdrop

Couchdrop gives you SFTP without the servers. In minutes, you can spin up secure, cloud-hosted SFTP endpoints that connect directly to your existing storage like Dropbox, Google Drive, OneDrive, or S3. Your partners still use SFTP exactly as they always have — but you get cloud-native flexibility, enterprise-grade security, and zero infrastructure to manage. It’s the simplest way to modernize SFTP

Getting Started with Couchdrop

Inbound SFTP is enabled by default in Couchdrop accounts - but you will need to configure SFTP users for access.

OneDrive

Learn how to connect Couchdrop to a OneDrive folder

Introduction

Couchdrop can be connected to a OneDrive folder in a few simple steps. Couchdrop works with Personal OneDrive accounts and SharePoint Sites.

To connect to SharePoint, see SharePoint

Requirements

To connect a personal OneDrive folder in Couchdrop you will need:

  • A licensed OneDrive Account

  • A folder in OneDrive

Configuration Steps

  1. Log in to Couchdrop and add a new storage connection

  2. Select OneDrive from the list of available connections

  3. Choose whether or not to connect as an Administrator User,

  4. Click Authorize Now. This will open a page to connect to Microsoft via OAuth. Click Accept.

Azure Files

Learn how to configure a connection to Azure Files with Couchdrop

Introduction

Connecting to Azure Files online is fast to set up and fully supported in Couchdrop.

Requirements

To connect to Azure Files online in Couchdrop you will need:

  • Azure Account Name

  • Azure Secret Key

  • Azure Share Name

To learn how to configure Azure - you can visit

Configuration Steps

  1. Log in to Couchdrop and add a new storage connection

  2. Select Azure Files from the list of available connections

  3. Provide your account name, secret and share name.

  4. Click Test Connection

Dropbox

Learn how to connect Couchdrop to Dropbox

Introduction

Connecting to Dropbox is fast to set up and fully supported in Couchdrop. Couchdrop can connect to both Dropbox Personal and Dropbox Business accounts.

Requirements

To connect to Dropbox in Couchdrop you will need:

  • A licensed Dropbox account

  • Access to an Admin account to connect to Couchdrop (if connecting to Dropbox Business)

Configuration Steps

  1. Log in to Couchdrop and add a new storage connection

  2. Provide a name for the connection. This is how the Dropbox connection will appear in Couchdrop

  3. Select Dropbox Personal or Dropbox Team from the list of available connections

  4. Choose Authorize Now and grant access to Couchdrop.

Virtual Folders

Virtual folders form the basis for how Couchdrop works. They are a key concept and once you understand them - the real power behind Couchdrop will become obvious.

Overview and Introduction

Couchdrop is not a fileserver - but it has some traits of one. Everything in Couchdrop starts as a folder. But folders themselves are abstract and do not necessarily live inside Couchdrop.

When you connect Couchdrop to Sharepoint or any one of the other over 50 platforms we support - you provide a folder name. This folder name acts as a filesystem location in Couchdrop.

Browsing that folder in the filesystem will not show the contents of Couchdrop - rather the files and folders that live in that external platform.

Uploading a file to that folder - via any means - will result in Couchdrop transferring the file to that provider or platform rather than the file living in Couchdrop.

Thus - to send a file to an external SFTP provider - you would simply upload it to the right folder inside Couchdrop.

File Actions

Learn about file actions in Couchdrop

Introduction

File Actions allow certain actions to occur when a file is uploaded or downloaded to Couchdrop. These can be connected to other ingestion and sharing methods including Mailboxes, Shared Links, AS2 Stations, and SFTP uploads and downloads.

File Actions are built using the .

Windows / Mac File Server

Learn how to connect Couchdrop to a Windows or OSX File Server

Introduction

Couchdrop supports Microsoft Windows and Apple OSX using a lightweight agent that is installed directly on the file server, another server, or on a virtual machine.

The agent uses a shared token for authentication and communicates with Couchdrop's infrastructure via secure HTTPS calls. The agent can be run in a standalone fashion or .

Google Workspace

Learn how to connect Couchdrop to a Google Workspace account

Introduction

Couchdrop can be connected to a Google Workspace by creating a service account, which Couchdrop can do for you automatically. Couchdrop works with both Personal Google Drive accounts and Google Workspace accounts.

To connect to a personal Google Drive account, see

Troubleshooting

Learn about the reporting Couchdrop provides around transfer automations

Most failures or issues with automations tend to come down to configuration or connectivity issues. To make things easy, every transfer automation attempt has a verbose automation log. You can review the logs at Automations > [Automation Name] > View Executions and choosing a specific execution time.

Failures will be noted with a red dot for easy identification.

Ping if you are having issues with Automations.

Google Drive

Learn how to connect Couchdrop to a Google Drive folder

Introduction

Couchdrop can be connected to a Google Drive folder in a few simple steps. Couchdrop works with Personal Google Drive accounts and Google Workspaces.

To connect to a Google Workspace tenant, see

Storage

Learn about Storage with Couchdrop SFTP

Introduction

Traditional SFTP and FTP servers use local storage and most cloud hosted SFTP servers provide some level of storage. Couchdrop is a bit different in this regard. Rather than including storage that is on disk, Couchdrop connects to your storage platform.

We support over 30 different cloud storage engines, including:

  • Dropbox

How to connect via FTPs

Learn how to connect to Couchdrop with FTP

Connecting to Couchdrop with a FTP client is simple. To get started, you will need:

  • A username and password or

  • A username and key

  • The hostname for your Couchdrop POP. This can be found by clicking Connect

Non-GUI Environments

Learn about connecting the Couchdrop agent in a Non-GUI environment

Install the agent on your Workstation

First, you need to install and configure the Couchdrop agent (Couchdrop Cloud Connector) on your workstation.

You can for configuration instructions. Once you have installed and configured the agent, you need to copy the configuration.

On your workstation, browse to the folder

Copy configuration.conf to a location you can access on the new server and also copy the Couchdrop Cloud Connector installer. Now you can uninstall the Agent from your workstation.

Conditional Filtering

Learn about conditional filtering for Automations

Introduction

Couchdrop allows for conditional filtering so that specific actions in a workflow only apply if certain conditions are met. This allows the use of one workflow for multiple scenarios and to selectively apply the workflow to specific files only.

SharePoint

Learn how to configure a connection to SharePoint with Couchdrop

Introduction

Connecting to SharePoint online is fast to set up and fully supported in Couchdrop. Couchdrop uses the Microsoft Graph API, which is the recommended method for connecting to SharePoint and OneDrive.

There are two different authentication methods available with SharePoint Online, Delegate Access or Application Access. The Couchdrop team recommends you use the default Delegate Access method, as it's simpler to configure.

Host key authentication

Learn about host key authentication

Couchdrop provides a public host key that can be used to verify the authenticity of the endpoint you are connecting to. This key is static and we do not expect it to change in the future.

The host key for all Couchdrop endpoints

Click Test Connection

  • Select a user or sub-folder in Box (Optional)

  • Click Save Settings.

  • Choose Authorize Now. A window will open to grant access to Couchdrop. Click Allow Access.

  • Click Test Connection in Couchdrop

  • Select a user or sub-folder in Egnyte (Optional)

  • Click Save Settings.

  • The IAM role must have adequate access to S3 and the targeted bucket
    Select a subfolder or bucket in S3 from the browser
  • Click Save Settings

  • Click Test Connection

  • Choose a subfolder in OneDrive from the folder selector (Optional)

  • Click Save Settings

  • Click Test Connection

  • Select a User or sub-folder in Dropbox (Optional)

  • Click Save Settings.

  • For connecting with Delgate Access, you can follow our step-by-step video guide below.

    Configuring Delegate access involves a standard OAuth login, and Application Access requires creating a custom application in your Azure Domain.

    To use Application Access see Other Connectors

    Requirements

    To connect to SharePoint online in Couchdrop using Delegate Access you will need:

    • An account in SharePoint

    • The account needs to be licensed

    • The account has access to the sites you are wanting to connect to

    • You have the SharePoint domain/hostname on hand

    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select SharePoint from the list of available connections and set the connection name

    3. Provide your SharePoint domain/hostname in the field required

    4. Click Connect to Sharepoint and authorize the connection through the popup window. You will be required to log in to SharePoint with your account

    5. Check that the status is connected successfully

    6. Choose a SharePoint Site, Document Library, User or Folder

    7. Click Save Settings

    Choose a subfolder in Azure
  • Click Save Settings

  • https://docs.microsoft.com/en-us/azure/storage/common/storage-account-manage
    We do not recommend installing the agent directly on the target file server. If possible, use a VM and connect via mapped network drives.

    Requirements

    To connect a Windows / OSX file server to Couchdrop you will need:

    • Remote access via RDP to the file server or a suitable VM

    • To have an administrator account

    • A reliable internet connection

    • A minimum of 16GB and 2 cores on the host or virtual machine

    • To be running Windows 10 or above (for Windows Servers)

    For a full list of requirements, see Server Requirements.

    Configuration Steps

    1. Log in to Couchdrop and add a new integration, either from +New > Connect Integration or the Integrations sidebar

    2. Click to add a new integration or Storage connector (Cloud Folder)

    3. Select Windows/OSX Server from the list of available connections

    4. Name the connection and create a cloud folder for Couchdrop

    5. Copy the Agent Token and download the agent. This token is only viewable once so be sure to copy it before leaving the screen.

    6. Log in to the remote target file server as an administrator

    7. Install the agent and launch it

    8. Paste the Agent Token from Couchdrop and click Connect. After a few seconds, the status indicator should change to show that the server is connected to Couchdrop.

    9. Return to the Couchdrop interface, click Test and Save.

    as a service
    Requirements

    To connect to Google Workspace in Couchdrop you will need:

    • A licensed Google Workspace Account

    • A folder in Google Drive

    • Access to an Admin User account in Google Workspace

    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select Google Workspace from the list of available connections

    3. Enter the email of an admin user and the domain of the Google Workspace Account you wish to connect to.

    4. Click Create Service Account. Couchdrop will create a service account and generate a Client ID.

    To proceed, you'll need to Delegate Domain Wide Authority to Couchdrop using the Admin Console. If you are unsure how to do this, see Delegating Domain-Wide Authority in Google Workspace

    1. After granting Domain Wide Authority, click Test Connection

    2. Choose a user or subfolder in Google Drive from the folder selector to be used as the root in Couchdrop (Optional)

    3. Click Save Settings.

    Google Drive
    Requirements

    To connect to Google Drive online in Couchdrop you will need:

    • A licensed Google Drive Account

    • A folder in Google Drive

    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select Google Drive Personal from the list of available connections

    3. Click Connect to Google.

    4. Click Test Connection

    5. Choose a subfolder in Google Drive from the folder selector (Optional)

    6. Click Save Settings

    Google Workspace

    SFTP and FTP

    Learn about using Couchdrop as an SFTP and FTP server for the Cloud

    Transfer Automations

    Learn about automating file transfers between platforms with Couchdrop

    Inboxes and Mailboxes

    Learn about secure file inboxes with Couchdrop. An easy way to collect files

    Connect Couchdrop to SharePoint

    Learn how to connect Couchdrop to Sharepoint online

    Add a user to Couchdrop

    Learn how to add a user for SFTP or FTP in Couchdrop. It's simple, get started now.

    Connect to Couchdrop with SFTP or FTP

    Learn how to connect to Couchdrop with various clients

    Creating SFTP Users in Couchdrop Learn about creating external Inbound SFTP users in Couchdrop.

    Connect to Storage Learn about connecting cloud storage to Couchdrop and using it for Inbound SFTP users.

    Connecting with SFTP Learn how to connect to Couchdrop via SFTP.

    [email protected]

    Notifications

    Learn about notifications as part of automations

    Introduction

    Notifications can be set to email a specific email address when an automation either fails or succeeds.

    Selecting Notifications

    Notifications are set in the automation builder by clicking a plus sign and choosing Notifications.

    Notifications settings

    At any point of a workflow, you can choose to send a notification. Notifications can be sent on success, on failure, or when either happen by checking the appropriate boxes.

    Recipient email addresses

    The Recipient email address field is a text box where you can specify any email address to receive the notification. Couchdrop supports multiple email addresses separated by a comma.

    Email template

    Couchdrop uses pre-filled email templates for notifications. There are slight variations depending on the event, but the emails will follow a similar structure to below:

    Subject: [Company name specified in Admin settings] - [Event] notification

    Hi there,

    Just wanted to let you know that your file [full file path] pulled by [username] has been [event] from [directory].

    If you require support or assistance with this please email us on [email protected] and someone will be in contact shortly.

    Thank you,

    Team @ Couchdrop

    Security

    Account expiry

    Learn about account expiry in Couchdrop

    Account expiry in Couchdrop is a useful tool for ensuring that accounts are short lived.

    Any account except the owner can be configured with an expiry. When an account has expired, all access with be disabled.

    Using SFTP Clients

    AAAAB3NzaC1yc2EAAAADAQABAAAAgQCFzDO6AiZhK4ks4Bz/VBysjB3fpExCfOmy2EuI2gXJDYgom4nvZK4eEEgHRrkNoRUww4RJ7CTRKKXWodP7OthQw2AfppgBfR8dUK3zYdp/IClqTZ0+yxk72lLV9k8HwbtalOEzlJNc6AKlAkDi+WtG8RRZbJeaQZf3pe0k6oa7yQ==

    Running the Couchdrop Agent as a Service

    Learn how to run the Couchdrop Agent as a Service for file server transfers.

    The Couchdrop Agent (Couchdrop Cloud Connector) can be run as a Windows service.

    Installing the agent as a service requires some understanding of how Windows services work and the service must be configured to run as the same user that is performing the configuration.

    Before starting, make sure that you have installed the Couchdrop Cloud Connector by following the steps outlined here. Make sure you have run and configured everything properly and check that it is working. We recommend closing the desktop configuration app and systray application before starting the service.

    Next in a command line, open the Couchdrop Cloud Connector folder located under Program Files and run the following command.

    .\couchdrop-cloud-connector-service.exe install

    Next, open the service manager:

    services.msc

    Find the service for "Couchdrop Cloud Connector" and open it.

    Adjust the Log On configuration specifying the user account that you are logged in as the account to run the service under. This step is important as the agent configuration is stored under the user's profile. Without configuring the correct user, the service will not properly connect.

    Finally, you can start the service. Once it's running, you can reopen the Couchdrop Cloud Connector configuration application and it should show the service as Running in Background.

    Set up the agent on the Server

    On the server, you will need to open the command prompt as an administrator. Once you have done that, you will need to locate where you copied your installer and configuration.conf file on the server.

    Below is an example command of how to install silently, but your path may vary on your location.

    Once this is complete, you need to apply the configuration to the server. To do this, copy your configuration.conf.

    On the server, you will need to browse to this location. You may need to create the CouchdropCloudConnector folder under your Appdata\Local as the agent has not run yet.

    Now, we need to set up the agent as a service. Follow the article here for instructions on how to do that. Be aware you don't need to install the agent again. You can go to the area of the article where it tells you to run the following command.

    Once you have completed installing the agent as a service and the service is running, you can check your Couchdrop Cloud Connector configuration integration in Couchdrop and see if it shows a successful connection.

    C:\Users\%username%\AppData\Local\CouchdropCloudConnector
    follow the article here
    C:\Couchdrop\couchdrop-cloud-connector-installer.msi /quiet
    C:\Users\%username%\AppData\Local\CouchdropCloudConnector
    .\couchdrop-cloud-connector-service.exe install
    Triggers

    File actions use event-based triggers at a specified location with the following options:

    Schedule
    Description

    Download

    Triggers when a file is downloaded from the directory

    Inbound AS2 Station Upload

    Triggers when a file uploaded via a specified AS2 Station

    Mailbox Upload

    Triggers on a file uploaded from a specified Mailbox

    Rename/Move

    Triggers when a file in the directory is renamed or moved

    Shared Link Download

    Triggers when a file is downloaded from a specified Shared Link

    Upload

    Triggers when a file is uploaded to the directory

    Enabling File Actions

    To enable a File Action, click File Action Enabled in the builder or click the three dots next to the Automation name in Actions and choose Enable Workflow.

    Multi-step automations

    Couchdrop supports multi-step automations using the visual automation builder. This allows for multiple actions to apply to the same file and the ability to route files to multiple locations.

    For information on specific actions and how to build automations, see Automation Builder.

    visual automation builder

    SharePoint

  • Google Drive

  • Amazon S3

  • Backblaze B2

  • Wasabi

  • Azure Files

  • External SFTP and FTP servers

  • Microsoft Windows File Servers

  • This means that you can bring your own storage to Couchdrop and use SFTP on top of your existing collection of folders and documents.

    We do offer storage, but we are using Amazon S3 buckets to store that data. Meaning that you benefit from the amazing reliability and security of Amazon S3 without having to worry about the config.

    Connecting Storage to Couchdrop

    Learn about connecting Cloud Storage:

    A FTP client or platform/software that supports FTP.

    Your hostname will look like <my domain>.couchdrop.io and can be found under Connect in the Couchdrop web app.

    FTP Connection Options

    FTP has a few options around networking and security. Couchdrop attempts to support as many clients as feasible, but these are the recommendations.

    Option
    Recommended Value
    Description

    TLS auto negotiation

    ON

    FTP by default is insecure. It is unencrypted and very easy to break. FTPs use an auto negotiation process that occurs during authentication that uses encrypted channels. We recommended always enabling this option.

    Port

    20

    Couchdrop uses the default port for FTP access

    Passive Mode

    ON

    Passive FTP mode forces the client to negotiate data channels with the server. This alleviates most of the issues with NAT and firewalls that do not support active channel negotiation.

    Hostname

    <yourdomain>.couchdrop.io

    Setting conditions

    Conditions are set in the automation builder by clicking a plus sign and choosing Conditions.

    Types of Filters

    You can select from multiple filters when building an automation:

    Name
    Description
    Example
    Explanation

    Filename matches

    Only applies for to a filename with the exact match

    Files.txt

    Only files named "Files.txt" will continue

    Filename does not match

    Applies to all files except for the filename with the exact match

    Files.txt

    All files except files named "Files.txt" will continue

    File Modtime

    Specify a modification time. Supports before, after, "in the last" and "older than"

    Older than 7 Days

    AND filtering

    Use "Match all of these conditions (AND)" to only apply the following action when all conditions are met.

    OR Filtering

    Use "Match any of these conditions (OR)" to apply if a single specified condition is met.

    Supported Actions

    Learn about supported Actions with Transfer Automations in Couchdrop

    Introduction

    Couchdrop supports several key actions when configuring and managing automations. These actions modify or move files that are being processed by Couchdrop.

    Selecting Actions

    Actions are set in the automation builder by clicking a plus sign and choosing Actions.

    Action Nesting

    Actions can be nested in Automations, which means one action depends on the success and output of the previous action. This is a unique feature of Couchdrop and allows for very complex scenarios.

    If a sub-action fails, then Couchdrop will not continue to process any child actions.

    For more information, see .

    Available Actions

    The following actions are available in Automations in Couchdrop

    Actions support variable use for directory and file locations

    Action Type
    Description

    Automation Builder

    Learn about how the visual automation builder works

    Couchdrop automations are built using a visual builder that requires no code. The builder supports multiple steps through primary actions and sub-actions.

    How the builder works

    Automations have two main pathways. Moving down the tree are primary actions. Moving to the right are sub-actions.

    See the sample image below of an automation created with the visual builder.

    It's important to understand Primary Actions and Sub-actions and the processing order to avoid errors.

    Primary Actions

    Primary actions act on the original file. This means that when there is a Copy action, any sub-actions apply to the copy and do not apply to the original file. Because of this, some actions like "Rename File" are unavailable in Primary actions to avoid errors.

    Sub-actions

    Sub-actions are branches to the right. These actions act on the modified file if a second file has been created due to a copy or similar action. If there is only one file, Sub-actions act on the original file and function essentially the same as primary actions.

    Processing Order

    Automations are processed top-to-bottom, left-to-right. This means that sub-actions occur before the next primary action.

    If a sub-action fails, then Couchdrop will NOT continue to process any child actions

    The builder shows the order that actions will be processed by showing them at different levels, with higher levels processed first. Processing order is also indicated by the letter groupings and numbered subactions.

    See the image below for an example of processing order in a multi-step workflow.

    All A group actions will occur first in numerical order, followed by the B group, and so on.

    Modifying an automation

    Once an action is chosen, the action type cannot be changed directly. Instead, the action must first be deleted and then replaced with a new action.

    When deleting an automation action, if the action has sub-actions, those sub-actions will be deleted as well. When this applies, you will receive a warning explaining the number of actions that will be deleted and will need to confirm deletion.

    Connect Storage

    Learn about storage integrations in Couchdrop

    The key difference between Couchdrop and other SFTP servers, is that Couchdrop works with your Cloud Storage instead of local hard disks. This means you can turn any storage platform, shared drive or server into a SFTP and MFT server in a matter of seconds.

    Couchdrop is also not limited to one particular storage integration, rather you can mount hundreds of stores in Couchdrop and they appear as independent folders.

    See Virtual Folders for more info on folders in Couchdrop

    Connecting External Storage

    To connect to over 30 different cloud platforms of a server the process is simple. You will of course need credentials or an API keyset for the storage you want to connect, but that aside, the process is simple.

    Step 1: Create new Connection

    From the Browser or Storage Admin, click Add Storage Integration. This will pop open a modal window with some options.

    Step 2: Choose a new folder name

    Storage connections appear as folders in Couchdrop. So a crucial step in this process is to choose a folder name and location. Couchdrop supports nestling storage connections as well.

    Step 3: Choose a connection type and configure it

    Next up - choose a connection type. At this stage, you will be redirected to the configuration panel to manage this connection.

    For detailed information, see the child articles here or reach out to support.

    Common Storage Integrations

    Couchdrop supports over 30 different storage platforms. The most common ones are well documented.

    Inbound Mailboxes

    Receive files via email with Couchdrop Mailboxes.

    Introduction

    Mailboxes in Couchdrop provide a simple way to receive files via email. When you create a mailbox - Couchdrop creates a dedicated email addresses that automatically save attachments directly to your cloud storage.

    Requirements

    To setup an Mailbox, generally you will need the following:

    • Access to Couchdrop, with the appropriate user rights. Talk to your admin to get these.

    • A folder or details for a cloud storage drive and rights to manage it

    How to create the Mailbox

    To create the inbox, follow the steps below:

    1. Login to Couchdrop and click Inbound Mailboxes

    2. Click Create New. If you don't see this option, talk to your administrator.

    3. Provide a name for the mailbox. This is simply so you can identify it.

    4. Select a location for files to arrive. This is the place where user delivered files will be located. You can choose an existing folder, or configure a new cloud storage connection here. Once you are done, click Save and Continue.

    Now you will see your newly created Mailbox. Copy the email address by clicking Email.

    Feature Support

    Mailboxes have comprehensive support in Couchdrop.

    Feature
    Supported

    Frequently Asked Questions

    Is there a size limit with files?

    Yes - most email clients will not allow files larger than 25Mb. While we do not have a set limit - clients and most servers will not allow files greater than this.

    Are Mailboxex HIPAA compliant?

    No - email is not suitable for sensitive data - expecially PHI.

    Delegating Domain-Wide Authority in Google Workspace

    Walkthrough of how to delegate Domain-Wide Authority in Google Workspace to connect Couchdrop to a Google Workspace account

    Delegating Domain-Wide Authority

    Learn how to connect Google Workspace to Couchdrop with a Client ID and domain-wide delegation

    Introduction

    To connect a Google Workspace account to Couchdrop you need to delegate domain-wide authority so Couchdrop can access your users and migrate them automatically.

    Requirements

    Delegating Domain-Wide Authority requires the following:

    • A Google Workspace Administrator Account to access the Admin Console

    • Familiarity with the Google Admin Console

    • Client ID for Google generated in Couchdrop when configuring a Google Workspace connection

    Configuration Steps

    1. for your Google Workspace domain.

    2. Select the Security tab. If you don't see Security, select Show More from the bottom of the menu list.

    3. Choose Access and data control and then API controls.

    4. In the Domain wide delegation

    1. Click Authorize. Test that the connection in Couchdrop is successful to complete your configuration.

    For more information on domain-wide delegation, see this Support article from Google:

    AS2

    Learn about connecting to external AS2 providers with Couchdrop

    Introduction

    Couchdrop supports AS2 connectors, enabling secure file exchanges with partners using the AS2 protocol. Designed for EDI transfers, AS2 ensures both security and reliability. With Couchdrop, you can connect to external AS2 partners to send files outbound, or receive files as an AS2 provider. This section focuses on configuring connections to external AS2 partners for outbound transfers.

    To configure Inbound AS2 - visit

    Requirements

    To set up an AS2 connector, generally, you will need the following:

    • Access to Couchdrop, with the appropriate user rights. Talk to your admin to get these.

    • AS2 Partner ID (AS2 ID)

    • AS2 Target URL

    • AS2 Trading partners public certificate

    Configuration Steps

    1. Log in to Couchdrop and add a new storage connection

    2. Select Outbound AS2 from the list of available connections

    3. Configure the Name and virtual folder name

    4. Set the partner configuration details and upload the partners public certificate.

    Now when file browsing you will see your newly created folder and every file dropped in will be sent to your configured partner.

    We recommend testing a partner upload after initial configuration.

    How it works

    AS2 is different to most storage connections in Couchdrop in that it only supports outbound transfers. You can think of AS2 as a messaging protocol rather than a file storage or transfer protocol. With AS2 - operations like listing directory contents and downloading files are not supported.

    In Couchdrop - an external AS2 connection is surfaced in the virtual filesystem as an outbound folder where files can be upload/sent.

    We recommend learning about Virtual Folders - External AS2 connections will appear as virtual folders.

    When files are uploaded into an AS2 folder - Couchdrop wraps the files in an AS2 message, encrypts the file and sends it to the external provider.

    Supported features with external AS2 servers.

    Feature
    Supported

    Inbound Webhooks

    Inbound https webhooks are a flexible and easy way to ingest data from any system that can use HTTPS.

    Introduction

    Inbound webhooks in Couchdrop provide a simple and secure way to upload data directly into your storage environment over HTTPS. Instead of relying on traditional file transfer protocols or manual uploads, customers can push data to Couchdrop programmatically using standard POST requests. This makes it easy to integrate Couchdrop into existing workflows, applications, or automation pipelines without needing specialized client software.

    Couchdrop’s inbound webhooks are flexible and support a wide range of payloads, including binary files, JSON documents, and raw request bodies. Whether you’re sending log files, structured data, or application-generated artifacts, Couchdrop ensures that the incoming content is captured reliably and routed to your configured storage destination. This approach enables seamless ingestion of data at scale while maintaining the simplicity and security of HTTPS-based transfer.

    Requirements

    To setup and use a inbound webhook for data upload you will need the following:

    • Access to Couchdrop, with the appropriate user rights. Talk to your admin to get these.

    • A folder or details for a cloud storage drive and rights to manage it

    • Knowledge about what kind of data you are sending and any authentication requirements

    Configuring an Inbound Webhook

    To create the inbox, follow the steps below:

    1. Login to Couchdrop and click Inbound Webhooks

    2. Click Create New. If you don't see this option, talk to your administrator.

    3. Provide a name for the web hook endpoint. This is simply so you can identify it.

    4. Select a location for files to arrive. This is the place where user delivered files will be located. You can choose an existing folder, or configure a new cloud storage connection here. Once you are done, click Save and Continue.

    Using an Inbound Webhook to upload data

    Example 1: Upload via CURL

    To upload via curl:

    Example 2: Upload with Python using a stream

    Example 3: Upload JSON data to a file

    Proxy Configuration

    Learn about working with proxy configuration for file servers

    In networks where internet access is only allowed behind a proxy server some additional manual configuration is needed.

    Configuration steps

    For detailed configuration instructions, see Windows / Mac File Server

    1. Install and run the agent

    2. Set the token

    3. Stop the agent and then add the proxy configuration manually

    4. To add the proxy configuration, you will need to locate the Movebot configuration file, normally it's located in the directory, C:\Users\%username%\AppData\Local\CouchdropCloudConnector.

      Open the file with Notepad, or something similar, and you will find a JSON with a base config.

    5. Edit the "proxies" section, adding an HTTP and HTTPS proxy with the syntax below:

    1. Save the file, and start the agent again.

    You can also find proxy settings and shortcut links to logs & configuration files in the settings section (gear) within the Couchdrop agent.

    Proxy URL syntax examples:

    Type
    Format
    Example

    Debugging

    To debug connection issues, check the log files located in the same directory as the configuration files and feel free to contact support for help at .

    How to connect via SFTP

    Learn how to connect to Couchdrop with SFTP

    Connecting to Couchdrop with a SFTP client is simple. To get started, you will need:

    • A username and password or

    • A username and key

    • The hostname for your Couchdrop POP. This can be found by clicking Connect

    Server Requirements

    Learn about requirements for connecting Couchdrop to file servers

    The Windows / OSX Agent allows for connections to on-prem file servers running Microsoft Windows or macOS. This software is run as an executable and can also be run as a service.

    Server Requirements

    While connection requirements can vary depending on the types of transfers involved, we recommend the resources below.

    Component

    Send Files with Shared Links

    Learn about shared links in Couchdrop

    Introduction

    Shared Links in Couchdrop offer a secure and easy way to share and send files to external parties via the web. A shared link is a URL that can be shared and can then be used to download individual files or share a directory of files inside Couchdrop.

    Shared Links have two modes:

    • Send Files - This method creates a copy of the file that can be only downloaded using the generated link. Couchdrop stores the file temporarily in specific storage.

    Inbound AS2 Stations

    Learn about how to configure Couchdrop to receive files via AS2

    Introduction

    Couchdrop supports inbound AS2, enabling secure file exchanges with partners using the AS2 protocol to send and receive data.

    Designed for EDI transfers, AS2 ensures both security and reliability. With Couchdrop, you can connect to external AS2 partners to send files outbound, or receive files as an AS2 station. This section focusses on receiving data as an AS2 station in Couchdrop from partners.

    Create SFTP Users

    Learn about allowed users for SFTP and FTP

    Accessing Couchdrop via SFTP requires a user account. Inbound SFTP users are independent from Administrators in Couchdrop and are designed to have limited access.

    We do not recommend using your owner account as they have elevated permissions to Couchdrop and generally SFTP users are shared with external systems and providers.

    User Management in Couchdrop

    Create FTPs Users

    Learn about allowed users for SFTP and FTP

    Accessing Couchdrop via FTP and FTPs requires a user account. Inbound FTP users are independent from Administrators in Couchdrop and are designed to have limited access.

    We do not recommend using your owner account as they have elevated permissions to Couchdrop and generally FTP users are shared with external systems and providers.

    Creating a new User

    Creating a new Inbound FTP user is done in the management dashboard from Couchdrop and is a simple two step process.

    Connect Platforms

    Learn about system connectors in Couchdrop

    Overview

    System integrations allow you to connect a system that Couchdrop can use to stream data into.

    These differ from storage integrations, as storage integrations are external file systems, and platforms are external system we stream data into, such as databases or queues.

    The Root Directory

    Learn about the root directory in Couchdrop.

    The root directory in Couchdrop is a key security mechanism.

    When users are added, you must choose a root directory. The root directory in Couchdrop behaves a bit like the home directory in a unix environment with a couple of caveats.

    • Users cannot navigate outside the root directory

    • Users can only see paths relative to the root directory

    Features Access

    Learn about feature access rights on users and groups

    Outside of the standard user roles, access to various features can be managed on an individual user and a group basis.

    When adding a user, we pick reasonable defaults based on your environment and then you can modify this access.

    Firewalls and ACLs

    Learn about Firewall and ACLs in Couchdrop

    A key security mechanism in Couchdrop is ACLs. ACLs limit access to particular IP addresses or netwrok ranges.

    There are three levels of ACL controls in Couchdrop:

    • User based

    • Group based

    • Tenant based

    Webhook

    Learn how to send events via a Webhook to your logging system from Couchdrop

    Requirements

    Required Configuration

    To setup a Webhook you will need:

    Password Policies

    Learn about Couchdrop's password policy management

    Couchdrop allows administrators to create comprehensive password policies that enforce good password management to meet security and compliance requirements.

    Global Password Policies

    Under administration, Couchdrop allows admins to configure a global password policy that applies to all users. This global password policy is managed under Administration --> Security --> Password Policies

    Account Lockout

    Learn about account lockout in Couchdrop

    SFTP and SCP are easy targets for brute force attacks on the internet. To protect our customers from unauthorised access, Couchdrop implements an account lockout policy by default.

    After 5 incorrect attempts in 5 minutes, accounts are locked for 15 minutes.

    This option can be disabled globally, but we do not recommend it.

    Static IPs

    Learn about Static IPs with Couchdrop

    Introduction

    Couchdrop uses a vast network of cloud computing resources to provide you with a robust and fast SFTP and file automation platform. Since we are using dynamic cloud computing, geographically located in over 15 different datacenters, we can't publish or guarantee that our IPs won't change. In fact, they do change, and very frequently.

    Don't attempt to enumerate our IP addresses. They change frequently, without warning, sometimes multiple times a day. It will hurt.

    Recommendation

    CPU

    4-8 VCPU Core

    Memory

    16GB

    Hard Disk Space

    32GB of free disk

    Supported Windows Versions

    Below are the current supported and tested versions of Microsoft Windows that the agent supports.

    Operating System
    Supported?

    Windows XP

    No

    Windows 10

    Yes

    Windows Server 2012 R2

    No

    Windows Server 2016

    Yes

    Windows Server 2019

    Yes

    Windows Server 2022

    Yes

    For help configuring the agent on servers that are not listed here, contact [email protected].

    Software Requirements

    You will need Microsoft .NET Framework 4.7.2 to open the agent.

    Network Requirements

    The speed of your transfers will be heavily dependant on your internal and external network capacity. We recommend having the highest available uplink speed, with 1GB uplink speed over fiber if possible when moving high volumes of data or files.

    If you are experiencing performance issues with the agent, we recommend running a speed test and ensuring you've chosen a data region that is close to the agent when applicable.

    Firewall Requirements

    The Couchdrop agent communicates with the Couchdrop control plane and APIs exclusively via HTTPS. This means that no additional ports are needed to be opened. However, if your organization has a proxy server or web filter, you may need to allow the following domains out.

    • fileio.couchdrop.io

    • api.couchdrop.io

    • *.couchdrop.io

    • 8.8.8.8, 8.8.4.4

    For more information, get in touch with support via [email protected]

    Using Platforms in Couchdrop

    Platform integrations can be used in File Actions and Automations as actions.

    Webhook Endpoint

  • Event JSON attribute

  • Optional Configuration

    You can configure these optional attributes

    • Additional Headers for e.g. basic authentication

    • Additional Attributes that are part of the json object we send to your logging system

    Configuration Steps

    1. Log in to Couchdrop and navigate to the Admin Panel - Logging

    2. Select Connect/Manage on the Webhook Provider Pill

    3. Select the Events to send via the Webhook

    4. Configure the required and optional Webhook fields

    5. Click Save Updates

    Group Password Policies

    Password policies can also be explicitly applied to groups. Different groups in Couchdrop can have different policies applied. This provides an additional level of customisation and allows for compliance with SFTP and FTP clients that may not support complex passwords.

    Password expiry

    Along with managing password complexity, password policies can be configured to expire passwords. Once a password has expired, it will need to be reset, either by an administrator or by the user through the reset password mechanism.

    It's a hard requirement for us

    If static IPs are a hard requirement, then reach out to [email protected] and we can assign your account to a POD that is configured for them.

    Upload Link Upload

    Triggers when a file is uploaded to the directory via a specified Upload Link

    Webhook Upload

    Triggers when a file is uploaded to the directory via a specified Webhook

    Couchdrop provides a domain name for each tenant. You can find this under Connect in the Couchdrop web app

    Only files modified more than 7 days ago will continue

    Directory matches

    Select a location to choose a directory or paste full path

    Hosted-2024

    Only files in "Hosted- 2024" directory will continue

    Directory does not match

    Select a location to exclude a directory or paste full path

    Hosted-2024

    All files except those in "Hosted-2024" directory will continue

    Connect To SharePoint

    Learn how to connect Couchdrop directly to SharePoint

    Connect to Amazon S3

    Learn how to connect Couchdrop to Amazon S3

    Learn about Storage Connectors

    Get the nuts and bolts covered with Storage in Couchdrop

    Decompress File

    Uncompress the file

    PGP Encrypt

    Encrypt and sign a file with a PGP key

    PGP Decrypt

    Decrypt and verify a file encrypted and signed with PGP

    AES Encrypt

    Encrypt a file with AES

    AES Decrypt

    Decrypt a file encrypted with AES

    Create Empty File

    Create a new empty marker file in a location spe

    Extract Variable from Filename

    Extract a custom variable using a regex pattern for later use

    Unarchive

    Unarchive multiple files at once

    Send Email

    Automatically sends an email to a specified email address when a target action has occurred

    Fire Webhook

    Fire an HTTP webhook with metadata regarding the file object to the specified URL endpoint

    Rename file

    Rename the file without copying the file to a new location

    Move file

    Copy the file to a new location and delete the file from the source location

    Transfer/Copy File

    Copy the file to a new location, retaining the original file in the source

    Delete file

    Delete the file

    Compress File

    Create a compressed archive of the file

    Automation Builder

    Your AS2 signing certificate

    Upload your public and private key for signing under Message Signature Configuration

  • Save and Test

  • File Actions

    Yes - Upload only

    Transfer Automations

    Yes - Upload Only

    Inbound SFTP and FTPs

    Yes - Upload only

    Inbound Mailboxes

    Yes

    Upload Links

    Yes

    Inbound Web hooks (https)

    Yes

    Inbound AS2

    Yes

    Inbound S3 (S3 Gateway)

    Yes

    Inbound AS2 Stations
    here

    SharePoint and OneDrive

    Learn how to configure Couchdrop to connect to SharePoint.

    Azure Files

    Learn how to connect Couchdrop to Azure files

    Amazon S3

    Learn how to connect Couchdrop to Amazon S3 or an S3 compatible storage provider

    External SFTP Connections

    Learn how to connect Couchdrop to an external SFTP server

    Google Drive

    Learn how to connect Couchdrop to Google Drive

    Box

    Learn how to connect Couchdrop to Box

  • Optionally provide some allowed senders. Wildcards are supported and you can include as many addresses as you like by using a comma.

  • Click Save and Continue

  • Choose an expiry. This is an optional step.

  • File Actions

    Yes

    API Creation

    Yes

    Automatic Expiry

    Yes

    Custom Domains

    Yes

    Auditing

    Yes

    Alerting and Notifications

    Learn about alerting and notifications in Couchdrop

    Couchdrop has three different mechanisms for alerting and notifications. Each is independant of the other and is managed slightly differently.

    Global Alerting

    Global alerting lives across the tenant and provides the broadest framework for providing notifications on events. You can configure global alerting to notify users when:

    • A file is uploaded or downloaded

    • A user logs in

    • An event fails

    These notifications are configured under Administration --> Reporting --> Alerting

    Notifications are either by email or via web hooks. Couchdrop expects a HTTP 200 response to web hooks or else it will retry 15 times with an exponential backoff.

    Folder Alerting

    Folder alerting offers the same alerting facilities as Global Alerting, but they are configured and bound to a folder and its children.

    Folder alerting is configured through the manage folder menu and can be configured globally as folder settings under Administration --> Permissions.

    Folder alerting supports the following events:

    • A file is uploaded or downloaded

    • An event fails

    File Actions

    Alerting can also be configured as an action in File Actions.

    SFTP Recipes

    section, choose
    MANAGE DOMAIN WIDE DELEGATION
    .
  • In the API clients section, click Add new. Paste the Client ID generated from Couchdrop into the Client ID field.

  • In the OAuth scopes (comma-delimited) field, paste the following:

  • Login to the admin console
    https://support.google.com/a/answer/162106?hl=en
  • Optionally provide an authentication token and options

  • Click Save and Continue

  • Simple, no username and password

    http://<ip>:<port>

    http://127.0.0.1:8080

    With username and password

    http://username:password@<ip>:<port>

    http://proxyuser:[email protected]:8080

    Socks

    socks://<ip>:<port>

    socks://127.0.0.1:8080

    [email protected]
    https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/drive.file, https://www.googleapis.com/auth/admin.directory.user, https://www.googleapis.com/auth/admin.directory.user.readonly, https://www.googleapis.com/auth/admin.directory.user.security
    curl -v -F [email protected] 
    -H "Authorization: Bearer <token>" 
    https://my.couchdrop.io/webhook/0479ae21-a677-49bb-9937-d5841b3b9ed1
    import requests
    
    binary_file_path = "/Users/donald/testing/trophy.jpg"
    webhook_id = "<webhook_id>"
    token = "<token>"
    
    with open(binary_file_path, 'rb') as f:
     data = f.read()
        
     res = requests.post(
         url='https://my.couchdrop.io/webhook/' + webhook_id, data=data,
         headers={
          'filename': 'trophy_webhook.jpg', 
          'Content-Type': 'application/octet-stream', 
          'Authorization': 'Bearer ' + token
         })
    curl -H "Filename: json_test_file.json" 
    -H "Content-Type: application/json" 
    -XPOST https://my.couchdrop.io/webhook/0479ae21-a677-49bb-9937-d5841b3b9ed1 
    -d '{"id": "dasflk34masd", "event": "purchase", "customer": "testaccount"}'
    {
    ...
    "proxies": {
    "http": "", 
    "https": ""
    }, 
    ...
    }

    A SFTP client or platform/software that supports SFTP.

    General Connection Details

    Couchdrop uses the default ports for SFTP and a unique hostname for your tenant.

    Your hostname will look like <my domain>.couchdrop.io and can be found under Connect in the Couchdrop web app.

    Option
    Recommended Value
    Description

    Hostname

    <yourdomain>.couchdrop.io

    Couchdrop provides a domain name for each tenant. You can find this under Connect in the Couchdrop web app

    Port

    22

    The standard port for SFTP and SCP

    Common Clients

    Couchdrop SFTP has native support for all SFTP clients. SFTP is a mature protocol - if you are looking for a client to test or use - below are some great options that are well supported.

    Name
    URL

    Filezilla

    Filezilla is arguably the most known name in the SFTP space. They have well supported clients for Windows and Macs.

    Cyberduck

    Cyberduck are a more modern version of Filezilla - they have a very clean UI and simple to use client.

  • Share File - This method references an existing file inside Couchdrop. This file can be located in any storage platform or connection.

  • Shared links include various security controls and features to support secure file sharing and offer a one click easy method of sharing and/or sending files without exposing internal resources.

    Creating a new Shared Link

    To use shared links, you can simply create one by selecting an existing file or by uploading a file from the Couchdrop dashboard.

    1. Create Shared Link from the + Create menu in the Couchdrop dashboard.

    2. Upload or select the file to send

    3. Couchdrop will then create a new shared link, with a unique url

    4. You can customize the shared link, with a Password or other security options when creating it - or after it has been created.

    To access the shared link, copy the link provided in the Couchdrop App.

    Supported Security Features

    Shared links by default work similar to any other download link. For high security environments - this is not ideal - so we include a bunch of security options that are available to ensure that the data is safe and only accessible by the intended party.

    As an administrator - you can configure default security options to ensure that end-user created shared links are secure.

    Option Name
    Description

    Password

    Set a password for the shared link. When accessing the link - users will be prompted for the password

    Restrict Allowed Emails

    Restrict link access to specific emails with email verification. If enabled - when accessing the shared link, users will be prompted for an email address and asked to verify the email address with an MFA code. This security feature offers an additional level of security.

    One Time Use

    Shared links can be turned into single use. Once the file has been downloaded - it will no longer be available

    Expire

    Similar to One Time Use - but with a timer. When creating the shared link you can set an expiry. Links that have expired will no longer allow use.

    Frequently asked questions

    Are Shared Links encrypted and secure?

    Yes - shared links are accessed by a TLS 1.3 web link.

    Is there reporting and auditing available on Shared Links?

    Yes - All actions in Couchdrop are audited and access to a shared link is included in standard auditing for Couchdrop. The creator of the Shared Link can view events for the shared link and administrators can view and manage the link as well. Included in all reporting is:

    • The file/s downloaded

    • The IP address of the downloader

    • The email address

    Who can create shared links?

    By default - administrators, owners and managers can create shared links. You can enable shared links for external users as well.

    Can we white label the link?

    Yes - you can control the logo and title used on the download link portal. You can also adjust the domain if needed.

    Requirements

    To support receiving files via AS2 in Couchdrop - you need to create an AS2 Station to receive files from your trading partners using the AS2 protocol. Every station will have a unique URL where your partners can send you files and these files will be mapped to a folder in Couchdrop.

    To set up an AS2 Station, generally, you will need the following:

    • Access to Couchdrop, with the appropriate user rights. Talk to your admin to get these.

    • A folder or details for a cloud storage drive and rights to manage it.

    • Information from the partners you wish to receive files such as their AS2 ID and the signing certificate to validate the signature of the incoming files.

    Field Type

    AS2 ID

    Required

    Signing Certificate

    Required

    Creating an AS2 Station

    To create the AS2 Station, follow the steps below:

    1. Click Create New AS2 Station. If you don't see this option, talk to your administrator.

    2. Provide a name for the AS2 Station. This is simply so you can identify it.

    3. Provide the AS2 ID for your station. You will need to share this ID with your trading partners.

    4. Add your private key and public certificate for file decryption and MDN (Message disposition notification) signing. You can choose to use the same key pair for decryption and signing or use a different pair for each.

    5. Select a location for files to arrive. This is the place where files sent by your AS2 trading partners will be located. You can choose an existing folder, or configure a new cloud storage connection here. Once you are done, click Save and Continue.

    6. Add your AS2 trading partner

      1. Click Create New AS2 Trading Partner.

      2. Provide a name for your AS2 partner

      3. Add the partner's AS2 ID provided by them.

    7. Now you will see your recently added trading partner in the AS2 Trading Partners table, you could add more trading partners by repeating the steps described above. When done, click Save and Continue.

    Using the AS2 Station

    For the file transmission to be successful you will need to share the following information with your AS2 trading partners:

    • Station AS2 ID

    • Station URL

    • Certificate file for signing

    • Certificate file for encryption

    As an option, you can use the Share Instructions action to send this information.

    Creating a new User

    Creating a new Inbound SFTP user is done in the management dashboard from Couchdrop and is a simple two step process.

    Requirements

    To create a new user - you will need:

    • A username and password - the username needs to be unique in Couchdrop.

    • A folder location where that user will be isolated to.

    • Administrator access to your Couchdrop tenant

    Configuration Steps

    Login to Couchdrop at - https://my.couchdrop.io

    1. From the dashboard - click "+ Create" and then choose SFTP User

    2. Follow the wizard to create your new user

    3. Share the newly created user with your end customer

    You can see who has access directly in the Couchdrop SFTP section from the web app.

    Users and Groups

    Learn more about users and groups in Couchdrop

    RSA and DSA Keys

    Learn about configuring key based access to Couchdrop SFTP

    Adding a User

    Learn how to add users to Couchdrop

    Requirements

    To create a new user - you will need:

    • A username and password - the username needs to be unique in Couchdrop.

    • A folder location where that user will be isolated to.

    • Administrator access to your Couchdrop tenant

    Configuration Steps

    Login to Couchdrop at - https://my.couchdrop.io

    1. From the dashboard - click "+ Create" and then choose FTP User

    2. Follow the wizard to create your new user

    3. Share the newly created user with your end customer

    Once created - you can send connection details to the external provider or user.

    You can see who has access directly in the Couchdrop SFTP section from the web app.

    The true location of the root directory is hidden
  • Users can share the same root directory

  • Root directories can have permissions to give added controls.

    • Read only users: Can only download and view content in directory

    • Write only users: Users can only upload files to the directory, they cannot view existing files or folders

    Example Root Directory:

    ACLs are additive, in that if the user authenticating originates from an IP address in a range at all three levels, then we will allow the request.

    Configuring an IP address or network range is simple:

    Transfer Automations

    Learn about automations in Couchdrop

    Introduction

    Couchdrop Automated Transfers take the hassle out of moving files between systems by allowing you to schedule, trigger, and orchestrate file transfers without manual intervention. Instead of relying on scripts, cron jobs, or complex middleware, Couchdrop provides a managed way to automatically move data between your connected storage platforms, SFTP/FTP servers, or cloud environments.

    With Automated Transfers, you can define rules and schedules that handle repetitive or time-sensitive workflows, such as nightly backups, hourly data syncs, or event-driven distribution of files.

    Triggers

    Transfer Automation have two trigger types: Manual and Scheduled. Manual triggers are only initiated by clicking the Run/Trigger Workflow button.

    Scheduled triggers activate based on a configured schedule (evaluated in UTC) with the following options:

    Schedule
    Description
    Example
    Explanation

    Secondary Schedules

    If the Transfer Automation needs to run at multiple intervals, these can be set with Secondary Schedules.

    Suppose you want to trigger the automation at noon every Friday but also on the first of the month. To do this, create one Automation for Weekly, Friday, 12:00PM, and then a Secondary schedule for Monthly 1, 12:00PM.

    You can add as many Secondary Schedules as needed for a single automation.

    Determining what to transfer or poll

    Transfer automations require that you configure a source and choose what to transfer or poll.

    Type
    Description

    Enabling Transfer Automations

    To enable a Transfer Automation, click Transfer Automation Enabled in the builder or click the three dots next to the Automation name in Automations and choose Enable Schedule.

    For information on specific actions and how to build automations, see .

    Azure Blob

    Couchdrop has comprehensive support for Azure Blob containers out of the box. This document outlines requirements, configuration steps and capabilities for using Azure Blob with Couchdrop.

    Overview

    Azure Blob is supported natively with Couchdrop. Couchdrop allows users of Azure Blob to upload and download files and Azure Blob customers can easily configure and manage secure access to Azure Blob files and folders for access and use via SFTP, FTP, Automations and Web Access with granular user management and controls through a user-friendly web interface.

    Requirements

    Configuring access to Azure Blob is a simple process in Couchdrop. Lets get you up and running - you will need.

    1. An active Couchdrop account

    2. An active Azure Storage Account.

    3. Access to create a Container (or use an existing one).

    4. Connection details you’ll need:

    Configuration Steps

    Step 1: Create an Azure Blob Container - or Use an existing container

    1. In the Azure Portal - Navigate to Storage accounts → select your storage account.

    2. In the left menu, click Containers.

    3. Click + Container, give it a name, and set access level to Private (recommended).

    Step 2. Generate Credentials for Azure

    Option A: Access Key (simple but broad permissions)

    1. In the storage account, go to Access keys.

    2. Copy the Storage account name and Key1.

    Option B: SAS Token (more secure / scoped)

    1. In the storage account, go to Shared access signature.

    2. Select:

      • Allowed services: Blob

      • Allowed resource types: Container and Object

    3. Connect Couchdrop to Azure

    1. Log in to your Couchdrop dashboard.

    2. Click + Create -> Connect to Storage -> choose Azure Blob.

    3. Enter the required details:

      • Couchdrop Folder (this is where Couchdrop will present the Azure bucket)

    You will now see your Azure blob container as a folder in Couchdrop.

    Frequently Asked Questions

    Can we configure multiple users with different access permissions for SFTP with Azure?

    Yes - Couchdrop supports configuring as many users as you need and each user can have different folder level access to Azure Blob.

    Along with comprehensive permissions - Couchdrop also supports extensive auditing on user activity.

    How does Couchdrop connect to Azure Blob?

    Couchdrop uses the official REST api provided by Microsoft to connect with Azure - via the internet. Data is transferred securely using +TLS 1.2.

    Does Couchdrop store data when integrating with Azure Blob?

    No - when uploading or download data via Couchdrop with Azure - data is not stored on Couchdrops infrastructure at rest. You can think of Couchdrop in this context as a bridge or pipe for your data.

    Can we use FTP or FTPs with Azure Blob?

    Yes - Couchdrop supports FTP and FTPs natively as well.

    Supported Features

    Couchdrop has comprehensive support for interacting with Files in Azure Blob

    Feature
    Supported in Couchdrop

    Variables

    Learn about variable use in Transfer Automations

    Introduction

    Variables are used in Couchdrop to support custom filename and path creation in automations. Whenever setting a location or path in an automation, you can use variables to generate an appropriate path.

    Available Variables

    The following variables are available for automations

    Key
    Value Example
    Description

    You can also create Custom Variables using the Extract Variable from Filename action. For more details, see .

    Connect to FTPs

    Learn how to connect Couchdrop to an external FTP or FTPs server folder and how this differs from SFTP.

    Introduction

    Couchdrop can be connected to any external FTP/s server in a few simple steps. When connected, you can upload and download files to the external FTP/s provider. You can also take advantage of Couchdrop’s automation features and inbound transfer methods - such as mailboxes and upload links - to streamline and simplify data transfers.

    FTPs is a different protocol to SFTP. If you are unsure - check with your provider as you may need to use the SFTP connector.

    Requirements

    To connect to an external FTP server with Couchdrop you will need:

    • The hostname or IP address and port number for the external server

    • A username and password for the external server.

    • A unique folder name in Couchdrop

    Configuration Steps

    1. In Couchdrop; Click + Create -> Connect to Partners/Providers or + Add Connection from the Connections Tab

    2. Select FTP Server from the list of available connections

    3. Provide the configuration details as listed above

    4. Click Test Connection

    Most FTP providers use port 21 . Check with your provider - but if unsure - try this port first.

    How it works

    Similar to all connections in Couchdrop - all external FTP connections appear as folders in Couchdrop. Couchdrop can transfer to and from the external FTP server directly or through automations.

    External FTP providers appear as Virtual Folders in Couchdrop. We recommend learning about Virtual Folders

    Supported features with external FTP servers

    Feature
    Supported

    Frequently Asked Questions

    Can we schedule a copy from one FTP server to the cloud

    Yes - this is Couchdrop's bread and butter. You can configure a connection to an external FTP server - select a folder and then automate a transfer using a Scheduled Transfer Automation that polls the FTP server for new files and then moves them.

    Can Couchdrop provide Static IPs that we can whitelist

    Yes - Contact our support team to request static IPs.

    Do you support TLS

    Yes - Connecting via TLS is enabled by default with external connections

    Do you support implicit SSL for external FTP providers

    Not currently - Implicit SSL is not as secure as FTP via TLS. If this is a deal breaker for you - reach out to [email protected] and we can chat about options and workarounds

    Common issues and errors

    Access denied

    Access denied when browsing, uploading or downloading files generally means that you do not have adequate permissions with the external platform. Contact the external providers support team to make sure you have permissions on there service.

    Timeout

    A timeout normally occurs when there a firewall preventing access. Check with the external provider and talk to our support team about static IPs for the external vendor to whitelist.

    Boomi

    Learn about Couchdrop's native Boomi integration.

    Introduction to Boomi with Couchdrop

    Boomi is a leading iPaaS (Integration Platform as a Service) solution for enterprise users. iPaaS platforms like Boomi enable no-code integrations between internal systems - for example, connecting Salesforce with Zendesk.

    Couchdrop is a Managed File Transfer (MFT) and SFTP platform designed to simplify secure B2B file transfers. It acts as a secure file transfer gateway for Boomi, allowing Boomi customers to receive files via SFTP, FTP, and other MFT protocols, and then pass them into Boomi for internal processing.

    How Boomi works with Couchdrop

    Boomi is configured in Couchdrop as an outbound connection. You link a Couchdrop folder to a Boomi process via a webhook endpoint. Any file uploaded into that folder is securely delivered to Boomi, which then triggers the process you have deployed.

    Requirements

    • Admin access in Couchdrop

    • A Boomi process with a Web Services Server connector deployed to an environment

    • The following details from Boomi:

      • Environment API URL

    Boomi has a 5 MB maximum file size limit for incoming files

    Configuration Steps

    Set Up the Process in Boomi

    • Create and deploy a process with a Web Services Server connector

    • Copy the Environment API URL, Endpoint, Username, and Token from your Boomi environment

    Configure the Connection in Couchdrop

    • Add a new outbound connection

    • Select Boomi and provide:

      • A name for the integration

      • A folder name (creates a Couchdrop folder that sends files to Boomi)

    Files uploaded into the Couchdrop folder will now be sent automatically to your Boomi process.

    Supabase

    How to connect using the Supabase system integration

    Introduction to Superbase with Couchdrop

    Couchdrop’s native support for inserting data into Superbase through file actions makes it incredibly simple to move data from virtually any source into your data warehouse. You can configure Couchdrop to automatically ingest files and stream their contents directly into Superbase tables. This enables seamless integration of data coming from cloud storage, SFTP/FTP servers, APIs, or inbound webhooks - all with minimal setup.

    With this capability, teams can unlock fast and reliable ingestion of structured or semi-structured data without needing to manage ETL infrastructure. Couchdrop handles the heavy lifting of getting data into Superbase so it’s immediately available for analysis.

    How Superbase works with Couchdrop

    Superbase is configured in Couchdrop as a platform integration. This type of integration does not appear directly as a as Couchdrop needs to understand how to translate the data into rows in Superbase.

    Instead; Superbase is configured as a connection and then you can use this connection as a file action inside an or .

    When you configure the file action - you provide details about the data table schema in Superbase and how that maps to the data files being ingested by Couchdrop.

    Requirements

    To connect to Supabase in Couchdrop you will need:

    • A Supabase account, with a table created that you want to upload data into

    • Access credentials, such as your project ID and access key

    • Your project ID is typically found in the URL in Supabase, if you navigate to your Supabase project, https://supabase.com/dashboard/project/<project-id>

    Configuration Steps

    1. Log in to Couchdrop and add a new system integration

    2. Select Superbase from the list of available integrations

    3. Provide the details above

    4. Click Add System Integration and follow the wizard

    Azure Queue

    How to connect using the Azure Queue system integration

    Introduction to Azure Queue with Couchdrop

    Couchdrop supports streaming data directly into Azure Queue through file actions and automations, making it effortless to bridge file-based workflows with event-driven architectures. Instead of writing custom code or maintaining integration middleware, Couchdrop can take files or payloads from virtually any source - cloud storage, SFTP/FTP, APIs, or inbound webhooks - and automatically publish them as messages to your Azure queues.

    Using Couchdrop’s automations with Azure Queue, you can transform traditional file transfers into real-time, event-driven pipelines.

    How Azure Queue works with Couchdrop

    Azure Queues are configured in Couchdrop as a platform integration. This type of integration does not appear directly as a as Couchdrop, rather Azure Queue is configured as a connection that you can use in a file action inside an or .

    Requirements

    To connect to Azure Queue in Couchdrop you will need:

    • An Azure account, with an azure queue created within a storage account - take note of the queue name, and the storage account name

    • An access key for the storage account

    Configuration Steps

    1. Log in to Couchdrop and add a new system integration

    2. Select Azure Queue from the list of available integrations

    3. Provide the details above

    4. Click Add System Integration

    Creating Users

    Learn how to create and add users to Couchdrop

    Creating users in Couchdrop is a simple process and can be done a couple of different ways.

    Jump to our video guide on how to create users manually

    Creating Users Manually

    To add a user to Couchdrop manually:

    • Login to Couchdrop

    • Navigate to Administration --> Users

    • Click Create New User

    From here, you will need to provide details for their account:

    • Pick a username, this needs to be unique across Couchdrop

    • Supply an email address. This is optional but is important if you expect the user to be used for more than just SFTP and FTP access

    • Set a password.

    • Choose the user's role

    The final step is choosing the user's root directly. Information on what is a root directory can be found .

    Inviting Users to Couchdrop

    Users can be invited via email to Couchdrop. When invited, users will be provided with a password and basic settings.

    To invite users to Couchdrop:

    • Login to Couchdrop

    • Navigate to Administration --> Users

    • Click the ... menu button and choose Invite User

    Logging

    Learn about logging and SIEM support in Couchdrop

    Couchdrop supports multiple external logging provider like Splunk, Datadog, Azure Monitor (Sentinel), Elastic and general Webhooks to send Couchdrop events as logging data to in a json format.

    Select one or multiple of the logging provider to connect to

    Event Types

    Options for events to send are

    • Login

    • Admin changes

    • Failures

    • File based actions

    Example Couchdrop JSON Event

    Datadog

    Learn how to send events to Datadog from Couchdrop

    Requirements

    Required Configuration

    To connect to Datadog you will need:

    • Datadog Application Key

    • Datadog API Key

    Optional Configuration

    You can configure these optional attributes

    • Datadog integration name (ddsource)

    • Datadog Tags (ddtags)

    • Originating Hostname (hostname)

    • Service Name (service)

    To learn how to setup Datadog API access you can visit

    Configuration Steps

    1. Log in to Couchdrop and navigate to the Admin Panel - Logging

    2. Select Connect/Manage on the Datadog Provider Pill

    3. Select the Events to send to Datadog

    4. Configure the required and optional Datadog fields

    Splunk

    Learn how to send events to Splunk from Couchdrop

    Requirements

    Required Configuration

    To connect to Splunk you will need:

    • Event Collector token

    • HTTP Event Collector URI

    Optional Configuration

    You can configure these optional attributes

    • Originating Host

    • Event Source Application

    • Sourcetype value for the event

    • Index name

    To learn how to setup Splunk API access you can visit

    Configuration Steps

    1. Log in to Couchdrop and navigate to the Admin Panel - Logging

    2. Select Connect/Manage on the Splunk Provider Pill

    3. Select the Events to send to Splunk

    4. Configure the required and optional Splunk fields

    Microsoft Sentinel

    Learn how to send events to Azure Monitor to use with Microsoft Sentinel from Couchdrop

    Requirements

    Required Configuration

    To connect to Azure Monitor you will need:

    • Azure Tenant ID

    • Azure Client ID

    • Azure Client Secret

    • Log Ingestion Endpoint

    To learn how to setup Azure Monitor API access you can visit

    Configuration Steps

    1. Log in to Couchdrop and navigate to the Admin Panel - Logging

    2. Select Connect/Manage on the Microsoft Sentinel Provider Pill

    3. Select the Events to send to Azure Monitor

    4. Configure the required Azure Monitor fields

    Two Factor Authentication

    Learn about configuring MFA/2fa in Couchdrop

    Overview

    Couchdrop supports MFA/2FA natively through an integration with Authy (by Twilio). All users can configure 2fa for the Couchdrop Web App and when they first login to Couchdrop.

    Authy supports SMS based 2FA and QR code based authenticator apps like the Microsoft Authenticator, 1password and the Google Authenticator. Setup is quick and easy and users can self manage.

    Enabling 2FA does not restrict SFTP and FTP access. 2FA is only supported for the web app.

    Enabling Two Factor Authentication

    Users can self manage 2fa by logging into the Couchdrop Web App and clicking on their user profile.

    Forcing the use of MFA/Two Factor Authentication

    Couchdrop now supports 2fa enforcement via a new security option. When enabled, users who have not configured 2fa will be required to configure it the next time they login.

    How to Enable

    To enable 2fa enforcement;

    1. Login to Couchdrop as the owner

    2. Click Administration --> Security

    3. Under Password Policies, toggle the checkbox for Enforced MFA

    Debugging issues

    Couchdrop administrators with permissions to manage users can disable 2fa for users in their tenant. Disabling 2fa for a user will allow the user login to Couchdrop without 2fa and retry configuration.

    Administrators cannot modify the global security settings or disable 2fa on the account owner. Contact support for help with issues accessing the owner account.

    Malware Scanning

    Learn about Malware Scanning in Couchdrop

    Introduction

    Couchdrop has support for scanning data prior to uploading through our integrated malware scanner. This functionality is an additional paid add-on, so reach out to [email protected] if you do not have it enabled.

    Malware scanning must be configured on folders to become active. This is because most customers do not want it across the board.

    Malware FAQs

    Why do I need Couchdrop Malware Scanning?

    Couchdrop's automated malware scanning provides an additional layer of protection for customers who are receiving files from external parties and wish to ensure the integrity of the files entering their infrastructure and file pipelines. While many cloud platforms (SharePoint, Dropbox, Google Drive, etc.) have a layer of protection, other platforms do not offer this natively.

    How do I enable Malware Scanning?

    Access to this functionality can be requested via . Once enabled, you can enable malware scanning for specific folders.

    What is the underlying Malware Scanning mechanism?

    Malware Scanning is provided by ClamAV ()

    Malware scanning is limited to files that are 1GB or less.

    Is it possible to modify the scanning behaviour?

    No. Admins cannot adjust the scan behaviour. Where can I find events generated by Malware Scanning?

    Events will appear as "malware_scan_failed" under the reporting section of your admin portal.

    Which storage platforms support Malware Scanning?

    You can enable Malware Scanning for any storage platform that can be connected to Couchdrop. Once you have connected your storage to Couchdrop, you must enable scanning on that folder.

    Using SFTP with Azure Blob

    Couchdrop natively supports transferring files in Azure Blob via SFTP.

    Overview

    Couchdrop supports Azure Blob and SFTP - facilitating the easy transfer of data to and from Azure Blob containers. Setup and configuration is simple and only takes a couple of minutes.

    What is Azure Blob

    Azure Blob is an offering in Azure from Microsoft. It is a horizontally scalable block storage platform for storing large volumes of data in and is a common tool in the toolbox for companies adopting Azure for infrastructure.

    What is SFTP

    SFTP is the most widely adopted protocol for securely sending and retrieving files in a system to system environment.

    Requirements

    To use SFTP with Azure Blob - there are a couple of things you will need

    1. An Couchdrop account - you can register at

    2. An Azure Blob container and access to the Azure portal as an administrator

    3. 5 minutes spare and a coffee

    Configuration Steps

    1. Connect Couchdrop and Azure Blob. This is outlined .

    2. Create an SFTP user in Couchdrop and attach them to the Azure folder. Configuring SFTP users in Couchdrop is detailed in .

    3. Connect and test

    How it Works

    When you connect Couchdrop and Azure - you create a virtual pipe that transports data on demand. Couchdrop provides you with an account and set of credentials to use in your SFTP client or application using SFTP. Files uploaded or downloaded via that SFTP account through Couchdrop will be uploaded or downloaded to/from Azure Blob.

    The transfer process is performed in Couchdrop's secure platform and is transparent to the end user or system.

    Users and Groups

    Learn about managing Users and Groups in Couchdrop

    Managing Users In Couchdrop

    User management in Couchdrop is done under Administration --> Users or under the Users section from the main navigation.

    Elastic

    Learn how to send events to Logstash to use with Elastic from Couchdrop

    Requirements

    Required Configuration

    To connect to Logstash you will need:

    • Elastic Username

    • Elastic Password

    • Elastic Url

    To learn how to setup Logstash Http input plugin you can visit

    Configuration Steps

    1. Log in to Couchdrop and navigate to the Admin Panel - Logging

    2. Select Connect/Manage on the Elastic Provider Pill

    3. Select the Events to send to Logstash

    4. Configure the required Logstash fields

    Upload Links/Web Forms

    Learn the steps to create a simple web upload inbox with Couchdrop

    Introduction

    Upload Links in Couchdrop provide a simple way to request and receive files using a secure web link. They provide a brand-able, secure web portal where clients, partners, and customers can easily upload files directly to your cloud storage without needing accounts or access to your internal systems.

    Connect to SFTP

    Learn how to connect Couchdrop to an external SFTP server folder

    Introduction

    Couchdrop can be connected to an external SFTP server in just a few steps. Once connected, you can seamlessly upload and download files directly to the external SFTP platform. You can also take advantage of Couchdrop’s automation features and inbound transfer methods - such as mailboxes and upload links - to streamline and simplify data transfers.

    Workato

    Learn about Couchdrop's native Workato integration.

    Introduction to Workato with Couchdrop

    Workato is a leading iPaaS (Integration Platform as a Service) solution for SMB and enterprise customers. iPaaS platforms like Workato enable no-code integrations between internal systems - for example, connecting Salesforce with Zendesk.

    Couchdrop is a Managed File Transfer (MFT) and SFTP platform designed to simplify secure B2B file transfers. It acts as a secure file transfer gateway for Workato, allowing Workato customers to receive files via SFTP, FTP, and other MFT protocols, and then pass them into Workato for internal processing.

    Zapier

    Learn about sending files from Couchdrop into Zapier Zaps.

    Introduction to Zapier with Couchdrop

    Zapier is a leading iPaaS (Integration Platform as a Service) solution for consumers and small businesses. iPaaS platforms like Zapier enable no-code integrations between internal systems - for example, connecting Salesforce with Zendesk.

    Couchdrop is a Managed File Transfer (MFT) and SFTP platform designed to simplify secure B2B file transfers. It acts as a secure file transfer gateway for Zapier, allowing Zapier customers to receive files via SFTP, FTP, and other MFT protocols, and then pass them into Zapier for internal processing.

    How Zapier works with Couchdrop

    Snowflake

    Learn about streaming data into snowflake using Couchdrop.

    Introduction to Snowflake with Couchdrop

    Couchdrop’s native support for inserting data into Snowflake through file actions makes it incredibly simple to move data from virtually any source into your data warehouse. You can configure Couchdrop to automatically ingest files and stream their contents directly into Snowflake tables. This enables seamless integration of data coming from cloud storage, SFTP/FTP servers, APIs, or inbound webhooks - all with minimal setup.

    With this capability, teams can unlock fast and reliable ingestion of structured or semi-structured data without needing to manage ETL infrastructure. Couchdrop handles the heavy lifting of getting data into Snowflake so it’s immediately available for analysis.

    Amazon SQS

    How to connect using the SQS system integration

    Introduction to Amazon SQS with Couchdrop

    Couchdrop supports streaming data directly into Amazon SQS through file actions and automations, making it effortless to bridge file-based workflows with event-driven architectures. Instead of writing custom code or maintaining integration middleware, Couchdrop can take files or payloads from virtually any source - cloud storage, SFTP/FTP, APIs, or inbound webhooks - and automatically publish them as messages to your SQS queues.

    Using Couchdrop’s automations with SQS, you can transform traditional file transfers into real-time, event-driven pipelines.

    User Roles

    Couchdrop has a very simple role structure. When thinking about users in Couchdrop, there are Internal Users and External Users.

    Internal Users

    Internal Users are users within your organisation. Typically, they are management users with permission to configure and manage file transfers and can create/manage External Users.

    Folder Permissions

    Learn about configuring folder permissions in Couchdrop

    Couchdrop allows administrators to define complex permissions on folders and their child files. Permissions apply across the board regardless of the accessing system and can be used to ensure that appropriate access levels are maintained.

    Folder Permissions

    When viewing a folder, permissions can be applied. Couchdrop applies an inheritance model to permissions, which means folders inherit the permissions of their closest parent.

    When enabling permissions on a folder you must keep in mind:

    SSO and Single Sign-on

    Learn about configuring SSO and single sign-on in Couchdrop

    Configuring SSO with Couchdrop

    SAML SSO

    Couchdrop can be configured for SAML authentication via the web interface.

    Pre-Requisites

    Users must already exist in Couchdrop for SAML login and as Couchdrop supports login via SFTP and FTP, they must have a password set as well. SAML Login is only available through the web interface.

    OpenSSH SFTP

    Learn how to use the default SFTP client in Linux and Unix operating systems

    OpenSSH, which is a suite of secure networking utilities based on the SSH (Secure Shell) protocol, includes a command-line utility for interacting with SSH servers for file transfer purposes. This utility is simply called sftp.

    How to use OpenSSH SFTP

    Here's a brief overview of how to use the sftp command:

    Custom Domains

    Learn about custom domains and whitelabelling in Couchdrop

    Create your own secure, customer-facing file transfer portals by applying your branding to Couchdrop. Before beginning this process, we recommend you have good quality logos and your brand guide (with hex colors) available.

    Configure Couchdrop Whitelabelling

    1. Log in to Couchdrop as the Owner user.

    BigQuery

    How to connect using the BigQuery system integration

    Introduction to BigQuery with Couchdrop

    Couchdrop’s native support for inserting data into BigQuery through file actions makes it incredibly simple to move data from virtually any source into your data warehouse. You can configure Couchdrop to automatically ingest files and stream their contents directly into BigQuery tables. This enables seamless integration of data coming from cloud storage, SFTP/FTP servers, APIs, or inbound webhooks - all with minimal setup.

    With this capability, teams can unlock fast and reliable ingestion of structured or semi-structured data without needing to manage ETL infrastructure. Couchdrop handles the heavy lifting of getting data into BigQuery so it’s immediately available for analysis.

    Add the partner's signing certificate provided by them.

  • Once you are done, click Save and Back.

  • Internal users are managed from the Administration --> Users section of the Couchdrop interface. Internal users can only be managed by users who have the Owner or Administrator role

    External Users

    External Users are users that are sending and/or receiving files to/from your organisation. These accounts are normally very limited in scope and are often headless.

    External users can be managed under Users in the main navigation if you are an Owner, Administrator, or Manager, as well as from the Administration --> Users page.

    Available Roles in Couchdrop

    Couchdrop has four different types of user accounts.

    Role
    User Type
    Description

    Owner

    Internal

    The account owner. Owner accounts have access to all functionality and settings, including billing and advanced security settings.

    There can only be one Owner per Couchdrop account.

    Administrator

    Internal

    Administrators have access to the Administration section of Couchdrop, but are still restricted in terms of what data they can access.

    Team Members

    Internal

    Team members in Couchdrop cannot access the Administration section, but they can create and manage External Users, create shared links, inboxes, mailboxes and other parts of the system used to exchange and transfer files.

    External Users

    External

    External users are restricted accounts used for system or client access via SFTP, FTP, or the web interface to upload and download files in assigned folders. They have no access to administration features.

    When creating a user, you must specify a role. This role can be adjusted at any time.

    Feature Restrictions

    Feature access can be managed at multiple levels.

    Level
    Configuration Location
    Description

    Globally

    Administration -> Security Settings

    Update default access to features for all Managers and Standard Users across the Couchdrop account.

    Group Level

    Administration -> Groups

    Features can be enabled for all members of a specified group.

    User Level

    Administration -> Users

    Features can be enabled for an individual Standard User or Manager.

    Navigate to Administration → White labelling

  • White labelling can be configured separately for the main Couchdrop web portal and/or the Shared Link and Inbox landing pages. Check the options you wish to enable and provide a Company Name. Optionally, provide your own domain which is configured to point to Couchdrop. Use a DNS CNAME for this, eg: files.mycompany.com -> mycompany.couchdrop.io

  • Enter hex codes for your custom colors and upload your logos. You may need to manipulate the dimensions of your logo files to best suit the page layout before uploading them. Portal settings apply to the main Couchdrop login page and web portal interface. Inbox Branding applies to Shared Links and Inboxes.

  • Click Save Settings when all configuration is complete.

  • Choose a subfolder from the folder selector

  • Click Save Settings

  • File Actions (copy, move)

    Yes

    Transfer Automations

    Yes

    Inbound SFTP and FTPs

    Yes

    Inbound Mailboxes

    Yes

    Upload Links

    Yes

    Inbound Web hooks (https)

    Yes

    Inbound AS2

    Yes

    Inbound S3 (S3 Gateway)

    Yes

    here
    The Root Directory

    Click Save Updates

    https://docs.datadoghq.com/api/latest/logs

    Click Save Updates

    https://docs.splunk.com/Documentation/SplunkCloud/latest/Data/UsetheHTTPEventCollector
    DCR Immutable ID
  • Stream Name

  • Click Save Updates

    https://learn.microsoft.com/en-us/azure/azure-monitor/logs/logs-ingestion-api-overview
    [email protected]
    https://www.clamav.net

    Click Save Updates

    https://www.elastic.co/docs/reference/logstash/plugins/plugins-inputs-http
    https://filezilla-project.org/download.php?type=client
    https://cyberduck.io/
    https://my.couchdrop.io
    here
    this article
    How Workato works with Couchdrop

    Workato is configured in Couchdrop as an outbound connection. You link a Couchdrop folder to a Workato recipe via a webhook trigger. Any file uploaded into that folder is securely delivered to Workato, which then runs the recipe you have defined.

    Requirements

    • Admin access in Couchdrop

    • A Workato recipe with a Webhook trigger

    • The following details from Workato:

      • Webhook URL generated from the trigger

      • Authentication method (if required for your webhook)

    Workato has a file size limit of 5 MB for webhook payloads

    Configuration Steps

    Set Up the Recipe in Workato

    • Create a new recipe

    • Select Webhook as the trigger

    • Copy the Webhook URL generated for the recipe

    • If authentication is enabled for the webhook, take note of the username/password or token

    Configure the Connection in Couchdrop

    • Add a new outbound connection

    • Select Workato and provide:

      • A name for the integration

      • A folder name (creates a Couchdrop folder that sends files to Workato)

      • The Webhook URL (and credentials if required) from Workato

    • Save the configuration

    Any files uploaded into the Couchdrop folder will now be sent automatically to your Workato recipe.

    Common Issues

    Files larger than 5 MB will be rejected by Workato

    Workato cannot process files that are larger than 5MB.

    Invalid authentication method

    Ensure the authentication method in Couchdrop matches the webhook configuration in Workato.

    Zapier is configured in Couchdrop as an outbound connection. You link a Couchdrop folder to a Zapier Zap via a webhook trigger. Any file uploaded into that folder is sent to Zapier, which then starts the Zap you have defined.

    Requirements

    • Admin access in Couchdrop

    • A Zapier Pro subscription (required for webhook triggers)

    • A Zap in Zapier with a Webhook trigger (Catch Raw Hook)

    • The Webhook URL generated by Zapier

    Configuration Steps

    Set Up the Zap in Zapier

    • Create a new Zap

    • Choose Webhooks by Zapier as the trigger and set it to Catch Raw Hook

    • Copy the Webhook URL from Zapier

    Configure the Connection in Couchdrop

    • Add a new outbound connection

    • Select Zapier and provide:

      • A name for the integration

      • A folder name (creates a Couchdrop folder that sends files to Zapier)

      • The Webhook URL from Zapier

    • Save the configuration

    Any file uploaded into the Couchdrop folder will now be delivered automatically to your Zap in Zapier.

    Common Issues

    Zapier requires a Pro subscription to use webhook triggers.

    Webhook triggers in Zapier are only available on Pro or higher subscription plans. This means that if you are using Couchdrop with Zapier and you need to initiate workflows based on incoming webhook events (for example, triggering an automation when a file is uploaded or moved), you must have at least a Zapier Pro subscription

    Files larger than 5 MB will be rejected by Zapier.

    Zapier will not process files that are larger than 5MB

    If Zapier cannot ingest a file, you’ll receive an email notification from Zapier with details.

    How Amazon SQS works with Couchdrop

    SQS is configured in Couchdrop as a platform integration. This type of integration does not appear directly as a virtual folder as Couchdrop, rather SQS is configured as a connection that you can use in a file action inside an Transfer Automations or File Actions.

    Requirements

    To connect to SQS in Couchdrop you will need:

    • An SQS queue already configured - take note of the queue name

    • An AWS IAM Key

    • An AWS IAM Secret

    • The AWS region

    • The IAM role must have adequate access to SQS and the targeted queue

    Configuration Steps

    1. Log in to Couchdrop and add a new system integration

    2. Select SQS from the list of available integrations

    3. Provide the details above

    4. Click Add System Integration

    SAML SSO

    Learn how to configure SSO through a SAML IDP in Couchdrop

    Azure SCIM and SSO

    Learn how to configure Couchdrop to sync user identities with Azure

    Okta Configuration

    Learn how to configure Couchdrop to integrate with Okta

    How BigQuery works with Couchdrop

    BigQuery is configured in Couchdrop as a platform integration. This type of integration does not appear directly as a virtual folder as Couchdrop needs to understand how to translate the data into rows in BigQuery. BigQuery is configured as a connection and then you can use this connection as a file action inside an Transfer Automations or File Actions.

    When you configure the file action - you provide details about the data table schema in BigQuery and how that maps to the data files being ingested by Couchdrop.

    Requirements

    To connect to BigQuery in Couchdrop you will need:

    • A BigQuery account, with a table created that you want to upload data into

    • Information about your table in BigQuery, such as your project ID, your dataset name and your table name

    • Service credentials JSON file

      • You can create this within the APIs & Services -> Credentials section in Google Admin Console

      • Create a service account, and then create a key for that account, and download the JSON file associated to use within Couchdrop

    Configuration Steps

    1. Log in to Couchdrop and add a new system integration

    2. Select BigQuery from the list of available integrations

    3. Provide the details above

    4. Click Add System Integration

    5. Create an automation or file action and select BigQuery as the platform type.

    Storage account name

  • Access key or a SAS token

  • Container name

  • Allowed permissions: Read, Write, List, Delete (depending on Couchdrop use)

  • Set start and expiry date.

  • Click Generate SAS and copy the SAS token.

  • Storage Account Name

  • Container Name

  • Authentication Method:

    • If using Access Key → paste the key.

    • If using SAS Token → paste the full SAS URL or token.

  • Optionally choose a folder in Azure

  • Azure Access Controls

    Supported via static IP in Couchdrop

    Uploading Files

    Yes

    Downloading Files

    Yes

    Listing files and folders

    Yes

    Creating folders

    Yes

    Deleting folders

    Yes

    Deleting Files

    Yes

    Endpoint (Simple URL Path)

  • Username and Token from Shared Web Server → User Management

  • The Boomi Environment API URL, Endpoint, Username, and Token

  • Save the configuration

  • In Couchdrop, the Supabase URL field is typically https://<project-id>.supabase.co
  • Your access key can be generated from within your account settings -> access tokens, within Supabase https://supabase.com/dashboard/account/tokens

  • A location or inbound method in Couchdrop that you are ingesting data into.

  • Create an automation or file action and select Superbase as the platform type.

    virtual folder
    Transfer Automations
    File Actions
    virtual folder
    Transfer Automations
    File Actions

    Monthly

    Triggers monthly at a specified day and time

    1, 12:00PM

    Triggers on the first of the month at noon.

    Never

    Automation will not trigger on a schedule

    Used to pre-configure automations for later

    Weekly

    Triggers once per week on a specific day and time

    Friday, 12:00PM

    Triggers every Friday at noon.

    Daily

    Once per day

    11:00 PM

    Triggers at 11:00PM every day.

    Frequency (minutes)

    Triggers at the configured interval, from every 5 minutes up to every 59 minutes.

    15

    Triggers every 15 minutes.

    Hourly

    Triggers every hour at a specified minute

    45

    All Files in Folder

    Applies the automation to all files in the folder

    All Files in Folder and Subfolders

    Applies the automation to all files in the folder and all of its subfolders

    File

    Applies to a specific files specified here.

    HTTP(s) File

    Configure an HTTP/S URL and specify HTTP Method (GET, POST, PUT) with the option to request additional headers.

    Automation Builder

    Triggers at 45 minutes past the hour, every hour.

    {YYYY}

    2023

    The current timestamp year

    {YY}

    23

    The current timestamp year in shortform

    {MMM}

    AUG

    The month in a human readable format

    {MM}

    03

    The month in a numerical format

    {DD}

    02

    The day of the month

    {TIME_HH}

    23

    Hour in 24 hour time

    {TIME_MM}

    30

    Minutes of the hour

    {TIME_SS}

    24

    Seconds on the minute

    {TIMESTAMP}

    1711330141

    Unix timestamp. Number of seconds since Jan 1st 1970.

    {TIMESTAMP_MS}

    1659992501

    Timestamp with milliseconds when the workflow was triggered

    {EVENT.EVENT_TYPE}

    download

    Event type that executed the workflow

    {EVENT.SYSTEM}

    webportal

    Specifies the channel where the workflow was originated

    {EVENT.STORAGE_ENGINE}

    googledrive

    Storage type name where the workflow was originated

    {EVENT.STORAGE_ENGINE_ID}

    4c0a140-9177-4581-98d3-4ea7215364aa

    Unique identifier of the configured storage where the workflow was originated

    {EVENT.TIMESTAMP}

    1659442224.463902

    Raw timestamp value of the event triggered in the workflow

    {EVENT.EVENT_ID}

    bef26414-b7c1-41de-986e-98de45abcd

    Unique identifier of the event triggered every time a workflow is executed. All actions configured int he same workflow will share the same event ID.

    {EVENT.additional_info.required_fields.<FIELD_NAME>}

    Substitute <field_name> with the name of the Web Inbox required field to access data provided on upload.

    {USER}

    michael.lawson

    The user who was uploading the file

    {EXISTING_NAME}

    test.txt

    The current filename

    {EXISTING_NAME_NOEXT}

    test

    The current filename without the extension

    {EXISTING_NAME_EXT}

    .txt

    Supported Actions

    The extension only of the current filename

    How Snowflake works with Couchdrop

    Snowflake is configured in Couchdrop as a platform integration. This type of integration does not appear directly as a virtual folder as Couchdrop needs to understand how to translate the data into rows in Snowflake.

    Instead; Snowflake is configured as a connection and then you can use this connection as a file action inside an Transfer Automations or File Actions.

    When you configure the file action - you provide details about the data table schema in Snowflake and how that maps to the data files being ingested by Couchdrop.

    Requirements

    To connect to Snowflake in Couchdrop you will need:

    • A snowflake account and access to the table you are working with

    • Access credentials; account ID, access key

    • A location or inbound method in Couchdrop that you are ingesting data via

    Configuration Steps

    1. Log in to Couchdrop and add a new system integration

    2. Select Snowflake from the list of available integrations

    3. Provide the details above

    4. Click Add System Integration and follow the wizard

    5. Create an automation or file action and select Snowflake as the platform type.

    Common issues connecting to Snowflake

    For a comprehensive guide on generating an access token, see https://docs.snowflake.com/en/user-guide/programmatic-access-tokens

    The network policy setup for your user in Snowflake can block us from authenticating and connecting to your Snowflake account. The authentication policy setup for your user in Snowflake can prevent the network policy from blocking us, if it is an issue, by running

    The authentication policy can also block us from connecting if the authentication methods have been configured, and do not include PROGRAMMATIC_ACCESS_TOKEN in the available authentication methods. To see if this is the case you can run

    To add the authentication method to your authentication policy, you can run

    To generate the programmatic access token

    Connecting to a Server:

    • To connect to an SSH server using SFTP, you would typically use the following command:

    • Replace username with your username on the server and hostname with the hostname or IP address of the server.

  • Authenticating:

    • After executing the command, you will be prompted to enter your password for the specified username.

  • Navigating Directories:

    • Once connected, you'll be in the SFTP interactive shell, similar to a command-line interface.

    • You can use commands like ls, cd, and pwd to navigate directories on the server.

  • Transferring Files:

    • To upload a file from your local machine to the server, you can use the put command:

    • To download a file from the server to your local machine, you can use the get command:

  • Exiting SFTP:

    • To exit the SFTP session, you can use the exit command:

    • Or simply type exit and press Enter.

  • The sftp command-line utility provides a straightforward way to perform secure file transfers over SSH connections without needing a separate FTP client. It's often used in scripting and automation tasks where manual interaction isn't required.

    Using OpenSSH SFTP with Couchdrop

    Couchdrop supports the default sftp command natively. Simply switch out the hostname and credentials from the example above.

    {
        "id": "",
        "event_id": "",
        "token": "",
        "account": "",
        "organisation_id": "",
        "filename": "",
        "filename_relative": "",
        "path": "",
        "relative_path": "",
        "timestamp": 1750721574,
        "TimeGenerated": "2025-06-24T11:32:54.000Z",
        "authenticated_user": "",
        "authenticated_user_id": "",
        "storage_engine": "",
        "storage_engine_id": "",
        "event_type": "",
        "ip_address": "",
        "success": true,
        "total_size": 0,
        "file_size": 0,
        "additional_info": "",
        "system": "",
        "transaction_id": "",
        "region": "",
        "workflow_id": "",
        "workflow_action": "",
        "node": "",
        "message": "",
        "is_support_generated": false,
        "inbox_id": "",
        "shared_link_id": "",
        "error_type": "",
        "error_message": "",
        "error_original": "",
        "elapsed": 0,
        "as2_mdn_payload": "",
        "as2_station_id": "",
        "inbound_s3_bucket_id": "",
        "inbound_s3_bucket_key_id": "",
        "sender": "",
        "ingress_retry": 0,
        "text": "",
        "ingress": true,
        "ingress_status": {}
    }
    CREATE|ALTER AUTHENTICATION POLICY <my_policy_name>
      PAT_POLICY=(
        NETWORK_POLICY_EVALUATION = NOT_REQUIRED
      );
    DESCRIBE AUTHENTICATION POLICY <authentication_policy_name>;
    ALTER AUTHENTICATION POLICY <authentication_policy_name>
      SET AUTHENTICATION_METHODS = ('PROGRAMMATIC_ACCESS_TOKEN');
    ALTER USER IF EXISTS <example_user> ADD PROGRAMMATIC ACCESS TOKEN example_token;
    sftp username@hostname
    put localfile.txt
    get remotefile.txt
    exit
    sftp [email protected]
    Requirements

    To setup an inbox, generally you will need the following:

    • Access to Couchdrop, with the appropriate user rights. Talk to your admin to get these.

    • A location for the files to be uploaded to.

    How to create the Upload Link

    To create the inbox, follow the steps below:

    1. From the Couchdrop dashboard - click "+ Create" -> Create Upload Link. If you don't see this option, talk to your administrator.

    2. Provide a name for the inbox. This is simply so you can identify it.

    3. Select a location for files to arrive. This is the place where user delivered files will be located. You can choose an existing folder, or configure a new cloud storage connection here. Once you are done, click Save and Continue.

    4. Click Save and Continue and skip over the Email Inbox step

    Now you will see your newly created Inbox. Copy the web url field by clicking Web Link and test it.

    Forms and metadata

    Forms are a useful feature for long term inboxes. Often Couchdrop customers need to collect details from the uploader. Details like a email address or phone number, or file description are needed as part of the upload.

    Couchdrop provides this by offering dynamic fields that can be configured on each upload link. Users will them be required to fill in each field during upload. This data is them attached to the upload event and can be used in file actions (automations) and written to a CSV file in the same location as the uploaded files.

    File actions and automations

    Upload links can be coupled with automations called File Actions. File Actions are automations that fire when an upload event happens and can perform various actions on the file.

    An example:

    When a file is uploaded - we collect the email address using a dynamic field. The file is then moved to a folder after upload.

    Security Options for Upload Links

    Upload links are accessible publicly by default - you can customize access with the security features listed below.

    Feature
    Description

    Password

    Require a password before accessing the upload link.

    Expiry

    This link is only available up to the expiry time

    Email Verification

    Require email verification using MFA before uploading files to the link

    Feature Support

    Upload Links are supported in Couchdrop across the platform.

    Feature
    Supported

    API creation

    Yes

    File Actions

    Yes

    Cloud Storage

    Yes

    Auditing

    Yes

    Automatic Expiry

    Yes

    White labeling

    Yes

    Requirements

    To connect to an external SFTP server with Couchdrop you will need:

    • The hostname or IP address and port number for the external server

    • A username and password for the external server or a private key

    Configuration Steps

    1. In Couchdrop; Click + Create -> Connect to Partners/Providers or + Add Connection from the Connections Tab

    2. Select SFTP Server from the list of available connections

    3. Provide the configuration details as listed above

    4. Click Test Connection

    5. Choose a subfolder from the folder selector

    6. Click Save Settings

    Most SFTP providers use port 22. If you are unsure - try this port first and if it fails chat with your provider.

    How it works

    Similar to all connections in Couchdrop - all external SFTP connections appear as folders in Couchdrop. Couchdrop can transfer to and from the external SFTP server directly or through automations.

    External SFTP providers appear as Virtual Folders in Couchdrop. We recommend learning about Virtual Folders here

    Supported features with external SFTP servers

    Feature
    Supported

    Inbound SFTP

    Yes

    Inbound Mailboxes

    Yes

    Upload Links

    Yes

    Inbound Web hooks (https)

    Yes

    Inbound AS2

    Yes

    Inbound S3 (S3 Gateway)

    Yes

    Frequently Asked Questions

    Do you support RSA key based authentication

    Yes - Couchdrop can use key based authentication to connect to external SFTP providers. You can upload a private key when configuring the connection.

    Can we schedule a copy from one SFTP server to the cloud

    Yes - this is Couchdrop's bread and butter. You can configure a connection to an external SFTP server - select a folder and then automate a transfer using a Scheduled Transfer Automation that polls the SFTP server for new files and then moves them.

    Can Couchdrop provide Static IPs that we can whitelist

    Yes - Contact our support team to request static IPs.

    Do you support legacy ciphers and keys

    Yes - we can support some restricted legacy ciphers. Contact our team if you run into connectivity issues.

    Are SFTP connections encrypted with Couchdrop

    Absolutely - SFTP as a protocol is very secure and uses asymetric SSL encryption.

    Common issues and errors

    Access denied

    Access denied when browsing, uploading or downloading files generally means that you do not have adequate permissions with the external platform. Contact the external providers support team to make sure you have permissions on there service.

    Timeout

    A timeout normally occurs when there a firewall preventing access. Check with the external provider and talk to our support team about static IPs for the external vendor to whitelist.

    By default, access to the folder will be denied to all users

  • Enabling permissions on a folder breaks the inherited permissions

  • To grant access you must:

    • Select a user or group for the permission

    • Add user roles.

    User roles in Couchdrop are very granular:

    Role Name
    Description

    List Contents

    Allow the listing of child files and folders

    Get Properties

    Get properties for child files and folders

    Delete

    Delete child files and folders

    Upload

    Upload files into this folder

    Download

    Download and read files in this folder

    Share

    Create shared links for files and folder

    Folder Sharing

    Folder sharing works the same as folder permissions with one caveat. If a folder is shared, then it will appear in the users root directory as a link.

    Folder sharing is enabled by checking "Appear in users home directory" when configuring permissions.

    Configuration Steps

    Enable SAML SSO

    Login to Couchdrop as the owner. Navigate to Administration --> SSO --> SAML SSO

    You will need to provide the following details to Couchdrop so that it can connect to your identity provider.

    Azure SAML Setup

    Required Fields

    Field
    Example
    Description

    SAML IDP Identity ID

    https://sts.windows.net/6c4526c1-a311-479b-af9c-1e0ecc4122be/

    (Microsoft Entra Identifier) See Step 4 of your Entra Single Sign-On App Settings.

    SAML IDP SSO URL

    https://login.microsoftonline.com/6c4526c1-a311-479b-af9c-1e0ecc4122be/saml2

    (Login URL) See Step 4 of your Entra Single Sign-On App Settings.

    SAML IDP Certificate

    -----BEGIN CERTIFICATE----- MIIC8DCCAdigAwIBAgIQeTBhv/RYZrpAXGf+yF185DANBgkqhkiG9w0BAQsFADA0MTIwMAYDVQQD ..... -----END CERTIFICATE----

    Certificate (Base64) See Step 3 of your Entra Single Sign-On App Settings.

    SAML IDP Email Attribute Key

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress

    The example provided is the default for all Microsoft Single Sign-On Apps.

    SharePoint - Restrictive Permissions (App Registration)

    This guide walks you through securely connecting SharePoint to Couchdrop using an application registered in Microsoft Entra, with access restricted to a specific site using the Sites.Selected permission.


    Prerequisites

    • Access to Microsoft Entra Admin Center

    • Admin rights to register apps and grant tenant-wide permissions

    • Access to

    Steps

    The process has three main steps that will be explained in detail.

    1. Configuring an Application in Entra

    2. Granting Site permissions to the Application in Microsoft Graph Explorer

    3. Connecting to SharePoint in Couchdrop using the configured Application


    Configuring an Application in Entra

    1. Register a New Application

    1. Go to

    2. Navigate to App registrations → + New registration

    3. Enter a name (e.g., Couchdrop-SharePoint)

    4. Leave all other options as default, then click Register


    2. Copy your new Client ID and Tenant ID

    After registration, you will be taken to a settings page for your new app. Copy the following from the Overview tab:

    • Application (client) ID

    • Directory (tenant) ID


    3. Create a Client Secret

    1. Go to Certificates & secrets

    2. Click + New client secret

    3. Provide a description (e.g., CouchdropSecret), select expiry, and click Add

    4. Copy the Value before leaving this screen


    4. Assign API Permissions

    Microsoft Graph API

    1. Navigate to API permissions → + Add a permission

    2. Select Microsoft Graph → Application permissions

    3. Find and check Sites.Selected

    4. Click Add permissions


    Granting site permissions to App via Microsoft Graph Explorer

    1. Retrieve the Site ID

    To find the SharePoint site's ID, open the following URL in your browser and replace elements in brackets with your tenant and Site information.

    Example:

    This will return an XML object containing the Site ID:


    2. Sign in to Graph Explorer

    1. Visit

    2. Sign in with your Microsoft account

    3. Click the user icon (top-right) → Consent to permissions

    4. Scroll down and grant Sites.FullControl.All to your user


    3. Send Permission Grant Request (for a specific site)

    ENDPOINT

    BODY

    Replace:

    • {site_id} with the GUID you retrieved earlier

    • <APPLICATION_CLIENT_ID> with your app’s Client ID

    • <APPLICATION_DISPLAY_NAME> with your app name (e.g., Couchdrop-SharePoint)

    Click Run Query. A successful response will return 201 Created.


    4. Send Permission Grant Request (root site)

    ENDPOINT

    BODY

    Replace:

    • <APPLICATION_CLIENT_ID> with your app’s Client ID

    • <APPLICATION_DISPLAY_NAME> with your app name (e.g., Couchdrop-SharePoint)

    Click Run Query. A successful response will return 201 Created.


    Connecting to SharePoint in Couchdrop using the configured Application

    1. Return to Couchdrop and choose to create a new SharePoint connector.

    2. Uncheck the option to use Delegated OAUTH Access to connect via Application Access.

    3. Complete the configuration using:

    • SharePoint Domain

    • Client ID

    • Directory (Tenant) ID

    • Client Secret

    4. You must then “Choose a folder” and manually specify the SharePoint subfolder path. This ensures Couchdrop connects to the exact SharePoint site you granted access to via Sites.Selected.

    Folder Path Syntax

    5. Click Test to verify that you have successfully assigned access. Select Add Integration to complete the process.

    Celigo

    Learn about Couchdrop's native Celigo integration.

    Introduction to Celigo with Couchdrop

    Celigo is a leading iPaaS (Integration Platform as a Service) solution for enterprise users. iPaaS platforms like Celigo enable no-code integrations between internal systems - for example, connecting Salesforce with Zendesk.

    Couchdrop is a Managed File Transfer (MFT) and SFTP platform designed to simplify secure B2B file transfers. It acts as a secure file transfer gateway for Celigo, allowing Celigo customers to receive files via SFTP, FTP, and other MFT protocols, and then pass them into Celigo for internal processing.

    How Celigo works with Couchdrop

    Celigo is configured in Couchdrop as an outbound connection. You link a Couchdrop folder to a Celigo flow via a webhook listener. Any file uploaded into that folder is securely delivered to Celigo, which then triggers the flow you have created.

    Requirements

    • Admin access in Couchdrop

    • A Celigo flow with a Webhook listener configured

    • The following details from Celigo:

      • Webhook URL (Public URL)

    Celigo has a 5 MB maximum file size limit for incoming files

    Configuration Steps

    Set Up the Flow in Celigo

    • Create a new flow

    • Add a Source and select Webhook

    • Name the webhook and continue

    • Under Secure the Listener, choose Basic and define a Username and Password (to be entered in Couchdrop)

    Configure the Connection in Couchdrop

    • Add a new outbound connection

    • Select Celigo and provide:

      • A name for the integration

      • A folder name (creates a Couchdrop folder that sends files to Celigo)

    Any files uploaded into the Couchdrop folder will now be sent automatically to your Celigo flow.

    Common Issues

    File size limit of 5MB

    Celigo has a file size limit of 5MB. This means files larger than 5MB will be rejected and will not be processed.

    Invalid content type

    Make sure the Content Type in Couchdrop matches what your Celigo webhook listener is configured to accept

    How to use SFTP with FileZilla

    Learn how to connect to an SFTP server with Filezilla in this simple walkthrough

    FileZilla is a popular open-source SFTP client used for transferring files between a client and a server over the internet. It has full support for FTP, FTPS (FTP over SSL/TLS), and SFTP (SSH File Transfer Protocol).

    FileZilla is available for various operating systems including Windows, macOS, and Linux. It provides a user-friendly interface for managing file transfers, directory listings, and remote file editing.

    FileZilla is widely used by web developers, system administrators, and anyone who needs to transfer files securely over the internet.

    Using FileZilla with SFTP

    Using FileZilla with SFTP (SSH File Transfer Protocol) is quite straightforward. Here's a step-by-step guide on how to do it:

    1. Download and Install FileZilla:

      • Visit the official FileZilla website () and download the appropriate version for your operating system.

      • Follow the installation instructions to install FileZilla on your computer.

    2. Open FileZilla:

    That's it! You've successfully used FileZilla with SFTP. Remember to always secure your login credentials and use SFTP for encrypted file transfers.

    Using FileZilla with Couchdrop

    Couchdrop supports FileZilla via SFTP and FTP. When configuring your server connection in the Site Manager, use the hostname, username and password provided in the Couchdrop admin interface.

    Google PubSub

    How to connect using the Google PubSub system integration

    Introduction to Google PubSub with Couchdrop

    Couchdrop supports streaming data directly into Google PubSub through file actions and automations, making it effortless to bridge file-based workflows with event-driven architectures. Instead of writing custom code or maintaining integration middleware, Couchdrop can take files or payloads from virtually any source - cloud storage, SFTP/FTP, APIs, or inbound webhooks - and automatically publish them as messages to your Google PubSub.

    Using Couchdrop’s automations with Google PubSub, you can transform traditional file transfers into real-time, event-driven pipelines.

    How Google PubSub works with Couchdrop

    Google PubSub are configured in Couchdrop as a platform integration. This type of integration does not appear directly as a as Couchdrop, rather Google PubSub is configured as a connection that you can use in a file action inside an or .

    Connecting Couchdrop to a Google PubSub queue is straight-forward

    Requirements

    To connect to Google PubSub queue in Couchdrop you will need:

    • A Google PubSub account, with a topic created that you want to upload data into

    • Information about your table in PubSub topic, such as your project ID and your topic name

    • Service credentials JSON file

      • You can create this within the APIs & Services -> Credentials section in Google Admin Console

    Configuration Steps

    1. Log in to Couchdrop and add a new system integration

    2. Select Google PubSub from the list of available integrations

    3. Provide the details above

    4. Click Add System Integration

    SCIM - Azure

    Learn about configuring Couchdrop to sync with Azure for accounts

    Supported Features

    • Push Users Users created in Azure will also be created in Couchdrop

    • Push User Updates User updates in Azure will be pushed to the corresponding users in Couchdrop

    SCIM - Okta

    Learn how to configure Couchdrop to sync with Okta

    This guide will help you if you want to provision Users between Okta and Couchdrop.

    Supported Features

    • Push Users Users created in Okta will also be created in Couchdrop

    How to use SFTP with Cyberduck

    Cyberduck is another popular open-source file transfer client, similar to FileZilla. Learn how to connect to an SFTP server with Cyberduck in this simple walkthrough.

    Cyberduck is another popular open-source file transfer client, similar to FileZilla. It's primarily used for transferring files to and from FTP, SFTP, WebDAV, and other cloud storage servers. Like FileZilla, Cyberduck is available for various operating systems including Windows and macOS.

    Cyberduck provides a user-friendly interface and supports drag-and-drop functionality for easy file transfers. It also offers features such as bookmarking, integration with external editors, and advanced file permissions management.

    Using Cyberduck with SFTP

    Using Cyberduck with SFTP is quite straightforward. Here's a step-by-step guide on how to do it:

    Make.com

    Learn about sending files to and performing operations in Couchdrop with Make.com.

    Introduction to Make.com with Couchdrop

    Make.com is a leading iPaaS (Integration Platform as a Service) solution for SMB users. iPaaS platforms like Make.com enable no-code integrations between internal systems - for example, connecting Salesforce with Zendesk.

    Couchdrop is a Managed File Transfer (MFT) and SFTP platform designed to simplify secure B2B file transfers. It acts as a secure file transfer gateway for Make.com, allowing Make.com customers to receive files via SFTP, FTP, and other MFT protocols, and then pass them into Make.com for internal processing.

    File Actions (copy, move)

    Yes

    Transfer Automations

    Yes

    Create Inbox

    Create an inbox for this folder and all children

    Manage Permissions

    Manage permissions on this folder

    Manage Notifications

    Manage notifications on this folder

  • After installation, launch FileZilla.

  • Connect to a Server:

    • In FileZilla, navigate to "File" > "Site Manager" or use the shortcut Ctrl+S (Windows/Linux) or Cmd+S (Mac) to open the Site Manager.

    • Click on the "New Site" button and give your site a name.

    • In the "Protocol" dropdown menu, select "SFTP - SSH File Transfer Protocol".

    • Enter the hostname (or IP address) of the server in the "Host" field.

    • Enter the port number if it's different from the default (22 for SFTP).

    • Choose "Normal" as the Logon Type.

    • Enter your username and password in the respective fields.

    • Click on "Connect" to save the settings and establish the connection.

  • Transferring Files:

    • Once connected, you will see the local files on the left side and remote files on the right side of the FileZilla interface.

    • Navigate through the directories to find the files you want to transfer.

    • To upload files from your local machine to the server, simply drag them from the local pane to the remote pane.

    • To download files from the server to your local machine, drag them from the remote pane to the local pane.

  • Managing Files:

    • You can create, delete, rename, and move files and directories directly from within FileZilla.

  • Disconnecting:

    • Once you're done with your file transfers, you can disconnect from the server by clicking on the "Server" menu and selecting "Disconnect".

  • Close FileZilla:

    • Finally, you can close FileZilla when you're finished with your transfers.

  • https://filezilla-project.org/
    How Make.com works with Couchdrop

    Make.com can be used with Couchdrop in two ways:

    • Sending files to Make.com: A Couchdrop folder is linked to a Make.com scenario through a custom webhook. When a file is uploaded into the folder, Couchdrop sends the file to the scenario.

    • Performing operations from Make.com: Couchdrop is available as a module in Make.com, allowing you to upload files, perform filesystem actions, and make management API calls.

    Requirements

    • Admin access in Couchdrop

    • Sending files to Make.com: ability to create a scenario using a Custom Webhook trigger

    • Performing Couchdrop operations from Make.com: access to the Couchdrop module in Make.com and a Couchdrop API Token (created in Couchdrop under Admin → API Tokens)

    Make.com has a 5 MB file size limit when receiving files from Couchdrop

    Configuration Steps: Sending Files from Couchdrop to Make.com

    Set Up the Webhook in Make.com

    • Create a new scenario

    • Add a Custom Webhook as the trigger

    • Name the webhook and copy the Webhook URL

    Configure the Connection in Couchdrop

    • Add a new outbound connection

    • Select Make.com and provide:

      • A name for the integration

      • A folder name (creates a Couchdrop folder that sends files to Make.com)

      • The Webhook URL from Make.com

    • Save the configuration

    Any files uploaded into the Couchdrop folder will now be sent automatically to your Make.com scenario.

    Configuration Steps: Performing Couchdrop Operations from Make.com

    • Open or create a scenario

    • Click + and search for Couchdrop

    • Choose the operation you want to perform:

      • Upload files into Couchdrop

      • Manage files and folders via the Filesystem API (list, download, rename, delete, create)

      • Manage users and permissions via the Management API

    • When prompted, create a Couchdrop API connection:

      • Enter a Couchdrop API Token (created in Couchdrop under Admin → API Tokens).

    • Configure the action fields as needed for your scenario

    👉 For details on available actions and their parameters, see the Couchdrop Filesystem API and Couchdrop Management API documentation.

    Custom domains

    Yes

    Content Type (application/json, application/xml, or application/x-www-form-urlencoded)

  • Username and Password defined in the Webhook listener

  • Generate the Webhook URL by clicking the plus button next to the Public URL field

  • Save the flow and keep the Webhook URL, Username, and Password handy

  • The Webhook URL, Content Type, Username, and Password from Celigo

  • Save the configuration

  • Create a service account, and then create a key for that account, and download the JSON file associated to use within Couchdrop

    virtual folder
    Transfer Automations
    File Actions
    (it won’t be shown again)
  • Click the checkmark Grant admin consent for [Your Org]

  • Microsoft Graph Explorer
    entra.microsoft.com
    Graph Explorer
    https://<tenant>.sharepoint.com/sites/<siteName>/_api/site/id
    https://couchdropdemo.sharepoint.com/sites/MySite/_api/site/id
    <d:Id xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml" m:type="Edm.Guid">29cf2814-a045-4b48-8b1b-6bd01f57d632</d:Id>
    POST https://graph.microsoft.com/v1.0/sites/{site_id}/permissions
    {
      "roles": ["write"],
      "grantedToIdentities": [
        {
          "application": {
            "id": "<APPLICATION_CLIENT_ID>",
            "displayName": "<APPLICATION_DISPLAY_NAME>"
          }
        }
      ]
    }
    POST https://graph.microsoft.com/v1.0/sites/root/permissions
    {
      "roles": ["write"],
      "grantedToIdentities": [
        {
          "application": {
            "id": "<APPLICATION_CLIENT_ID>",
            "displayName": "<APPLICATION_DISPLAY_NAME>"
          }
        }
      ]
    }
    /sharepointsite:/sites/<siteName>:/Documents/<optional-subfolder-path>
  • User deactivation Users deactivated in Azure will be deactivated in Couchdrop

  • Push Groups Groups created in Azure will also be created in Couchdrop

  • Push Group updates Group updates in Azure will be pushed to the corresponding users in Couchdrop

  • Group deactivation Groups deactivated in Azure will be deactivated in Couchdrop

  • Configuration Steps

    Create User Provisioning Token in Couchdrop

    Navigate to User Provisioning in Couchdrop’s interface and create a new Provisioning Token. This will be used in the Azure Active Directory provisioning process.

    Configure Enterprise Application in Azure Active Directory

    Navigate to your Administration dashboard in Microsoft’s admin portal and create an enterprise application.

    Provide a name for the application and select “Integrate any other application you don’t find in the gallery (Non-gallery)

    Next assign users and groups to the newly created application that you would like to have provisioned in Couchdrop.

    Select Add user/group

    Select the desired users or groups that should be provisioned through to Couchdrop then Select and Assign.

    Configure SCIM provisioning between Azure Active Directory and Couchdrop

    Navigate to the Provisioning Tab on the left hand side. Next select Get started to configure the tenant URL and the User Provisioning Token that was created in Step 1. Provisioning mode should be set to automatic. The Tenant URL is: https://api.couchdrop.io/scim/v2.

    Select Test Connection and Azure will attempt to connect as well and vwill retrieve schema information needed for the user and group mapping. If tested successfully then select Save.

    Configure user mapping

    Select Provision Azure Active Directory Users as required.

    Couchdrop requires the following user SCIM attributes for the SCIM system to be mapped, all others should be removed.

    Custom Application SSO Attribute

    userName

    active

    emails[type eq "work"].value

    name.givenName

    name.familyName

    externalId

    The externalId attribute may need to be remapped from mailNickname to objectId on the Azure Active Directory attribute side depending on your settings.

    Configure group mapping

    Select Provision Azure Active Directory Groups as required.

    Couchdrop requires the following user SCIM attributes for the SCIM system to be mapped.

    Custom Application SSO Attribute

    displayName

    externalId

    members

    Start the user and group provisioning process

    Navigate back to the custom application breadcrumb (in this case it’s Couchdrop SCIM) and to Provisioning. From here select the Start provisioning button.

    After the provisioning has completed running the first time a status should be required that indicates how many users and groups were provisioned within the Couchdrop product. Further information can be located by selecting View provisioning logs.

    Push User Updates User updates in Okta will be pushed to the corresponding users in Couchdrop
  • User deactivation Users deactivated in Okta will be deactivated in Couchdrop

  • Push Groups Groups created in Okta will also be created in Couchdrop

  • Push Group updates Group updates in Okta will be pushed to the corresponding users in Couchdrop

  • Group deactivation Groups deactivated in Okta will be deactivated in Couchdrop

  • Import Users Users created in Couchdrop can be imported into Okta

  • Import Groups Groups created in Couchdrop can be imported into Okta

  • Configuration Steps

    Create User Provisioning Token in Couchdrop

    Navigate to User Provisioning in Couchdrop’s interface and create a new Provisioning Token. This will be used in the Azure Active Directory provisioning process.

    Setup an SCIM Application for User Provisioning in Okta

    Select and configure the Couchdrop SCIM application from the Okta Application Catalogue.

    Under Application - Application select Browse App Catalog

    Search for Couchdrop SCIM and select the application

    02_Select_Couchdrop_App

    Click on Add Integration and then on Done

    04_Add_Couchdrop_SCIM_Done

    Assign User and Groups to the Application

    05_Assign_Users

    Then configure the user provisioning by selecting the Provisioning tab and click Configure API Integration

    06_Configure_Provisioning

    Check the Enable API integration checkbox, provide the User Provisioning Token which you configured in the Couchdrop SSO interface into the API Token field and click Test API Credentials to verify the token and hit Save.

    07_Enable_API_and_test

    Select Edit and enable Create User, Update User Attributes and Deactivate Users

    08_Edit_Provisioning
    09_Edit_Provisioning

    To push groups and their memberships from Okta into Couchdrop you can use the Push Group option. More information about this can be found here

    10_Groups_push

    Configure user and group import from Couchdrop to Okta

    If you want to import users and groups from Couchdrop into Okta select the To Okta Setting on the Provisioning Tab and select the scheduled import frequency and matching rules.

    11_ToOktaImport

    Then on the Import Tab click the Import Now button

    12_ImportResults

    You will see a list of all potential users and groups to import and can select the one you wish to import into Okta

    13_Assign_overview

    and click Confirm Assignments to trigger the import.

    14_assign_confirm

  • Download and Install Cyberduck:

    • Visit the Cyberduck website (https://cyberduck.io/) and download the appropriate version for your operating system.

    • Follow the installation instructions to install Cyberduck on your computer.

  • Open Cyberduck:

    • After installation, launch Cyberduck.

  • Create a New Connection:

    • Click on the "Open Connection" button in the top left corner, or go to "File" > "Open Connection".

  • Configure Connection Settings:

    • In the "Open Connection" window, select "SFTP (SSH File Transfer Protocol)" from the dropdown menu for "Connection Type".

    • Enter the server address (hostname or IP address) in the "Server" field.

    • Enter your username in the "Username" field.

  • Authenticate:

    • If this is your first time connecting to the server, you'll be prompted to verify the server's fingerprint. Make sure it matches the expected fingerprint to ensure you're connecting to the correct server.

    • Enter your password when prompted, and optionally, you can choose to save your password to the keychain for future logins.

  • Transferring Files:

    • Once connected, you'll see the file browser window showing the files on the server.

    • To upload files to the server, drag them from your local file browser (left pane) to the remote file browser (right pane).

    • To download files from the server to your local machine, drag them from the remote file browser to the local file browser.

  • Managing Files:

    • Cyberduck allows you to perform various file operations such as creating directories, renaming files, deleting files, and changing file permissions.

  • Disconnecting:

    • When you're finished with your file transfers, click the "Disconnect" button in the Cyberduck toolbar or go to "File" > "Disconnect".

  • Close Cyberduck:

    • Finally, you can close Cyberduck when you're done.

  • That's it! You've successfully used Cyberduck with SFTP to transfer files securely between your local machine and a remote server.

    Using Cyberduck with Couchdrop

    Couchdrop supports Cyberduck via SFTP and FTP. When configuring your server connection in the Site Manager, use the hostname, username and password provided in the Couchdrop admin interface.

    Passwords and RSA Keys

    Learn about authentication in Couchdrop

    Authentication in Couchdrop comes in two flavours. Password based authentication, and for SFTP and SCP, RSA based authentication. Couchdrop has extensive support for both, and users can self manage keys and passwords if granted access to the Couchdrop Web App.

    Most of the options here are only relevant for SFTP and SCP based authentication. The web interface does not support key based authentication.

    Password only authentication

    Password only authentication is the default setting for Couchdrop. When a user is first configured, they will need to provide a secure password that is used to login to both the web app and the SFTP and SCP server.

    Passwords can be managed and changed by an administrator and the user themselves.

    All users, regardless of key settings, need a password to be configured.

    RSA (and others) key based authentication

    Couchdrop supports standard key based authentication for SFTP and SCP. Key based authentication requires a private key and a public key. The public key is shared with Couchdrop and the private key remains a secret.

    Keys can be re-used across multiple users and are configurable under Administration --> Users --> RSA Public Keys

    Supported Key Types

    We support the following key types.

    Key Type
    Description

    Generating a new key

    Creating a new key is not something that we facilitate inside Couchdrop. This is to ensure that Couchdrop is never the holder (even by accident) of SSH private keys. Not to worry, creating a key pair is simple.

    On a Mac, Linux Box or any other Unix Server:

    From a console:

    This will generate two files.

    • abc

    • abc.pub

    The abc.pub file is what we need.

    Open the file and copy it to Couchdrop: The file will look something like this:

    Never share your private key. It's safe to share the public key, but not the private key.

    Adding the public key to Couchdrop

    Arguably the easiest step in the process.

    • Login to Couchdrop

    • Navigate to the user Administration --> Users --> User --> RSA Public Keys

    • Paste the public key into the field and click add.

    You can add as many keys to a user account as you like. We don't judge.

    Password and Key Authentication

    For additional security, some clients support requiring both a key and a password for successful authentication. Couchdrop supports this out of the box and this can be enforced by toggling the option: Require Password and Public Key

    Using SFTP with Golang

    Learn how to use SFTP with Golang, a popular programming language.

    Uploading and downloading files programatically with Golang is a great way to automate transfers or build out support for SFTP inside you application.

    How to use SFTP with Golang

    To interact with SFTP servers in Go, you can use the github.com/pkg/sftp package, which provides SFTP support on top of github.com/pkg/ssh. Here's a basic guide on how to use Go with SFTP:

    1. Install Dependencies: First, you need to install the required dependencies using go get:

    2. Create an SSH Client and Connect to the Server: Below is an example of how to connect to an SFTP server using Go:

    3. Perform SFTP Operations: Once you've established an SFTP connection, you can perform various operations such as uploading files, downloading files, listing directory contents, creating directories, etc. Here are a few examples:

      • Upload a file:

      • Download a file:

    4. Close the Connection: After you've finished with the SFTP operations, make sure to close the SFTP session and the SSH connection:

    By following these steps, you can use Go to interact with SFTP servers and perform various file operations. Make sure to handle errors appropriately when dealing with network connections and file operations.

    Using Golang and SFTP with Couchdrop

    Couchdrop has full support for SFTP uploads with Golang. Simply use your Couchdrop hostname and credentials and you can connect to Couchdrop like any other SFTP server.

    Couchdrop also has a comprehensive API, that you can find

    If the server uses a non-standard port for SFTP (other than 22), specify it in the "Port" field.

  • If you have a specific folder you want to open on the server upon connection, you can enter it in the "Path" field.

  • Click "Connect".

  • RSA

    The most common key type - by far. RSA keys are considered secure and have stood the test of time.

    DSA

    The precursor to RSA. Using DSA keys is generally frowned upon, but well supported in Couchdrop

    ECDSA

    The newest kid on the block.

    Adding a public key to a user in Couchdrop
    go get golang.org/x/crypto/ssh
    go get github.com/pkg/sftp
    #> ssh-keygen
    Generating public/private rsa key pair.
    Enter file in which to save the key (/.ssh/id_rsa): abc    
    Enter passphrase (empty for no passphrase): 
    Enter same passphrase again: 
    Your identification has been saved in abc
    Your public key has been saved in abc.pub
    The key fingerprint is:
    SHA256:slEtu8kkv6OwfhQSu0FDicYxfixekXAqXSZicPNlAJ0 [email protected]
    The key's randomart image is:
    +---[RSA 3072]----+
    |+oOBB=o          |
    |.=+@E+   .       |
    |..=.=+  o .      |
    | o ++ .. o       |
    |  .  ++.S        |
    |    . .O o       |
    |    ... =        |
    |     o. ..       |
    |   .o.....       |
    +----[SHA256]-----+
    
    ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDGB7TVVHUukb4cCDHQqmomNblw4vBOYabZyrJ7fGumI9+3N9YBZewkekcKESyjYqymbPal8cOEMOXToiDEhI04oEkcFYy3LWbclt+qEaakKqBWMJqJp3+V0LE+RfichkfZvBuhYhgP7iS4UVbtk8+KMqHz2E3PUHGULQ+rGBItg0ieOC8Z/6IA+nLyogopuvoABvp10HH2p8nl/zux6GJsx6PKPXABaxvoaxqPIpmQDvFJAO4p+q3S4xe0em60x6Y4AEDZnmGtlcURElVM9lxp/FXMKPEyb7qLyKmh++LRtKH5GnBehMZdzOyQJFQxZMk849lwcUNp3x2qTJVUvW0vsSq6X7UrGlUTHdJ3uFrMrJmk3+f499BaKw9n8t28Gx57W3CueuJZ7a9n/a5DSBG0gzR7GzZxhhXSrKIM7ilK+HVrE19/XdutKootd5f6kmtZpub6+lSLoPI0Ht6p9pgLKCsLhbS3t7Esy1T9g1mGChV5Qd0D2LPPSsUiVAf/jik= [email protected]
    package main
    
    import (
        "fmt"
        "golang.org/x/crypto/ssh"
        "github.com/pkg/sftp"
        "os"
    )
    
    func main() {
        // SFTP connection parameters
        host := "sftp.example.com"
        port := 22
        user := "your_username"
        password := "your_password"
    
        // Create SSH client configuration
        config := &ssh.ClientConfig{
            User: user,
            Auth: []ssh.AuthMethod{
                ssh.Password(password),
            },
            HostKeyCallback: ssh.InsecureIgnoreHostKey(),
        }
    
        // Connect to the SSH server
        conn, err := ssh.Dial("tcp", fmt.Sprintf("%s:%d", host, port), config)
        if err != nil {
            fmt.Println("Failed to connect to SSH server:", err)
            return
        }
        defer conn.Close()
    
        // Open SFTP session
        sftpClient, err := sftp.NewClient(conn)
        if err != nil {
            fmt.Println("Failed to open SFTP session:", err)
            return
        }
        defer sftpClient.Close()
    
        // Now you can perform SFTP operations using the sftpClient
    }
    localFile, err := os.Open("/path/to/local/file.txt")
    if err != nil {
        fmt.Println("Failed to open local file:", err)
        return
    }
    defer localFile.Close()
    
    remoteFile, err := sftpClient.Create("/path/to/remote/file.txt")
    if err != nil {
        fmt.Println("Failed to create remote file:", err)
        return
    }
    defer remoteFile.Close()
    
    _, err = io.Copy(remoteFile, localFile)
    if err != nil {
        fmt.Println("Failed to upload file:", err)
        return
    }
    remoteFile, err := sftpClient.Open("/path/to/remote/file.txt")
    if err != nil {
        fmt.Println("Failed to open remote file:", err)
        return
    }
    defer remoteFile.Close()
    
    localFile, err := os.Create("/path/to/local/file.txt")
    if err != nil {
        fmt.Println("Failed to create local file:", err)
        return
    }
    defer localFile.Close()
    
    _, err = io.Copy(localFile, remoteFile)
    if err != nil {
        fmt.Println("Failed to download file:", err)
        return
    }
    // Close SFTP session
    sftpClient.Close()
    
    // Close SSH connection
    conn.Close()
    couchdrop-api
    03_Add_Integration.png