# Table of Contents - [Welcome | Couchdrop Knowledge Base](#welcome-couchdrop-knowledge-base) - [Create SFTP Users | Couchdrop Knowledge Base](#create-sftp-users-couchdrop-knowledge-base) - [Host key authentication | Couchdrop Knowledge Base](#host-key-authentication-couchdrop-knowledge-base) - [Send Files with Shared Links | Couchdrop Knowledge Base](#send-files-with-shared-links-couchdrop-knowledge-base) - [Inbound SFTP | Couchdrop Knowledge Base](#inbound-sftp-couchdrop-knowledge-base) - [How to connect via FTPs | Couchdrop Knowledge Base](#how-to-connect-via-ftps-couchdrop-knowledge-base) - [Inbound FTPs | Couchdrop Knowledge Base](#inbound-ftps-couchdrop-knowledge-base) - [Upload Links/Web Forms | Couchdrop Knowledge Base](#upload-links-web-forms-couchdrop-knowledge-base) - [Inbound AS2 Stations | Couchdrop Knowledge Base](#inbound-as2-stations-couchdrop-knowledge-base) - [Inbound Mailboxes | Couchdrop Knowledge Base](#inbound-mailboxes-couchdrop-knowledge-base) - [Enabling FTPs | Couchdrop Knowledge Base](#enabling-ftps-couchdrop-knowledge-base) - [Inbound Webhooks | Couchdrop Knowledge Base](#inbound-webhooks-couchdrop-knowledge-base) - [Create FTPs Users | Couchdrop Knowledge Base](#create-ftps-users-couchdrop-knowledge-base) - [Transfer Automations | Couchdrop Knowledge Base](#transfer-automations-couchdrop-knowledge-base) - [Notifications | Couchdrop Knowledge Base](#notifications-couchdrop-knowledge-base) - [Conditional Filtering | Couchdrop Knowledge Base](#conditional-filtering-couchdrop-knowledge-base) - [Troubleshooting | Couchdrop Knowledge Base](#troubleshooting-couchdrop-knowledge-base) - [File Actions | Couchdrop Knowledge Base](#file-actions-couchdrop-knowledge-base) - [SharePoint | Couchdrop Knowledge Base](#sharepoint-couchdrop-knowledge-base) - [Storage | Couchdrop Knowledge Base](#storage-couchdrop-knowledge-base) - [Supported Actions | Couchdrop Knowledge Base](#supported-actions-couchdrop-knowledge-base) - [Virtual Folders | Couchdrop Knowledge Base](#virtual-folders-couchdrop-knowledge-base) - [Variables | Couchdrop Knowledge Base](#variables-couchdrop-knowledge-base) - [Azure Files | Couchdrop Knowledge Base](#azure-files-couchdrop-knowledge-base) - [Automation Builder | Couchdrop Knowledge Base](#automation-builder-couchdrop-knowledge-base) - [How to connect via SFTP | Couchdrop Knowledge Base](#how-to-connect-via-sftp-couchdrop-knowledge-base) - [Connect Providers/Partners | Couchdrop Knowledge Base](#connect-providers-partners-couchdrop-knowledge-base) - [Google Workspace | Couchdrop Knowledge Base](#google-workspace-couchdrop-knowledge-base) - [HTTP | Couchdrop Knowledge Base](#http-couchdrop-knowledge-base) - [Egnyte | Couchdrop Knowledge Base](#egnyte-couchdrop-knowledge-base) - [Alerting and Notifications | Couchdrop Knowledge Base](#alerting-and-notifications-couchdrop-knowledge-base) - [Delegating Domain-Wide Authority in Google Workspace | Couchdrop Knowledge Base](#delegating-domain-wide-authority-in-google-workspace-couchdrop-knowledge-base) - [Google Drive | Couchdrop Knowledge Base](#google-drive-couchdrop-knowledge-base) - [Azure Blob | Couchdrop Knowledge Base](#azure-blob-couchdrop-knowledge-base) - [Amazon S3 | Couchdrop Knowledge Base](#amazon-s3-couchdrop-knowledge-base) - [Firewalls and ACLs | Couchdrop Knowledge Base](#firewalls-and-acls-couchdrop-knowledge-base) - [Zapier | Couchdrop Knowledge Base](#zapier-couchdrop-knowledge-base) - [Workato | Couchdrop Knowledge Base](#workato-couchdrop-knowledge-base) - [Amazon SQS | Couchdrop Knowledge Base](#amazon-sqs-couchdrop-knowledge-base) - [Celigo | Couchdrop Knowledge Base](#celigo-couchdrop-knowledge-base) - [AS2 | Couchdrop Knowledge Base](#as2-couchdrop-knowledge-base) - [Box | Couchdrop Knowledge Base](#box-couchdrop-knowledge-base) - [Connect Platforms | Couchdrop Knowledge Base](#connect-platforms-couchdrop-knowledge-base) - [BigQuery | Couchdrop Knowledge Base](#bigquery-couchdrop-knowledge-base) - [SSO and Single Sign-on | Couchdrop Knowledge Base](#sso-and-single-sign-on-couchdrop-knowledge-base) - [Make.com | Couchdrop Knowledge Base](#make-com-couchdrop-knowledge-base) - [Connect Storage | Couchdrop Knowledge Base](#connect-storage-couchdrop-knowledge-base) - [Windows / Mac File Server | Couchdrop Knowledge Base](#windows-mac-file-server-couchdrop-knowledge-base) - [OneDrive | Couchdrop Knowledge Base](#onedrive-couchdrop-knowledge-base) - [Others | Couchdrop Knowledge Base](#others-couchdrop-knowledge-base) - [Connect IPaaS | Couchdrop Knowledge Base](#connect-ipaas-couchdrop-knowledge-base) - [SharePoint - Restrictive Permissions (App Registration) | Couchdrop Knowledge Base](#sharepoint-restrictive-permissions-app-registration-couchdrop-knowledge-base) - [The Root Directory | Couchdrop Knowledge Base](#the-root-directory-couchdrop-knowledge-base) - [Malware Scanning | Couchdrop Knowledge Base](#malware-scanning-couchdrop-knowledge-base) - [Supabase | Couchdrop Knowledge Base](#supabase-couchdrop-knowledge-base) - [Static IPs | Couchdrop Knowledge Base](#static-ips-couchdrop-knowledge-base) - [Custom Domains | Couchdrop Knowledge Base](#custom-domains-couchdrop-knowledge-base) - [Users and Groups | Couchdrop Knowledge Base](#users-and-groups-couchdrop-knowledge-base) - [Passwords and RSA Keys | Couchdrop Knowledge Base](#passwords-and-rsa-keys-couchdrop-knowledge-base) - [Logging | Couchdrop Knowledge Base](#logging-couchdrop-knowledge-base) - [Account Lockout | Couchdrop Knowledge Base](#account-lockout-couchdrop-knowledge-base) - [Folder Permissions | Couchdrop Knowledge Base](#folder-permissions-couchdrop-knowledge-base) - [Dropbox | Couchdrop Knowledge Base](#dropbox-couchdrop-knowledge-base) - [Features Access | Couchdrop Knowledge Base](#features-access-couchdrop-knowledge-base) - [Logging and Debugging | Couchdrop Knowledge Base](#logging-and-debugging-couchdrop-knowledge-base) - [Datadog | Couchdrop Knowledge Base](#datadog-couchdrop-knowledge-base) - [Splunk | Couchdrop Knowledge Base](#splunk-couchdrop-knowledge-base) - [Azure Queue | Couchdrop Knowledge Base](#azure-queue-couchdrop-knowledge-base) - [Creating Users | Couchdrop Knowledge Base](#creating-users-couchdrop-knowledge-base) - [Account expiry | Couchdrop Knowledge Base](#account-expiry-couchdrop-knowledge-base) - [Two Factor Authentication | Couchdrop Knowledge Base](#two-factor-authentication-couchdrop-knowledge-base) - [SAML SSO | Couchdrop Knowledge Base](#saml-sso-couchdrop-knowledge-base) - [Password Policies | Couchdrop Knowledge Base](#password-policies-couchdrop-knowledge-base) - [Microsoft Sentinel | Couchdrop Knowledge Base](#microsoft-sentinel-couchdrop-knowledge-base) - [Elastic | Couchdrop Knowledge Base](#elastic-couchdrop-knowledge-base) - [Proxy Configuration | Couchdrop Knowledge Base](#proxy-configuration-couchdrop-knowledge-base) - [Google PubSub | Couchdrop Knowledge Base](#google-pubsub-couchdrop-knowledge-base) - [Server Requirements | Couchdrop Knowledge Base](#server-requirements-couchdrop-knowledge-base) - [Boomi | Couchdrop Knowledge Base](#boomi-couchdrop-knowledge-base) - [Connect to SFTP | Couchdrop Knowledge Base](#connect-to-sftp-couchdrop-knowledge-base) - [Non-GUI Environments | Couchdrop Knowledge Base](#non-gui-environments-couchdrop-knowledge-base) - [Security | Couchdrop Knowledge Base](#security-couchdrop-knowledge-base) - [Webhook | Couchdrop Knowledge Base](#webhook-couchdrop-knowledge-base) - [SCIM - Okta | Couchdrop Knowledge Base](#scim-okta-couchdrop-knowledge-base) - [SFTP Recipes | Couchdrop Knowledge Base](#sftp-recipes-couchdrop-knowledge-base) - [Connect to FTPs | Couchdrop Knowledge Base](#connect-to-ftps-couchdrop-knowledge-base) - [Running the Couchdrop Agent as a Service | Couchdrop Knowledge Base](#running-the-couchdrop-agent-as-a-service-couchdrop-knowledge-base) - [Snowflake | Couchdrop Knowledge Base](#snowflake-couchdrop-knowledge-base) - [SCIM - Azure | Couchdrop Knowledge Base](#scim-azure-couchdrop-knowledge-base) - [Using SFTP/SSH Keys | Couchdrop Knowledge Base](#using-sftp-ssh-keys-couchdrop-knowledge-base) - [Using SFTP with Azure Blob | Couchdrop Knowledge Base](#using-sftp-with-azure-blob-couchdrop-knowledge-base) - [User Roles | Couchdrop Knowledge Base](#user-roles-couchdrop-knowledge-base) - [How to encrypt/decrypt a private key | Couchdrop Knowledge Base](#how-to-encrypt-decrypt-a-private-key-couchdrop-knowledge-base) - [Using SFTP Clients | Couchdrop Knowledge Base](#using-sftp-clients-couchdrop-knowledge-base) - [FAQs | Couchdrop Knowledge Base](#faqs-couchdrop-knowledge-base) - [OpenSSH SFTP | Couchdrop Knowledge Base](#openssh-sftp-couchdrop-knowledge-base) - [How to create a SFTP/SSH Key On MacOS | Couchdrop Knowledge Base](#how-to-create-a-sftp-ssh-key-on-macos-couchdrop-knowledge-base) - [Using Python with SFTP | Couchdrop Knowledge Base](#using-python-with-sftp-couchdrop-knowledge-base) - [How to convert a PPK key to RSA | Couchdrop Knowledge Base](#how-to-convert-a-ppk-key-to-rsa-couchdrop-knowledge-base) - [How to create a SFTP/SSH key on Windows | Couchdrop Knowledge Base](#how-to-create-a-sftp-ssh-key-on-windows-couchdrop-knowledge-base) - [How to create a SFTP/SSH Key On Linux | Couchdrop Knowledge Base](#how-to-create-a-sftp-ssh-key-on-linux-couchdrop-knowledge-base) - [Using SFTP with Java | Couchdrop Knowledge Base](#using-sftp-with-java-couchdrop-knowledge-base) - [How to use SFTP with FileZilla | Couchdrop Knowledge Base](#how-to-use-sftp-with-filezilla-couchdrop-knowledge-base) - [Using SCP | Couchdrop Knowledge Base](#using-scp-couchdrop-knowledge-base) - [Using SFTP with Bash | Couchdrop Knowledge Base](#using-sftp-with-bash-couchdrop-knowledge-base) - [How to use SFTP with Cyberduck | Couchdrop Knowledge Base](#how-to-use-sftp-with-cyberduck-couchdrop-knowledge-base) - [Using SFTP with Golang | Couchdrop Knowledge Base](#using-sftp-with-golang-couchdrop-knowledge-base) - [Email Protection | Cloudflare](#email-protection-cloudflare) --- # Welcome | Couchdrop Knowledge Base [](https://docs.couchdrop.io/#getting-started) Getting Started ------------------------------------------------------------------- Most Couchdrop users are interested in one core feature of Couchdrop [](https://docs.couchdrop.io/features/inbound-sftp) **SFTP and FTP** Learn about using Couchdrop as an SFTP and FTP server for the Cloud [](https://docs.couchdrop.io/features/transfer-automations) **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 [](https://docs.couchdrop.io/#common-questions) Common Questions --------------------------------------------------------------------- [](https://docs.couchdrop.io/connections/connect-storage/sharepoint) **Connect Couchdrop to SharePoint** Learn how to connect Couchdrop to Sharepoint online [](https://docs.couchdrop.io/administration/users-and-groups) **Add a user to Couchdrop** Learn how to add a user for SFTP or FTP in Couchdrop. It's simple, get started now. [](https://docs.couchdrop.io/features/inbound-sftp/how-to-connect-via-sftp) **Connect to Couchdrop with SFTP or FTP** Learn how to connect to Couchdrop with various clients [NextInbound SFTP](https://docs.couchdrop.io/features/inbound-sftp) Last updated 1 year ago Was this helpful? * [Getting Started](https://docs.couchdrop.io/#getting-started) * [Common Questions](https://docs.couchdrop.io/#common-questions) Was this helpful? --- # Create SFTP Users | Couchdrop Knowledge Base 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. [](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users#user-management-in-couchdrop) User Management in Couchdrop ------------------------------------------------------------------------------------------------------------------------------------ [](https://docs.couchdrop.io/administration/users-and-groups) **Users and Groups** Learn more about users and groups in Couchdrop [](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys) **RSA and DSA Keys** Learn about configuring key based access to Couchdrop SFTP [](https://docs.couchdrop.io/administration/users-and-groups/creating-users) **Adding a User** Learn how to add users to Couchdrop [](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users#creating-a-new-user) 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. ### [](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users#requirements) 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 ### [](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users#configuration-steps) Configuration Steps Login to Couchdrop at - [https://my.couchdrop.io](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 ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FhJIlc0BxBP1NJYCL0NBy%252FScreenshot%25202025-08-29%2520at%25209.50.50%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3D8f6a45dc-df9b-400e-b61a-063976d0ec64&width=768&dpr=4&quality=100&sign=26f06111&sv=2) ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FWBF9kisef3vFUx3sEFiG%252FScreenshot%25202025-08-29%2520at%25209.51.00%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3De20bb0b1-d39c-4cda-af44-3b310f528220&width=768&dpr=4&quality=100&sign=bb1d7a24&sv=2) ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FSY59OT0VXLDtirSadVuO%252FScreenshot%25202025-08-29%2520at%25209.51.15%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3D749b7ea6-f39c-4229-aca7-464f75cb37bf&width=768&dpr=4&quality=100&sign=df07c993&sv=2) You can see who has access directly in the Couchdrop SFTP section from the web app. [PreviousInbound SFTP](https://docs.couchdrop.io/features/inbound-sftp) [NextHow to connect via SFTP](https://docs.couchdrop.io/features/inbound-sftp/how-to-connect-via-sftp) Last updated 4 months ago Was this helpful? * [User Management in Couchdrop](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users#user-management-in-couchdrop) * [Creating a new User](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users#creating-a-new-user) * [Requirements](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users#requirements) * [Configuration Steps](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users#configuration-steps) Was this helpful? --- # Host key authentication | Couchdrop Knowledge Base 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** Copy AAAAB3NzaC1yc2EAAAADAQABAAAAgQCFzDO6AiZhK4ks4Bz/VBysjB3fpExCfOmy2EuI2gXJDYgom4nvZK4eEEgHRrkNoRUww4RJ7CTRKKXWodP7OthQw2AfppgBfR8dUK3zYdp/IClqTZ0+yxk72lLV9k8HwbtalOEzlJNc6AKlAkDi+WtG8RRZbJeaQZf3pe0k6oa7yQ== [PreviousHow to connect via SFTP](https://docs.couchdrop.io/features/inbound-sftp/how-to-connect-via-sftp) [NextStorage](https://docs.couchdrop.io/features/inbound-sftp/storage) Last updated 1 year ago Was this helpful? Was this helpful? --- # Send Files with Shared Links | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/send-files-with-shared-links#introduction) 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. * **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. [](https://docs.couchdrop.io/features/send-files-with-shared-links#creating-a-new-shared-link) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FNUbuM12cddmW9cL9PAah%252FScreenshot%25202025-08-29%2520at%252010.44.04%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3Dc2eb9be7-0dce-4a14-96c2-b09205213002&width=768&dpr=4&quality=100&sign=eca21b36&sv=2) [](https://docs.couchdrop.io/features/send-files-with-shared-links#supported-security-features) 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. [](https://docs.couchdrop.io/features/send-files-with-shared-links#frequently-asked-questions) Frequently asked questions ------------------------------------------------------------------------------------------------------------------------------ Are Shared Links encrypted and secure?[](https://docs.couchdrop.io/features/send-files-with-shared-links#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?[](https://docs.couchdrop.io/features/send-files-with-shared-links#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?[](https://docs.couchdrop.io/features/send-files-with-shared-links#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?[](https://docs.couchdrop.io/features/send-files-with-shared-links#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. [PreviousEnabling FTPs](https://docs.couchdrop.io/features/inbound-ftps/enabling-ftps) [NextUpload Links/Web Forms](https://docs.couchdrop.io/features/upload-links-web-forms) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/send-files-with-shared-links#introduction) * [Creating a new Shared Link](https://docs.couchdrop.io/features/send-files-with-shared-links#creating-a-new-shared-link) * [Supported Security Features](https://docs.couchdrop.io/features/send-files-with-shared-links#supported-security-features) * [Frequently asked questions](https://docs.couchdrop.io/features/send-files-with-shared-links#frequently-asked-questions) Was this helpful? --- # Inbound SFTP | Couchdrop Knowledge Base 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. [](https://docs.couchdrop.io/features/inbound-sftp#introduction-to-sftp) 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. [](https://docs.couchdrop.io/features/inbound-sftp#sftp-in-couchdrop) 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 ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FR8268TVlBxlbBCB9GDh1%252FInbound%2520SFTP%2520transfer%2520to%2520SharePoint.webp%3Falt%3Dmedia%26token%3D24642fcf-d455-4869-bfb6-414247695647&width=768&dpr=4&quality=100&sign=b2f329dc&sv=2) [](https://docs.couchdrop.io/features/inbound-sftp#getting-started-with-couchdrop) Getting Started with Couchdrop ---------------------------------------------------------------------------------------------------------------------- Inbound SFTP is enabled by default in Couchdrop accounts - but you will need to configure SFTP users for access. [](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users) **Creating SFTP Users in Couchdrop** Learn about creating external Inbound SFTP users in Couchdrop. [](https://docs.couchdrop.io/connections/connect-storage) **Connect to Storage** Learn about connecting cloud storage to Couchdrop and using it for Inbound SFTP users. [](https://docs.couchdrop.io/features/inbound-sftp/how-to-connect-via-sftp) **Connecting with SFTP** Learn how to connect to Couchdrop via SFTP. [PreviousWelcome](https://docs.couchdrop.io/) [NextCreate SFTP Users](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users) Last updated 4 months ago Was this helpful? * [Introduction to SFTP](https://docs.couchdrop.io/features/inbound-sftp#introduction-to-sftp) * [SFTP in Couchdrop](https://docs.couchdrop.io/features/inbound-sftp#sftp-in-couchdrop) * [Getting Started with Couchdrop](https://docs.couchdrop.io/features/inbound-sftp#getting-started-with-couchdrop) Was this helpful? --- # How to connect via FTPs | Couchdrop Knowledge Base 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** * A FTP client or platform/software that supports FTP. Your hostname will look like **.couchdrop.io** and can be found under **Connect** in the Couchdrop web app. [](https://docs.couchdrop.io/features/inbound-ftps/how-to-connect-via-ftps#ftp-connection-options) 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 .couchdrop.io Couchdrop provides a domain name for each tenant. You can find this under **Connect** in the Couchdrop web app [PreviousCreate FTPs Users](https://docs.couchdrop.io/features/inbound-ftps/create-ftps-users) [NextEnabling FTPs](https://docs.couchdrop.io/features/inbound-ftps/enabling-ftps) Last updated 4 months ago Was this helpful? Was this helpful? --- # Inbound FTPs | Couchdrop Knowledge Base Couchdrop acts as an FTP and FTPs server out of the box. ### [](https://docs.couchdrop.io/features/inbound-ftps#introduction-to-sftp) 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. ### [](https://docs.couchdrop.io/features/inbound-ftps#sftp-in-couchdrop) 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​ ### [](https://docs.couchdrop.io/features/inbound-ftps#getting-started-with-couchdrop) Getting Started with Couchdrop Inbound FTP is supported by default in Couchdrop accounts - but you will need to configure FTP users for access.​ [PreviousStorage](https://docs.couchdrop.io/features/inbound-sftp/storage) [NextCreate FTPs Users](https://docs.couchdrop.io/features/inbound-ftps/create-ftps-users) Last updated 4 months ago Was this helpful? * [Introduction to FTP](https://docs.couchdrop.io/features/inbound-ftps#introduction-to-sftp) * [FTP in Couchdrop](https://docs.couchdrop.io/features/inbound-ftps#sftp-in-couchdrop) * [Getting Started with Couchdrop](https://docs.couchdrop.io/features/inbound-ftps#getting-started-with-couchdrop) Was this helpful? --- # Upload Links/Web Forms | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/upload-links-web-forms#introduction) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FeODZWQnnFt6tRiEQkCmx%252FUpload%2520link%2520with%2520file%2520action.webp%3Falt%3Dmedia%26token%3D8f6f0e76-788c-4fba-803f-45bc11b6c25c&width=768&dpr=4&quality=100&sign=355effde&sv=2) [](https://docs.couchdrop.io/features/upload-links-web-forms#requirements) 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. [](https://docs.couchdrop.io/features/upload-links-web-forms#how-to-create-the-upload-link) 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. [](https://docs.couchdrop.io/features/upload-links-web-forms#forms-and-metadata) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FRHWN5VkSbjQGwbKVsi0J%252FScreenshot%25202025-08-29%2520at%252011.20.34%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3Dbf20ba5c-fe21-4115-8cf2-43e80c0de568&width=768&dpr=4&quality=100&sign=57e552dd&sv=2) [](https://docs.couchdrop.io/features/upload-links-web-forms#file-actions-and-automations) 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. [](https://docs.couchdrop.io/features/upload-links-web-forms#security-options-for-upload-links) 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 [](https://docs.couchdrop.io/features/upload-links-web-forms#feature-support) 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 Custom domains Yes [PreviousSend Files with Shared Links](https://docs.couchdrop.io/features/send-files-with-shared-links) [NextInbound Mailboxes](https://docs.couchdrop.io/features/inbound-mailboxes) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/upload-links-web-forms#introduction) * [Requirements](https://docs.couchdrop.io/features/upload-links-web-forms#requirements) * [How to create the Upload Link](https://docs.couchdrop.io/features/upload-links-web-forms#how-to-create-the-upload-link) * [Forms and metadata](https://docs.couchdrop.io/features/upload-links-web-forms#forms-and-metadata) * [File actions and automations](https://docs.couchdrop.io/features/upload-links-web-forms#file-actions-and-automations) * [Security Options for Upload Links](https://docs.couchdrop.io/features/upload-links-web-forms#security-options-for-upload-links) * [Feature Support](https://docs.couchdrop.io/features/upload-links-web-forms#feature-support) Was this helpful? --- # Inbound AS2 Stations | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/as2-stations#introduction) 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. [](https://docs.couchdrop.io/features/as2-stations#requirements) 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 [](https://docs.couchdrop.io/features/as2-stations#how-to-create-the-inbox) 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. 4. Add the partner's signing certificate provided by them. 5. Once you are done, click **Save and Back.** 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.** [](https://docs.couchdrop.io/features/as2-stations#using-the-as2-station) **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. [PreviousInbound Webhooks](https://docs.couchdrop.io/features/inbound-webhooks) [NextTransfer Automations](https://docs.couchdrop.io/features/transfer-automations) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/as2-stations#introduction) * [Requirements](https://docs.couchdrop.io/features/as2-stations#requirements) * [Creating an AS2 Station](https://docs.couchdrop.io/features/as2-stations#how-to-create-the-inbox) * [Using the AS2 Station](https://docs.couchdrop.io/features/as2-stations#using-the-as2-station) Was this helpful? --- # Inbound Mailboxes | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/inbound-mailboxes#introduction) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FktUaEPv9KSdl3inFx6qU%252Fmailbox-hero.webp%3Falt%3Dmedia%26token%3Dff739495-c26b-483e-ac0d-1b98c8c30c8f&width=768&dpr=4&quality=100&sign=4169d820&sv=2) [](https://docs.couchdrop.io/features/inbound-mailboxes#requirements) 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 [](https://docs.couchdrop.io/features/inbound-mailboxes#how-to-create-the-inbox) 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.** 5. Optionally provide some allowed senders. Wildcards are supported and you can include as many addresses as you like by using a comma. 6. Click **Save and Continue** 7. Choose an expiry. This is an optional step. Now you will see your newly created Mailbox. Copy the email address by clicking **Email**. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FSazMzHjZFKx0BTkVSBw7%252FScreenshot%25202025-08-29%2520at%252011.35.43%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3Dcc975d94-a9f6-4c91-a99f-26ac06152891&width=768&dpr=4&quality=100&sign=91f64929&sv=2) [](https://docs.couchdrop.io/features/inbound-mailboxes#feature-support) Feature Support --------------------------------------------------------------------------------------------- Mailboxes have comprehensive support in Couchdrop. Feature Supported File Actions Yes API Creation Yes Automatic Expiry Yes Custom Domains Yes Auditing Yes [](https://docs.couchdrop.io/features/inbound-mailboxes#frequently-asked-questions) Frequently Asked Questions ------------------------------------------------------------------------------------------------------------------- Is there a size limit with files?[](https://docs.couchdrop.io/features/inbound-mailboxes#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?[](https://docs.couchdrop.io/features/inbound-mailboxes#are-mailboxex-hipaa-compliant) No - email is not suitable for sensitive data - expecially PHI. [PreviousUpload Links/Web Forms](https://docs.couchdrop.io/features/upload-links-web-forms) [NextInbound Webhooks](https://docs.couchdrop.io/features/inbound-webhooks) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/inbound-mailboxes#introduction) * [Requirements](https://docs.couchdrop.io/features/inbound-mailboxes#requirements) * [How to create the Mailbox](https://docs.couchdrop.io/features/inbound-mailboxes#how-to-create-the-inbox) * [Feature Support](https://docs.couchdrop.io/features/inbound-mailboxes#feature-support) * [Frequently Asked Questions](https://docs.couchdrop.io/features/inbound-mailboxes#frequently-asked-questions) Was this helpful? --- # Enabling FTPs | Couchdrop Knowledge Base 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. [](https://docs.couchdrop.io/features/inbound-ftps/enabling-ftps#enabling-ftps) 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 [PreviousHow to connect via FTPs](https://docs.couchdrop.io/features/inbound-ftps/how-to-connect-via-ftps) [NextSend Files with Shared Links](https://docs.couchdrop.io/features/send-files-with-shared-links) Last updated 1 year ago Was this helpful? Was this helpful? --- # Inbound Webhooks | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/inbound-webhooks#introduction) 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. [](https://docs.couchdrop.io/features/inbound-webhooks#requirements) 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 [](https://docs.couchdrop.io/features/inbound-webhooks#configuring-an-inbound-webhook) 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.** 5. Optionally provide an authentication token and options 6. Click **Save and Continue** [](https://docs.couchdrop.io/features/inbound-webhooks#using-an-inbound-webhook-to-upload-data) Using an Inbound Webhook to upload data -------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://docs.couchdrop.io/features/inbound-webhooks#example-1-upload-via-curl) Example 1: Upload via CURL To upload via curl: ### [](https://docs.couchdrop.io/features/inbound-webhooks#example-2-upload-with-python-using-a-stream) Example 2: Upload with Python using a stream ### [](https://docs.couchdrop.io/features/inbound-webhooks#example-3-upload-json-data-to-a-file) Example 3: Upload JSON data to a file [PreviousInbound Mailboxes](https://docs.couchdrop.io/features/inbound-mailboxes) [NextInbound AS2 Stations](https://docs.couchdrop.io/features/as2-stations) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/inbound-webhooks#introduction) * [Requirements](https://docs.couchdrop.io/features/inbound-webhooks#requirements) * [Configuring an Inbound Webhook](https://docs.couchdrop.io/features/inbound-webhooks#configuring-an-inbound-webhook) * [Using an Inbound Webhook to upload data](https://docs.couchdrop.io/features/inbound-webhooks#using-an-inbound-webhook-to-upload-data) * [Example 1: Upload via CURL](https://docs.couchdrop.io/features/inbound-webhooks#example-1-upload-via-curl) * [Example 2: Upload with Python using a stream](https://docs.couchdrop.io/features/inbound-webhooks#example-2-upload-with-python-using-a-stream) * [Example 3: Upload JSON data to a file](https://docs.couchdrop.io/features/inbound-webhooks#example-3-upload-json-data-to-a-file) Was this helpful? Copy curl -v -F [email protected] -H "Authorization: Bearer " https://my.couchdrop.io/webhook/0479ae21-a677-49bb-9937-d5841b3b9ed1 Copy import requests binary_file_path = "/Users/donald/testing/trophy.jpg" webhook_id = "" 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 }) Copy 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"}' --- # Create FTPs Users | Couchdrop Knowledge Base 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. [](https://docs.couchdrop.io/features/inbound-ftps/create-ftps-users#creating-a-new-user) 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. ### [](https://docs.couchdrop.io/features/inbound-ftps/create-ftps-users#requirements) 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 ### [](https://docs.couchdrop.io/features/inbound-ftps/create-ftps-users#configuration-steps) Configuration Steps Login to Couchdrop at - [https://my.couchdrop.io](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 ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252F9M2scBoeYOeB2AlFytFQ%252FScreenshot%25202025-08-29%2520at%252010.22.28%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3D3ca93a3c-d517-4478-8187-09215c6f3445&width=768&dpr=4&quality=100&sign=bab928cd&sv=2) ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252Fo9WxSf9XAlzPdQMQdwgm%252FScreenshot%25202025-08-29%2520at%252010.22.35%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3Dcdc89cd6-b0b6-4934-8f6a-4a64bae38f65&width=768&dpr=4&quality=100&sign=94f23b45&sv=2) ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FlmJZCHUjBZwBFZjgxRoX%252FScreenshot%25202025-08-29%2520at%252010.22.45%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3Dded42eff-c39f-42c2-a096-b42fb626c357&width=768&dpr=4&quality=100&sign=400f6ece&sv=2) Once created - you can send connection details to the external provider or user. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252Fx5B2NjH9LaaG3qxCgX9O%252FScreenshot%25202025-08-29%2520at%252010.23.02%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3D3e3aef09-1492-424c-a503-68abbd68805b&width=768&dpr=4&quality=100&sign=f6f54047&sv=2) You can see who has access directly in the Couchdrop SFTP section from the web app. [PreviousInbound FTPs](https://docs.couchdrop.io/features/inbound-ftps) [NextHow to connect via FTPs](https://docs.couchdrop.io/features/inbound-ftps/how-to-connect-via-ftps) Last updated 4 months ago Was this helpful? * [Creating a new User](https://docs.couchdrop.io/features/inbound-ftps/create-ftps-users#creating-a-new-user) * [Requirements](https://docs.couchdrop.io/features/inbound-ftps/create-ftps-users#requirements) * [Configuration Steps](https://docs.couchdrop.io/features/inbound-ftps/create-ftps-users#configuration-steps) Was this helpful? --- # Transfer Automations | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/transfer-automations#introduction) 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. [](https://docs.couchdrop.io/features/transfer-automations#triggers) 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 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 Triggers at 45 minutes past the hour, every hour. 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. [](https://docs.couchdrop.io/features/transfer-automations#secondary-schedules) 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. ### [](https://docs.couchdrop.io/features/transfer-automations#determining-what-to-transfer-or-poll) Determining what to transfer or poll Transfer automations require that you configure a source and choose what to transfer or poll. Type Description 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. ### [](https://docs.couchdrop.io/features/transfer-automations#enabling-transfer-automations) 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 [Automation Builder](https://docs.couchdrop.io/features/transfer-automations/automation-builder) . [PreviousInbound AS2 Stations](https://docs.couchdrop.io/features/as2-stations) [NextAutomation Builder](https://docs.couchdrop.io/features/transfer-automations/automation-builder) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/transfer-automations#introduction) * [Triggers](https://docs.couchdrop.io/features/transfer-automations#triggers) * [Secondary Schedules](https://docs.couchdrop.io/features/transfer-automations#secondary-schedules) * [Determining what to transfer or poll](https://docs.couchdrop.io/features/transfer-automations#determining-what-to-transfer-or-poll) * [Enabling Transfer Automations](https://docs.couchdrop.io/features/transfer-automations#enabling-transfer-automations) Was this helpful? --- # Notifications | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/transfer-automations/notifications#introduction) Introduction -------------------------------------------------------------------------------------------------------- Notifications can be set to email a specific email address when an automation either fails or succeeds. ### [](https://docs.couchdrop.io/features/transfer-automations/notifications#selecting-notifications) Selecting Notifications Notifications are set in the automation builder by clicking a plus sign and choosing **Notifications**. ### [](https://docs.couchdrop.io/features/transfer-automations/notifications#notifications-settings) 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. ### [](https://docs.couchdrop.io/features/transfer-automations/notifications#recipient-email-addresses) 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. ### [](https://docs.couchdrop.io/features/transfer-automations/notifications#email-template) 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\]](https://docs.couchdrop.io/cdn-cgi/l/email-protection) and someone will be in contact shortly. Thank you, Team @ Couchdrop [PreviousConditional Filtering](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering) [NextVariables](https://docs.couchdrop.io/features/transfer-automations/variables) Last updated 5 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/transfer-automations/notifications#introduction) * [Selecting Notifications](https://docs.couchdrop.io/features/transfer-automations/notifications#selecting-notifications) * [Notifications settings](https://docs.couchdrop.io/features/transfer-automations/notifications#notifications-settings) * [Recipient email addresses](https://docs.couchdrop.io/features/transfer-automations/notifications#recipient-email-addresses) * [Email template](https://docs.couchdrop.io/features/transfer-automations/notifications#email-template) Was this helpful? --- # Conditional Filtering | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering#introduction) 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. ### [](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering#setting-conditions) Setting conditions Conditions are set in the [automation builder](https://docs.couchdrop.io/features/transfer-automations/automation-builder) by clicking a plus sign and choosing **Conditions**. ### [](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering#types-of-filters) 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 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 #### [](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering#and-filtering) AND filtering Use "Match all of these conditions (AND)" to only apply the following action when all conditions are met. #### [](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering#or-filtering) OR Filtering Use "Match any of these conditions (OR)" to apply if a single specified condition is met. [PreviousSupported Actions](https://docs.couchdrop.io/features/transfer-automations/supported-actions) [NextNotifications](https://docs.couchdrop.io/features/transfer-automations/notifications) Last updated 5 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering#introduction) * [Setting conditions](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering#setting-conditions) * [Types of Filters](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering#types-of-filters) Was this helpful? --- # Troubleshooting | Couchdrop Knowledge Base 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FY329FJI85K46njC6boLd%252FAutomation%2520Exceuction%2520Log.png%3Falt%3Dmedia%26token%3D0d9eeb59-b423-4838-a462-3d6e2a566f8e&width=768&dpr=4&quality=100&sign=8f0c4036&sv=2) Ping [\[email protected\]](https://docs.couchdrop.io/cdn-cgi/l/email-protection#cebdbbbebea1bcba8eada1bbada6aabca1bee0a7a1) if you are having issues with Automations. [PreviousVariables](https://docs.couchdrop.io/features/transfer-automations/variables) [NextFile Actions](https://docs.couchdrop.io/features/file-actions) Last updated 5 months ago Was this helpful? Was this helpful? --- # File Actions | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/file-actions#introduction) 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 [visual automation builder](https://docs.couchdrop.io/features/transfer-automations/automation-builder) . ### [](https://docs.couchdrop.io/features/file-actions#triggers) 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 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 ### [](https://docs.couchdrop.io/features/file-actions#enabling-file-actions) 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.** [](https://docs.couchdrop.io/features/file-actions#multi-step-automations) 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](https://docs.couchdrop.io/features/transfer-automations/automation-builder) . [PreviousTroubleshooting](https://docs.couchdrop.io/features/transfer-automations/troubleshooting) [NextVirtual Folders](https://docs.couchdrop.io/connections/virtual-folders) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/file-actions#introduction) * [Triggers](https://docs.couchdrop.io/features/file-actions#triggers) * [Enabling File Actions](https://docs.couchdrop.io/features/file-actions#enabling-file-actions) * [Multi-step automations](https://docs.couchdrop.io/features/file-actions#multi-step-automations) Was this helpful? --- # SharePoint | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/sharepoint#introduction) 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. For connecting with Delgate Access, you can follow our [step-by-step video guide below](https://docs.couchdrop.io/connections/connect-storage/sharepoint#video-guide) . 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 ### [](https://docs.couchdrop.io/connections/connect-storage/sharepoint#requirements) 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 ### [](https://docs.couchdrop.io/connections/connect-storage/sharepoint#configuration-steps) 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** [PreviousConnect Storage](https://docs.couchdrop.io/connections/connect-storage) [NextAzure Blob](https://docs.couchdrop.io/connections/connect-storage/azure-blob) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/sharepoint#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/sharepoint#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-storage/sharepoint#configuration-steps) Was this helpful? --- # Storage | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/inbound-sftp/storage#introduction) 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 * 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. [](https://docs.couchdrop.io/features/inbound-sftp/storage#connecting-storage-to-couchdrop) Connecting Storage to Couchdrop -------------------------------------------------------------------------------------------------------------------------------- Learn about connecting Cloud Storage: [](https://docs.couchdrop.io/connections/connect-storage/sharepoint) **Connect To SharePoint** Learn how to connect Couchdrop directly to SharePoint [](https://docs.couchdrop.io/connections/connect-storage/amazon-s3) **Connect to Amazon S3** Learn how to connect Couchdrop to Amazon S3 [](https://docs.couchdrop.io/connections/connect-storage) **Learn about Storage Connectors** Get the nuts and bolts covered with Storage in Couchdrop [PreviousHost key authentication](https://docs.couchdrop.io/features/inbound-sftp/host-key-authentication) [NextInbound FTPs](https://docs.couchdrop.io/features/inbound-ftps) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/inbound-sftp/storage#introduction) * [Connecting Storage to Couchdrop](https://docs.couchdrop.io/features/inbound-sftp/storage#connecting-storage-to-couchdrop) Was this helpful? --- # Supported Actions | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/transfer-automations/supported-actions#introduction) Introduction ------------------------------------------------------------------------------------------------------------ Couchdrop supports several key actions when configuring and managing automations. These actions modify or move files that are being processed by Couchdrop. ### [](https://docs.couchdrop.io/features/transfer-automations/supported-actions#selecting-actions) Selecting Actions Actions are set in the automation builder by clicking a plus sign and choosing **Actions**. [](https://docs.couchdrop.io/features/transfer-automations/supported-actions#action-nesting) 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 [Automation Builder](https://docs.couchdrop.io/features/transfer-automations/automation-builder) . [](https://docs.couchdrop.io/features/transfer-automations/supported-actions#available-actions) Available Actions ---------------------------------------------------------------------------------------------------------------------- The following actions are available in Automations in Couchdrop Actions support variable use for directory and file locations Action Type Description 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 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 [PreviousAutomation Builder](https://docs.couchdrop.io/features/transfer-automations/automation-builder) [NextConditional Filtering](https://docs.couchdrop.io/features/transfer-automations/conditional-filtering) Last updated 5 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/transfer-automations/supported-actions#introduction) * [Selecting Actions](https://docs.couchdrop.io/features/transfer-automations/supported-actions#selecting-actions) * [Action Nesting](https://docs.couchdrop.io/features/transfer-automations/supported-actions#action-nesting) * [Available Actions](https://docs.couchdrop.io/features/transfer-automations/supported-actions#available-actions) Was this helpful? --- # Virtual Folders | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/virtual-folders#overview-and-introduction) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252F6th2bakVofTPsTYaNtw6%252Fvirtual-file-system.webp%3Falt%3Dmedia%26token%3Dffdaf297-a267-4d31-8b0b-88323c0f9363&width=768&dpr=4&quality=100&sign=8a3d6976&sv=2) 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. [PreviousFile Actions](https://docs.couchdrop.io/features/file-actions) [NextConnect Storage](https://docs.couchdrop.io/connections/connect-storage) Last updated 4 months ago Was this helpful? Was this helpful? --- # Variables | Couchdrop Knowledge Base [](https://docs.couchdrop.io/features/transfer-automations/variables#introduction) 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. [](https://docs.couchdrop.io/features/transfer-automations/variables#available-variables) Available Variables ------------------------------------------------------------------------------------------------------------------ The following variables are available for automations Key Value Example Description {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 The extension only of the current filename {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.} Substitute with the name of the Web Inbox required field to access data provided on upload. You can also create Custom Variables using the Extract Variable from Filename action. For more details, see [Supported Actions](https://docs.couchdrop.io/features/transfer-automations/supported-actions#available-actions) . [PreviousNotifications](https://docs.couchdrop.io/features/transfer-automations/notifications) [NextTroubleshooting](https://docs.couchdrop.io/features/transfer-automations/troubleshooting) Last updated 5 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/features/transfer-automations/variables#introduction) * [Available Variables](https://docs.couchdrop.io/features/transfer-automations/variables#available-variables) Was this helpful? --- # Azure Files | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/azure-files#introduction) Introduction Connecting to Azure Files online is fast to set up and fully supported in Couchdrop. ### [](https://docs.couchdrop.io/connections/connect-storage/azure-files#requirements) 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 [https://docs.microsoft.com/en-us/azure/storage/common/storage-account-manage](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-manage) ### [](https://docs.couchdrop.io/connections/connect-storage/azure-files#configuration-steps) 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 5. Choose a subfolder in Azure 6. Click **Save Settings** [PreviousAzure Blob](https://docs.couchdrop.io/connections/connect-storage/azure-blob) [NextAmazon S3](https://docs.couchdrop.io/connections/connect-storage/amazon-s3) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/azure-files#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/azure-files#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-storage/azure-files#configuration-steps) Was this helpful? --- # Automation Builder | Couchdrop Knowledge Base Couchdrop automations are built using a visual builder that requires no code. The builder supports multiple steps through primary actions and sub-actions. [](https://docs.couchdrop.io/features/transfer-automations/automation-builder#how-the-builder-works) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FkRv163YAUnjireANuysj%252FCouchdrop%2520Automation%2520Builder.jpg%3Falt%3Dmedia%26token%3Db177c1df-db74-4714-acfb-3158594dba99&width=768&dpr=4&quality=100&sign=b16c01d4&sv=2) It's important to understand Primary Actions and Sub-actions and the processing order to avoid errors. [](https://docs.couchdrop.io/features/transfer-automations/automation-builder#primary-actions) 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. [](https://docs.couchdrop.io/features/transfer-automations/automation-builder#sub-actions) 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. [](https://docs.couchdrop.io/features/transfer-automations/automation-builder#processing-order) Processing Order --------------------------------------------------------------------------------------------------------------------- Automations are processed t**op-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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252Fp7i9yq2JwoOkYwj05TDa%252FCouchdrop%2520Automation%2520Order.jpg%3Falt%3Dmedia%26token%3D0698a1fa-098f-4bbd-b847-9e4e047378d5&width=768&dpr=4&quality=100&sign=db7a34f7&sv=2) All A group actions will occur first in numerical order, followed by the B group, and so on. ### [](https://docs.couchdrop.io/features/transfer-automations/automation-builder#modifying-an-automation) 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. [PreviousTransfer Automations](https://docs.couchdrop.io/features/transfer-automations) [NextSupported Actions](https://docs.couchdrop.io/features/transfer-automations/supported-actions) Last updated 3 months ago Was this helpful? * [How the builder works](https://docs.couchdrop.io/features/transfer-automations/automation-builder#how-the-builder-works) * [Primary Actions](https://docs.couchdrop.io/features/transfer-automations/automation-builder#primary-actions) * [Sub-actions](https://docs.couchdrop.io/features/transfer-automations/automation-builder#sub-actions) * [Processing Order](https://docs.couchdrop.io/features/transfer-automations/automation-builder#processing-order) * [Modifying an automation](https://docs.couchdrop.io/features/transfer-automations/automation-builder#modifying-an-automation) Was this helpful? --- # How to connect via SFTP | Couchdrop Knowledge Base 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** * A SFTP client or platform/software that supports SFTP. [](https://docs.couchdrop.io/features/inbound-sftp/how-to-connect-via-sftp#general-connection-details) General Connection Details -------------------------------------------------------------------------------------------------------------------------------------- Couchdrop uses the default ports for SFTP and a unique hostname for your tenant. Your hostname will look like **.couchdrop.io** and can be found under **Connect** in the Couchdrop web app. Option Recommended Value Description Hostname .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 [](https://docs.couchdrop.io/features/inbound-sftp/how-to-connect-via-sftp#common-clients) 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 [https://filezilla-project.org/download.php?type=client](https://filezilla-project.org/download.php?type=client) Filezilla is arguably the most known name in the SFTP space. They have well supported clients for Windows and Macs. Cyberduck [https://cyberduck.io/](https://cyberduck.io/) Cyberduck are a more modern version of Filezilla - they have a very clean UI and simple to use client. [PreviousCreate SFTP Users](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users) [NextHost key authentication](https://docs.couchdrop.io/features/inbound-sftp/host-key-authentication) Last updated 4 months ago Was this helpful? * [General Connection Details](https://docs.couchdrop.io/features/inbound-sftp/how-to-connect-via-sftp#general-connection-details) * [Common Clients](https://docs.couchdrop.io/features/inbound-sftp/how-to-connect-via-sftp#common-clients) Was this helpful? --- # Connect Providers/Partners | Couchdrop Knowledge Base [Connect to SFTP](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp) [Connect to FTPs](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps) [AS2](https://docs.couchdrop.io/connections/connect-providers-partners/as2) [HTTP](https://docs.couchdrop.io/connections/connect-providers-partners/http) [PreviousOneDrive](https://docs.couchdrop.io/connections/connect-storage/others/onedrive) [NextConnect to SFTP](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp) Was this helpful? Was this helpful? --- # Google Workspace | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/google-workspace#introduction) 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 [Google Drive](https://docs.couchdrop.io/connections/connect-storage/google-drive) ### [](https://docs.couchdrop.io/connections/connect-storage/google-workspace#requirements) 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 ### [](https://docs.couchdrop.io/connections/connect-storage/google-workspace#configuration-steps) 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](https://docs.couchdrop.io/connections/connect-storage/google-workspace/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.** [PreviousAmazon S3](https://docs.couchdrop.io/connections/connect-storage/amazon-s3) [NextDelegating Domain-Wide Authority in Google Workspace](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/google-workspace#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/google-workspace#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-storage/google-workspace#configuration-steps) Was this helpful? --- # HTTP | Couchdrop Knowledge Base [PreviousAS2](https://docs.couchdrop.io/connections/connect-providers-partners/as2) [NextConnect IPaaS](https://docs.couchdrop.io/connections/connect-ipaas) Was this helpful? Was this helpful? --- # Egnyte | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/egnyte#introduction) Introduction Connecting to Egnyte is fast to set up and fully supported in Couchdrop. ### [](https://docs.couchdrop.io/connections/connect-storage/egnyte#requirements) Requirements To connect to Egnyte in Couchdrop you will need: * A licensed Egnyte account * A folder in Google Drive * Your Egnyte Domain #### [](https://docs.couchdrop.io/connections/connect-storage/egnyte#configuration-steps) 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) 5. Choose Authorize Now. A window will open to grant access to Couchdrop. Click **Allow Access**. 6. Click **Test Connection** in Couchdrop 7. Select a user or sub-folder in Egnyte (Optional) 8. Click **Save Settings.** [PreviousDropbox](https://docs.couchdrop.io/connections/connect-storage/dropbox) [NextWindows / Mac File Server](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/egnyte#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/egnyte#requirements) Was this helpful? --- # Alerting and Notifications | Couchdrop Knowledge Base Couchdrop has three different mechanisms for alerting and notifications. Each is independant of the other and is managed slightly differently. [](https://docs.couchdrop.io/administration/alerting-and-notifications#global-alerting) 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. [](https://docs.couchdrop.io/administration/alerting-and-notifications#folder-alerting) 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 [](https://docs.couchdrop.io/administration/alerting-and-notifications#file-actions) File Actions ------------------------------------------------------------------------------------------------------ Alerting can also be configured as an action in File Actions. [PreviousFolder Permissions](https://docs.couchdrop.io/administration/folder-permissions) [NextLogging](https://docs.couchdrop.io/administration/logging) Last updated 1 year ago Was this helpful? * [Global Alerting](https://docs.couchdrop.io/administration/alerting-and-notifications#global-alerting) * [Folder Alerting](https://docs.couchdrop.io/administration/alerting-and-notifications#folder-alerting) * [File Actions](https://docs.couchdrop.io/administration/alerting-and-notifications#file-actions) Was this helpful? --- # Delegating Domain-Wide Authority in Google Workspace | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace#delegating-domain-wide-authority) Delegating Domain-Wide Authority ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Learn how to connect Google Workspace to Couchdrop with a Client ID and domain-wide delegation ### [](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace#introduction) 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. ### [](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace#requirements) 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 ### [](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace#configuration-steps) Configuration Steps 1. [Login to the admin console](https://admin.google.com/) 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** section, choose **MANAGE DOMAIN WIDE DELEGATION**. 5. In the **API clients** section, click **Add new**. Paste the Client ID generated from Couchdrop into the **Client ID** field. 6. In the **OAuth scopes (comma-delimited)** field, paste the following: 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: [https://support.google.com/a/answer/162106?hl=en](https://support.google.com/a/answer/162106?hl=en) [PreviousGoogle Workspace](https://docs.couchdrop.io/connections/connect-storage/google-workspace) [NextGoogle Drive](https://docs.couchdrop.io/connections/connect-storage/google-drive) Last updated 1 year ago Was this helpful? * [Delegating Domain-Wide Authority](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace#delegating-domain-wide-authority) * [Introduction](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace#configuration-steps) Was this helpful? Copy 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 --- # Google Drive | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/google-drive#introduction) 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 [Google Workspace](https://docs.couchdrop.io/connections/connect-storage/google-workspace) ### [](https://docs.couchdrop.io/connections/connect-storage/google-drive#requirements) Requirements To connect to Google Drive online in Couchdrop you will need: * A licensed Google Drive Account * A folder in Google Drive ### [](https://docs.couchdrop.io/connections/connect-storage/google-drive#configuration-steps) 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** [PreviousDelegating Domain-Wide Authority in Google Workspace](https://docs.couchdrop.io/connections/connect-storage/google-workspace/delegating-domain-wide-authority-in-google-workspace) [NextBox](https://docs.couchdrop.io/connections/connect-storage/box) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/google-drive#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/google-drive#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-storage/google-drive#configuration-steps) Was this helpful? --- # Azure Blob | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-storage/azure-blob#overview) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252Fob366gRQpthDwSuCOOOA%252Fazure-blob-icon.png%3Falt%3Dmedia%26token%3D5f27d7a5-a2f8-4976-a7e3-02309317cd27&width=768&dpr=4&quality=100&sign=d75b3743&sv=2) [](https://docs.couchdrop.io/connections/connect-storage/azure-blob#requirements) 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: * Storage account name * Access key **or** a SAS token * Container name [](https://docs.couchdrop.io/connections/connect-storage/azure-blob#configuration-steps) 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** * Allowed permissions: **Read, Write, List, Delete** (depending on Couchdrop use) * Set start and expiry date. 3. Click **Generate SAS** and copy the **SAS token**. **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) * **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. 4. Optionally choose a folder in Azure You will now see your Azure blob container as a folder in Couchdrop. [](https://docs.couchdrop.io/connections/connect-storage/azure-blob#frequently-asked-questions) Frequently Asked Questions ------------------------------------------------------------------------------------------------------------------------------- Can we configure multiple users with different access permissions for SFTP with Azure?[](https://docs.couchdrop.io/connections/connect-storage/azure-blob#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?[](https://docs.couchdrop.io/connections/connect-storage/azure-blob#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?[](https://docs.couchdrop.io/connections/connect-storage/azure-blob#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?[](https://docs.couchdrop.io/connections/connect-storage/azure-blob#can-we-use-ftp-or-ftps-with-azure-blob) Yes - Couchdrop supports FTP and FTPs natively as well. [](https://docs.couchdrop.io/connections/connect-storage/azure-blob#supported-features) Supported Features --------------------------------------------------------------------------------------------------------------- Couchdrop has comprehensive support for interacting with Files in Azure Blob Feature Supported in Couchdrop Uploading Files Yes Downloading Files Yes Listing files and folders Yes Creating folders Yes Deleting folders Yes Deleting Files Yes Azure Access Controls Supported via static IP in Couchdrop [PreviousSharePoint](https://docs.couchdrop.io/connections/connect-storage/sharepoint) [NextAzure Files](https://docs.couchdrop.io/connections/connect-storage/azure-files) Last updated 4 months ago Was this helpful? * [Overview](https://docs.couchdrop.io/connections/connect-storage/azure-blob#overview) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/azure-blob#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-storage/azure-blob#configuration-steps) * [Frequently Asked Questions](https://docs.couchdrop.io/connections/connect-storage/azure-blob#frequently-asked-questions) * [Supported Features](https://docs.couchdrop.io/connections/connect-storage/azure-blob#supported-features) Was this helpful? --- # Amazon S3 | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/amazon-s3#introduction) 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. ### [](https://docs.couchdrop.io/connections/connect-storage/amazon-s3#requirements) 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 * The IAM role must have adequate access to S3 and the targeted bucket ### [](https://docs.couchdrop.io/connections/connect-storage/amazon-s3#configuration-steps) 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 5. Select a subfolder or bucket in S3 from the browser 6. Click **Save Settings** [PreviousAzure Files](https://docs.couchdrop.io/connections/connect-storage/azure-files) [NextGoogle Workspace](https://docs.couchdrop.io/connections/connect-storage/google-workspace) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/amazon-s3#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/amazon-s3#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-storage/amazon-s3#configuration-steps) Was this helpful? --- # Firewalls and ACLs | Couchdrop Knowledge Base 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 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: ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252F1hrlHD8ZoNqHNUeobqmS%252FScreenshot%25202024-03-25%2520at%252010.35.21%2520AM.png%3Falt%3Dmedia%26token%3De97fb8c5-8f86-4bc5-a425-e8528b111bfa&width=768&dpr=4&quality=100&sign=6734dba6&sv=2) [PreviousFeatures Access](https://docs.couchdrop.io/administration/users-and-groups/features-access) [NextFolder Permissions](https://docs.couchdrop.io/administration/folder-permissions) Last updated 1 year ago Was this helpful? Was this helpful? --- # Zapier | Couchdrop Knowledge Base 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252F1F5pwazuiHmAdiJ12QjL%252FZapier_logo.jpg%3Falt%3Dmedia%26token%3D85ff9daf-7a64-43cb-8d5d-7d015087a46c&width=768&dpr=4&quality=100&sign=4098209b&sv=2) [](https://docs.couchdrop.io/connections/connect-ipaas/zapier#how-zapier-works-with-couchdrop) How Zapier works with Couchdrop ----------------------------------------------------------------------------------------------------------------------------------- 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. [](https://docs.couchdrop.io/connections/connect-ipaas/zapier#requirements) 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 [](https://docs.couchdrop.io/connections/connect-ipaas/zapier#configuration-steps) 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. [](https://docs.couchdrop.io/connections/connect-ipaas/zapier#common-issues) Common Issues ----------------------------------------------------------------------------------------------- Zapier requires a **Pro subscription** to use webhook triggers.[](https://docs.couchdrop.io/connections/connect-ipaas/zapier#zapier-requires-a-pro-subscription-to-use-webhook-triggers) W**ebhook 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.[](https://docs.couchdrop.io/connections/connect-ipaas/zapier#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.[](https://docs.couchdrop.io/connections/connect-ipaas/zapier#if-zapier-cannot-ingest-a-file-youll-receive-an-email-notification-from-zapier-with-details) [PreviousWorkato](https://docs.couchdrop.io/connections/connect-ipaas/workato) [NextConnect Platforms](https://docs.couchdrop.io/connections/connect-platforms) Last updated 4 months ago Was this helpful? * [How Zapier works with Couchdrop](https://docs.couchdrop.io/connections/connect-ipaas/zapier#how-zapier-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-ipaas/zapier#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-ipaas/zapier#configuration-steps) * [Common Issues](https://docs.couchdrop.io/connections/connect-ipaas/zapier#common-issues) Was this helpful? --- # Workato | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-ipaas/workato#introduction-to-workato-with-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FBVAn2PKXZEqVB1V4ryU0%252Fworkato-logo-1.png%3Falt%3Dmedia%26token%3D8199085c-a75a-491d-b479-ccf1c3d6ee29&width=768&dpr=4&quality=100&sign=94dd43c6&sv=2) [](https://docs.couchdrop.io/connections/connect-ipaas/workato#how-workato-works-with-couchdrop) 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. [](https://docs.couchdrop.io/connections/connect-ipaas/workato#requirements) 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 [](https://docs.couchdrop.io/connections/connect-ipaas/workato#configuration-steps) 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. [](https://docs.couchdrop.io/connections/connect-ipaas/workato#common-issues) Common Issues ------------------------------------------------------------------------------------------------ Files larger than **5 MB** will be rejected by Workato[](https://docs.couchdrop.io/connections/connect-ipaas/workato#files-larger-than-5-mb-will-be-rejected-by-workato) Workato cannot process files that are larger than 5MB. Invalid authentication method[](https://docs.couchdrop.io/connections/connect-ipaas/workato#invalid-authentication-method) Ensure the **authentication method** in Couchdrop matches the webhook configuration in Workato. [PreviousMake.com](https://docs.couchdrop.io/connections/connect-ipaas/make.com) [NextZapier](https://docs.couchdrop.io/connections/connect-ipaas/zapier) Last updated 4 months ago Was this helpful? * [Introduction to Workato with Couchdrop](https://docs.couchdrop.io/connections/connect-ipaas/workato#introduction-to-workato-with-couchdrop) * [How Workato works with Couchdrop](https://docs.couchdrop.io/connections/connect-ipaas/workato#how-workato-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-ipaas/workato#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-ipaas/workato#configuration-steps) * [Common Issues](https://docs.couchdrop.io/connections/connect-ipaas/workato#common-issues) Was this helpful? --- # Amazon SQS | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs#introduction-to-amazon-sqs-with-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FUkweSXxJA426rRKHHdFz%252Famazon-sqs-leader.avif%3Falt%3Dmedia%26token%3Dce589037-210d-4720-aa26-0312540ff251&width=768&dpr=4&quality=100&sign=3c1ba956&sv=2) [](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs#how-amazon-sqs-works-with-couchdrop) 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](https://docs.couchdrop.io/connections/virtual-folders) as Couchdrop, rather SQS is configured as a connection that you can use in a file action inside an [Transfer Automations](https://docs.couchdrop.io/features/transfer-automations) or [File Actions](https://docs.couchdrop.io/features/file-actions) . [](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs#requirements) 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 [](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs#configuration-steps) 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** [PreviousBigQuery](https://docs.couchdrop.io/connections/connect-platforms/bigquery) [NextAzure Queue](https://docs.couchdrop.io/connections/connect-platforms/azure-queue) Last updated 4 months ago Was this helpful? * [Introduction to Amazon SQS with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs#introduction-to-amazon-sqs-with-couchdrop) * [How Amazon SQS works with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs#how-amazon-sqs-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs#configuration-steps) Was this helpful? --- # Celigo | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-ipaas/celigo#introduction-to-celigo-with-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FoUrEcNbcBfAAxa3ZeCeY%252Fceligo-image.avif%3Falt%3Dmedia%26token%3Da4d96b89-2590-4405-97da-71bc4e7e6b25&width=768&dpr=4&quality=100&sign=ee510362&sv=2) [](https://docs.couchdrop.io/connections/connect-ipaas/celigo#how-celigo-works-with-couchdrop) 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. [](https://docs.couchdrop.io/connections/connect-ipaas/celigo#requirements) Requirements --------------------------------------------------------------------------------------------- * **Admin access in Couchdrop** * A Celigo flow with a **Webhook listener** configured * The following details from Celigo: * **Webhook URL (Public URL)** * **Content Type** (`application/json`, `application/xml`, or `application/x-www-form-urlencoded`) * **Username** and **Password** defined in the Webhook listener Celigo has a **5 MB maximum file size** limit for incoming files [](https://docs.couchdrop.io/connections/connect-ipaas/celigo#configuration-steps) 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) * 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 **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) * The **Webhook URL**, **Content Type**, **Username**, and **Password** from Celigo * Save the configuration Any files uploaded into the Couchdrop folder will now be sent automatically to your Celigo flow. [](https://docs.couchdrop.io/connections/connect-ipaas/celigo#common-issues) Common Issues ----------------------------------------------------------------------------------------------- File size limit of 5MB[](https://docs.couchdrop.io/connections/connect-ipaas/celigo#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[](https://docs.couchdrop.io/connections/connect-ipaas/celigo#invalid-content-type) Make sure the **Content Type** in Couchdrop matches what your Celigo webhook listener is configured to accept [PreviousBoomi](https://docs.couchdrop.io/connections/connect-ipaas/boomi) [NextMake.com](https://docs.couchdrop.io/connections/connect-ipaas/make.com) Last updated 4 months ago Was this helpful? * [Introduction to Celigo with Couchdrop](https://docs.couchdrop.io/connections/connect-ipaas/celigo#introduction-to-celigo-with-couchdrop) * [How Celigo works with Couchdrop](https://docs.couchdrop.io/connections/connect-ipaas/celigo#how-celigo-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-ipaas/celigo#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-ipaas/celigo#configuration-steps) * [Common Issues](https://docs.couchdrop.io/connections/connect-ipaas/celigo#common-issues) Was this helpful? --- # AS2 | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-providers-partners/as2#introduction) 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 [Inbound AS2 Stations](https://docs.couchdrop.io/features/as2-stations) [](https://docs.couchdrop.io/connections/connect-providers-partners/as2#requirements) 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 * Your AS2 signing certificate [](https://docs.couchdrop.io/connections/connect-providers-partners/as2#configuration-steps) 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. 5. Upload your public and private key for signing under **Message Signature Configuration** 6. Save and Test 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. [](https://docs.couchdrop.io/connections/connect-providers-partners/as2#how-it-works) 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 [here](https://docs.couchdrop.io/connections/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 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 File Actions Yes - Upload only Transfer Automations Yes - Upload Only [PreviousConnect to FTPs](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps) [NextHTTP](https://docs.couchdrop.io/connections/connect-providers-partners/http) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-providers-partners/as2#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-providers-partners/as2#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-providers-partners/as2#configuration-steps) * [How it works](https://docs.couchdrop.io/connections/connect-providers-partners/as2#how-it-works) Was this helpful? --- # Box | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/box#introduction) Introduction Connecting to Box is fast to set up and fully supported in Couchdrop. ### [](https://docs.couchdrop.io/connections/connect-storage/box#requirements) 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) #### [](https://docs.couchdrop.io/connections/connect-storage/box#configuration-steps) 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 5. Click Test Connection 6. Select a user or sub-folder in Box (Optional) 7. Click **Save Settings.** [PreviousGoogle Drive](https://docs.couchdrop.io/connections/connect-storage/google-drive) [NextDropbox](https://docs.couchdrop.io/connections/connect-storage/dropbox) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/box#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/box#requirements) Was this helpful? --- # Connect Platforms | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-platforms#overview) 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. [](https://docs.couchdrop.io/connections/connect-platforms#using-platforms-in-couchdrop) Using Platforms in Couchdrop -------------------------------------------------------------------------------------------------------------------------- Platform integrations can be used in File Actions and Automations as actions. [PreviousZapier](https://docs.couchdrop.io/connections/connect-ipaas/zapier) [NextSnowflake](https://docs.couchdrop.io/connections/connect-platforms/snowflake) Last updated 4 months ago Was this helpful? * [Overview](https://docs.couchdrop.io/connections/connect-platforms#overview) * [Using Platforms in Couchdrop](https://docs.couchdrop.io/connections/connect-platforms#using-platforms-in-couchdrop) Was this helpful? --- # BigQuery | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-platforms/bigquery#introduction-to-bigquery-with-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FA4OP83AowgJrITNARmPd%252FBigQuery-Logo.jpg%3Falt%3Dmedia%26token%3D531d7d87-f0ac-43b1-aa1f-50d1b2aaa449&width=768&dpr=4&quality=100&sign=e2469b9b&sv=2) [](https://docs.couchdrop.io/connections/connect-platforms/bigquery#how-bigquery-works-with-couchdrop) 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](https://docs.couchdrop.io/connections/virtual-folders) 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](https://docs.couchdrop.io/features/transfer-automations) or [File Actions](https://docs.couchdrop.io/features/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. [](https://docs.couchdrop.io/connections/connect-platforms/bigquery#requirements) 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 [](https://docs.couchdrop.io/connections/connect-platforms/bigquery#configuration-steps) 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. [PreviousSupabase](https://docs.couchdrop.io/connections/connect-platforms/supabase) [NextAmazon SQS](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs) Last updated 4 months ago Was this helpful? * [Introduction to BigQuery with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/bigquery#introduction-to-bigquery-with-couchdrop) * [How BigQuery works with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/bigquery#how-bigquery-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-platforms/bigquery#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-platforms/bigquery#configuration-steps) Was this helpful? --- # SSO and Single Sign-on | Couchdrop Knowledge Base [](https://docs.couchdrop.io/administration/sso-and-single-sign-on#configuring-sso-with-couchdrop) Configuring SSO with Couchdrop -------------------------------------------------------------------------------------------------------------------------------------- [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso) **SAML SSO** Learn how to configure SSO through a SAML IDP in Couchdrop [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure) **Azure SCIM and SSO** Learn how to configure Couchdrop to sync user identities with Azure [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta) **Okta Configuration** Learn how to configure Couchdrop to integrate with Okta [PreviousWebhook](https://docs.couchdrop.io/administration/logging/webhook) [NextSAML SSO](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso) Last updated 1 year ago Was this helpful? Was this helpful? --- # Make.com | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-ipaas/make.com#introduction-to-make.com-with-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252F0yRQySJ6fEerbVKpug1T%252Fmake-logo.webp%3Falt%3Dmedia%26token%3D454632d1-54ee-4c8b-af71-a3c39c684ee6&width=768&dpr=4&quality=100&sign=3520ee72&sv=2) [](https://docs.couchdrop.io/connections/connect-ipaas/make.com#how-make.com-works-with-couchdrop) 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. [](https://docs.couchdrop.io/connections/connect-ipaas/make.com#requirements) 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 [](https://docs.couchdrop.io/connections/connect-ipaas/make.com#configuration-steps-sending-files-from-couchdrop-to-make.com) 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. [](https://docs.couchdrop.io/connections/connect-ipaas/make.com#configuration-steps-performing-couchdrop-operations-from-make.com) 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](https://developers.couchdrop.io/filesystem-operations/managing-files) and [Couchdrop Management API](https://developers.couchdrop.io/administration/managing-users) documentation. [PreviousCeligo](https://docs.couchdrop.io/connections/connect-ipaas/celigo) [NextWorkato](https://docs.couchdrop.io/connections/connect-ipaas/workato) Last updated 4 months ago Was this helpful? * [Introduction to Make.com with Couchdrop](https://docs.couchdrop.io/connections/connect-ipaas/make.com#introduction-to-make.com-with-couchdrop) * [How Make.com works with Couchdrop](https://docs.couchdrop.io/connections/connect-ipaas/make.com#how-make.com-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-ipaas/make.com#requirements) * [Configuration Steps: Sending Files from Couchdrop to Make.com](https://docs.couchdrop.io/connections/connect-ipaas/make.com#configuration-steps-sending-files-from-couchdrop-to-make.com) * [Configuration Steps: Performing Couchdrop Operations from Make.com](https://docs.couchdrop.io/connections/connect-ipaas/make.com#configuration-steps-performing-couchdrop-operations-from-make.com) Was this helpful? --- # Connect Storage | Couchdrop Knowledge Base 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](https://docs.couchdrop.io/connections/virtual-folders) for more info on folders in Couchdrop [](https://docs.couchdrop.io/connections/connect-storage#connecting-external-storage) 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. ### [](https://docs.couchdrop.io/connections/connect-storage#step-1-create-new-connection) 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. ### [](https://docs.couchdrop.io/connections/connect-storage#step-2-choose-a-new-folder-name) 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. ### [](https://docs.couchdrop.io/connections/connect-storage#step-3-choose-a-connection-type-and-configure-it) 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. [](https://docs.couchdrop.io/connections/connect-storage#common-storage-integrations) Common Storage Integrations ---------------------------------------------------------------------------------------------------------------------- Couchdrop supports over 30 different storage platforms. The most common ones are well documented. [](https://docs.couchdrop.io/connections/connect-storage/sharepoint) **SharePoint and OneDrive** Learn how to configure Couchdrop to connect to SharePoint. [](https://docs.couchdrop.io/connections/connect-storage/azure-files) **Azure Files** Learn how to connect Couchdrop to Azure files [](https://docs.couchdrop.io/connections/connect-storage/amazon-s3) **Amazon S3** Learn how to connect Couchdrop to Amazon S3 or an S3 compatible storage provider [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp) **External SFTP Connections** Learn how to connect Couchdrop to an external SFTP server [](https://docs.couchdrop.io/connections/connect-storage/google-workspace) **Google Drive** Learn how to connect Couchdrop to Google Drive [](https://docs.couchdrop.io/connections/connect-storage/box) **Box** Learn how to connect Couchdrop to Box [PreviousVirtual Folders](https://docs.couchdrop.io/connections/virtual-folders) [NextSharePoint](https://docs.couchdrop.io/connections/connect-storage/sharepoint) Last updated 4 months ago Was this helpful? * [Connecting External Storage](https://docs.couchdrop.io/connections/connect-storage#connecting-external-storage) * [Step 1: Create new Connection](https://docs.couchdrop.io/connections/connect-storage#step-1-create-new-connection) * [Step 2: Choose a new folder name](https://docs.couchdrop.io/connections/connect-storage#step-2-choose-a-new-folder-name) * [Step 3: Choose a connection type and configure it](https://docs.couchdrop.io/connections/connect-storage#step-3-choose-a-connection-type-and-configure-it) * [Common Storage Integrations](https://docs.couchdrop.io/connections/connect-storage#common-storage-integrations) Was this helpful? --- # Windows / Mac File Server | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server#introduction) 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 [as a service](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/running-the-couchdrop-agent-as-a-service) . We do not recommend installing the agent directly on the target file server. If possible, use a VM and connect via mapped network drives. ### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server#requirements) 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](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements) . ### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server#configuration-steps) 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**. [PreviousEgnyte](https://docs.couchdrop.io/connections/connect-storage/egnyte) [NextServer Requirements](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements) Last updated 10 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server#configuration-steps) Was this helpful? --- # OneDrive | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/others/onedrive#introduction) 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](https://docs.couchdrop.io/connections/connect-storage/sharepoint) ### [](https://docs.couchdrop.io/connections/connect-storage/others/onedrive#requirements) Requirements To connect a personal OneDrive folder in Couchdrop you will need: * A licensed OneDrive Account * A folder in OneDrive ### [](https://docs.couchdrop.io/connections/connect-storage/others/onedrive#configuration-steps) 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. 5. Click Test Connection 6. Choose a subfolder in OneDrive from the folder selector (Optional) 7. Click **Save Settings** [PreviousSharePoint - Restrictive Permissions (App Registration)](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration) [NextConnect Providers/Partners](https://docs.couchdrop.io/connections/connect-providers-partners) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/others/onedrive#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/others/onedrive#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-storage/others/onedrive#configuration-steps) Was this helpful? --- # Others | Couchdrop Knowledge Base [SharePoint - Restrictive Permissions (App Registration)](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration) [OneDrive](https://docs.couchdrop.io/connections/connect-storage/others/onedrive) [PreviousLogging and Debugging](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/logging-and-debugging) [NextSharePoint - Restrictive Permissions (App Registration)](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration) Was this helpful? Was this helpful? --- # Connect IPaaS | Couchdrop Knowledge Base [Boomi](https://docs.couchdrop.io/connections/connect-ipaas/boomi) [Celigo](https://docs.couchdrop.io/connections/connect-ipaas/celigo) [Make.com](https://docs.couchdrop.io/connections/connect-ipaas/make.com) [Workato](https://docs.couchdrop.io/connections/connect-ipaas/workato) [Zapier](https://docs.couchdrop.io/connections/connect-ipaas/zapier) [PreviousHTTP](https://docs.couchdrop.io/connections/connect-providers-partners/http) [NextBoomi](https://docs.couchdrop.io/connections/connect-ipaas/boomi) Was this helpful? Was this helpful? --- # SharePoint - Restrictive Permissions (App Registration) | Couchdrop Knowledge Base 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. * * * ### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#prerequisites) Prerequisites * Access to [Microsoft Entra Admin Center](https://entra.microsoft.com/) * Admin rights to register apps and grant tenant-wide permissions * Access to [Microsoft Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer) #### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#steps) 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 * * * ### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#configuring-an-application-in-entra) Configuring an Application in Entra #### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#id-1.-register-a-new-application) 1\. Register a New Application 1. Go to [**entra.microsoft.com**](https://entra.microsoft.com/) 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** * * * #### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#id-2.-copy-your-new-client-id-and-tenant-id) 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** * * * #### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#id-3.-create-a-client-secret) 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_ **(it won’t be shown again)** * * * #### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#id-4.-assign-api-permissions) 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** 5. Click the checkmark **Grant admin consent for \[Your Org\]** * * * ### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#granting-site-permissions-to-app-via-microsoft-graph-explorer) Granting site permissions to App via Microsoft Graph Explorer #### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#id-1.-retrieve-the-site-id) **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 [**Graph Explorer**](https://developer.microsoft.com/en-us/graph/graph-explorer) 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 * `` with your app’s Client ID * `` 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:** * `` with your app’s Client ID * `` with your app name (e.g., `Couchdrop-SharePoint`) Click **Run Query**. A successful response will return `201 Created`. * * * ### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#connecting-to-sharepoint-in-couchdrop-using-the-configured-application) 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`. #### [](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#folder-path-syntax) Folder Path Syntax 5\. Click **Test** to verify that you have successfully assigned access. Select **Add Integration** to complete the process. [PreviousOthers](https://docs.couchdrop.io/connections/connect-storage/others) [NextOneDrive](https://docs.couchdrop.io/connections/connect-storage/others/onedrive) Last updated 1 month ago Was this helpful? * [Prerequisites](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#prerequisites) * [Configuring an Application in Entra](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#configuring-an-application-in-entra) * [Granting site permissions to App via Microsoft Graph Explorer](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#granting-site-permissions-to-app-via-microsoft-graph-explorer) * [Connecting to SharePoint in Couchdrop using the configured Application](https://docs.couchdrop.io/connections/connect-storage/others/sharepoint-restrictive-permissions-app-registration#connecting-to-sharepoint-in-couchdrop-using-the-configured-application) Was this helpful? Copy https://.sharepoint.com/sites//_api/site/id Copy https://couchdropdemo.sharepoint.com/sites/MySite/_api/site/id Copy 29cf2814-a045-4b48-8b1b-6bd01f57d632 Copy POST https://graph.microsoft.com/v1.0/sites/{site_id}/permissions Copy { "roles": ["write"], "grantedToIdentities": [\ {\ "application": {\ "id": "",\ "displayName": ""\ }\ }\ ] } Copy POST https://graph.microsoft.com/v1.0/sites/root/permissions Copy { "roles": ["write"], "grantedToIdentities": [\ {\ "application": {\ "id": "",\ "displayName": ""\ }\ }\ ] } Copy /sharepointsite:/sites/:/Documents/ --- # The Root Directory | Couchdrop Knowledge Base 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 * 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: ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FSX4PdRr4rVHp2RFFvxMx%252FScreenshot%25202024-03-25%2520at%25209.41.19%2520AM.png%3Falt%3Dmedia%26token%3Db1288758-a8a4-4011-b0d5-b7db93323bc4&width=768&dpr=4&quality=100&sign=21a07d76&sv=2) [PreviousCreating Users](https://docs.couchdrop.io/administration/users-and-groups/creating-users) [NextPasswords and RSA Keys](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys) Last updated 1 year ago Was this helpful? Was this helpful? --- # Malware Scanning | Couchdrop Knowledge Base [](https://docs.couchdrop.io/administration/malware-scanning#introduction) 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\]](https://docs.couchdrop.io/cdn-cgi/l/email-protection#0f7c6e636a7c4f6c607a6c676b7d607f216660) 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. [](https://docs.couchdrop.io/administration/malware-scanning#malware-faqs) Malware FAQs -------------------------------------------------------------------------------------------- #### [](https://docs.couchdrop.io/administration/malware-scanning#why-do-i-need-couchdrop-malware-scanning) 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. #### [](https://docs.couchdrop.io/administration/malware-scanning#how-do-i-enable-malware-scanning) How do I enable Malware Scanning? Access to this functionality can be requested via [\[email protected\]](https://docs.couchdrop.io/cdn-cgi/l/email-protection#6c1f191c1c031e182c0f03190f04081e031c420503) . Once enabled, you can enable malware scanning for specific folders. #### [](https://docs.couchdrop.io/administration/malware-scanning#what-is-the-underlying-malware-scanning-mechanism) What is the underlying Malware Scanning mechanism? Malware Scanning is provided by ClamAV ([https://www.clamav.net](https://www.clamav.net/) ) Malware scanning is limited to files that are 1GB or less. #### [](https://docs.couchdrop.io/administration/malware-scanning#is-it-possible-to-modify-the-scanning-behaviour) 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. [PreviousStatic IPs](https://docs.couchdrop.io/administration/static-ips) [NextSFTP Recipes](https://docs.couchdrop.io/walkthroughs/sftp-recipes) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/administration/malware-scanning#introduction) * [Malware FAQs](https://docs.couchdrop.io/administration/malware-scanning#malware-faqs) Was this helpful? --- # Supabase | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-platforms/supabase#introduction-to-superbase-with-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FG07CVXwWkLgvwxQUfvzA%252Fsuperbase.png%3Falt%3Dmedia%26token%3De85767a8-c00d-49e7-9ae7-e327fda3b459&width=768&dpr=4&quality=100&sign=7b5c0e26&sv=2) [](https://docs.couchdrop.io/connections/connect-platforms/supabase#how-superbase-works-with-couchdrop) How Superbase works with Couchdrop ----------------------------------------------------------------------------------------------------------------------------------------------- Superbase is configured in Couchdrop as a platform integration. This type of integration does not appear directly as a [virtual folder](https://docs.couchdrop.io/connections/virtual-folders) 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 [Transfer Automations](https://docs.couchdrop.io/features/transfer-automations) or [File Actions](https://docs.couchdrop.io/features/file-actions) . 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. [](https://docs.couchdrop.io/connections/connect-platforms/supabase#requirements) 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/` * In Couchdrop, the Supabase URL field is typically `https://.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. [](https://docs.couchdrop.io/connections/connect-platforms/supabase#configuration-steps) 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 5. Create an automation or file action and select Superbase as the platform type. [PreviousSnowflake](https://docs.couchdrop.io/connections/connect-platforms/snowflake) [NextBigQuery](https://docs.couchdrop.io/connections/connect-platforms/bigquery) Last updated 4 months ago Was this helpful? * [Introduction to Superbase with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/supabase#introduction-to-superbase-with-couchdrop) * [How Superbase works with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/supabase#how-superbase-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-platforms/supabase#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-platforms/supabase#configuration-steps) Was this helpful? --- # Static IPs | Couchdrop Knowledge Base [](https://docs.couchdrop.io/administration/static-ips#introduction) 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. [](https://docs.couchdrop.io/administration/static-ips#its-a-hard-requirement-for-us) It's a hard requirement for us ------------------------------------------------------------------------------------------------------------------------- If static IPs are a hard requirement, then reach out to [\[email protected\]](https://docs.couchdrop.io/cdn-cgi/l/email-protection) and we can assign your account to a POD that is configured for them. [PreviousTwo Factor Authentication](https://docs.couchdrop.io/administration/security/two-factor-authentication) [NextMalware Scanning](https://docs.couchdrop.io/administration/malware-scanning) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/administration/static-ips#introduction) * [It's a hard requirement for us](https://docs.couchdrop.io/administration/static-ips#its-a-hard-requirement-for-us) Was this helpful? --- # Custom Domains | Couchdrop Knowledge Base 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. [](https://docs.couchdrop.io/administration/custom-domains#configure-couchdrop-whitelabelling) Configure Couchdrop Whitelabelling -------------------------------------------------------------------------------------------------------------------------------------- 1. Log in to Couchdrop as the Owner user. 2. Navigate to **Administration → White labelling** 3. 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` 4. 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. 5. Click **Save Settings** when all configuration is complete. [PreviousSCIM - Okta](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta) [NextSecurity](https://docs.couchdrop.io/administration/security) Last updated 4 months ago Was this helpful? Was this helpful? --- # Users and Groups | Couchdrop Knowledge Base [](https://docs.couchdrop.io/administration/users-and-groups#managing-users-in-couchdrop) Managing Users In Couchdrop -------------------------------------------------------------------------------------------------------------------------- User management in Couchdrop is done under **Administration --> Users** or under the **Users** section from the main navigation. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FTHA8yaS2O4kUAffJ1jYP%252FScreenshot%25202024-03-24%2520at%25207.57.50%2520PM.png%3Falt%3Dmedia%26token%3Df690a04c-019b-43c0-bffc-1aa13df508fb&width=768&dpr=4&quality=100&sign=3630e2a4&sv=2) [PreviousGoogle PubSub](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub) [NextUser Roles](https://docs.couchdrop.io/administration/users-and-groups/user-roles) Last updated 10 months ago Was this helpful? Was this helpful? --- # Passwords and RSA Keys | Couchdrop Knowledge Base 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. [](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#password-only-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. [](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#rsa-and-others-key-based-authentication) 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** ### [](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#supported-key-types) Supported Key Types We support the following key types. Key Type Description 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. ### [](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#generating-a-new-key) 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. ### [](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#adding-the-public-key-to-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FO1ph3spZ7lrarfQnHFcq%252FScreenshot%25202024-03-25%2520at%25209.59.39%2520AM.png%3Falt%3Dmedia%26token%3Dd851383b-a524-4716-944b-8a6d39b31cc7&width=768&dpr=4&quality=100&sign=bdb227ef&sv=2) Adding a public key to a user in Couchdrop You can add as many keys to a user account as you like. We don't judge. [](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#password-and-key-authentication) 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** ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FPS9GDOGlr9LcfvqPp8G9%252FScreenshot%25202024-03-25%2520at%252010.23.47%2520AM.png%3Falt%3Dmedia%26token%3D62a74875-bd41-409c-a64a-e44b4669a460&width=768&dpr=4&quality=100&sign=73bba5f1&sv=2) [PreviousThe Root Directory](https://docs.couchdrop.io/administration/users-and-groups/the-root-directory) [NextFeatures Access](https://docs.couchdrop.io/administration/users-and-groups/features-access) Last updated 10 months ago Was this helpful? * [Password only authentication](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#password-only-authentication) * [RSA (and others) key based authentication](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#rsa-and-others-key-based-authentication) * [Supported Key Types](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#supported-key-types) * [Generating a new key](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#generating-a-new-key) * [Adding the public key to Couchdrop](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#adding-the-public-key-to-couchdrop) * [Password and Key Authentication](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys#password-and-key-authentication) Was this helpful? Copy #> 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]-----+ Copy ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDGB7TVVHUukb4cCDHQqmomNblw4vBOYabZyrJ7fGumI9+3N9YBZewkekcKESyjYqymbPal8cOEMOXToiDEhI04oEkcFYy3LWbclt+qEaakKqBWMJqJp3+V0LE+RfichkfZvBuhYhgP7iS4UVbtk8+KMqHz2E3PUHGULQ+rGBItg0ieOC8Z/6IA+nLyogopuvoABvp10HH2p8nl/zux6GJsx6PKPXABaxvoaxqPIpmQDvFJAO4p+q3S4xe0em60x6Y4AEDZnmGtlcURElVM9lxp/FXMKPEyb7qLyKmh++LRtKH5GnBehMZdzOyQJFQxZMk849lwcUNp3x2qTJVUvW0vsSq6X7UrGlUTHdJ3uFrMrJmk3+f499BaKw9n8t28Gx57W3CueuJZ7a9n/a5DSBG0gzR7GzZxhhXSrKIM7ilK+HVrE19/XdutKootd5f6kmtZpub6+lSLoPI0Ht6p9pgLKCsLhbS3t7Esy1T9g1mGChV5Qd0D2LPPSsUiVAf/jik= [email protected] --- # Logging | Couchdrop Knowledge Base 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. ### [](https://docs.couchdrop.io/administration/logging#select-one-or-multiple-of-the-logging-provider-to-connect-to) Select one or multiple of the logging provider to connect to ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FU5y91ZPoAWVteeRsgYg7%252FScreenshot%25202025-06-30%2520at%252010.28.59.png%3Falt%3Dmedia%26token%3De92b218c-2b04-4e7e-a811-13a75943ed23&width=768&dpr=4&quality=100&sign=6ecfd990&sv=2) ### [](https://docs.couchdrop.io/administration/logging#event-types) Event Types Options for events to send are * Login * Admin changes * Failures * File based actions ### [](https://docs.couchdrop.io/administration/logging#example-couchdrop-json-event) Example Couchdrop JSON Event [PreviousAlerting and Notifications](https://docs.couchdrop.io/administration/alerting-and-notifications) [NextDatadog](https://docs.couchdrop.io/administration/logging/datadog) Last updated 6 months ago Was this helpful? * [Select one or multiple of the logging provider to connect to](https://docs.couchdrop.io/administration/logging#select-one-or-multiple-of-the-logging-provider-to-connect-to) * [Event Types](https://docs.couchdrop.io/administration/logging#event-types) * [Example Couchdrop JSON Event](https://docs.couchdrop.io/administration/logging#example-couchdrop-json-event) Was this helpful? Copy { "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": {} } --- # Account Lockout | Couchdrop Knowledge Base 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FTjPm1QJm4CS2N6OTykse%252FScreenshot%25202024-03-25%2520at%252011.39.52%2520AM.png%3Falt%3Dmedia%26token%3D7b6f66c9-fab5-4cc4-8eb9-349f20761636&width=768&dpr=4&quality=100&sign=7c82d020&sv=2) [PreviousPassword Policies](https://docs.couchdrop.io/administration/security/password-policies) [NextAccount expiry](https://docs.couchdrop.io/administration/security/account-expiry) Last updated 1 year ago Was this helpful? Was this helpful? --- # Folder Permissions | Couchdrop Knowledge Base 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. [](https://docs.couchdrop.io/administration/folder-permissions#folder-permissions) 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: * 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 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 [](https://docs.couchdrop.io/administration/folder-permissions#folder-sharing) 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. [PreviousFirewalls and ACLs](https://docs.couchdrop.io/administration/users-and-groups/firewalls-and-acls) [NextAlerting and Notifications](https://docs.couchdrop.io/administration/alerting-and-notifications) Last updated 1 year ago Was this helpful? * [Folder Permissions](https://docs.couchdrop.io/administration/folder-permissions#folder-permissions) * [Folder Sharing](https://docs.couchdrop.io/administration/folder-permissions#folder-sharing) Was this helpful? --- # Dropbox | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-storage/dropbox#introduction) 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. ### [](https://docs.couchdrop.io/connections/connect-storage/dropbox#requirements) 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) #### [](https://docs.couchdrop.io/connections/connect-storage/dropbox#configuration-steps) 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. 5. Click Test Connection 6. Select a User or sub-folder in Dropbox (Optional) 7. Click **Save Settings.** [PreviousBox](https://docs.couchdrop.io/connections/connect-storage/box) [NextEgnyte](https://docs.couchdrop.io/connections/connect-storage/egnyte) Last updated 1 year ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-storage/dropbox#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-storage/dropbox#requirements) Was this helpful? --- # Features Access | Couchdrop Knowledge Base 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252Fk4MtApVLqq8y1s3r1joe%252FScreenshot%25202024-03-25%2520at%252010.30.41%2520AM.png%3Falt%3Dmedia%26token%3D05d7ed5d-a7ad-4766-a740-a1e1d7a905a7&width=768&dpr=4&quality=100&sign=4ad1e63&sv=2) [PreviousPasswords and RSA Keys](https://docs.couchdrop.io/administration/users-and-groups/passwords-and-rsa-keys) [NextFirewalls and ACLs](https://docs.couchdrop.io/administration/users-and-groups/firewalls-and-acls) Last updated 1 year ago Was this helpful? Was this helpful? --- # Logging and Debugging | Couchdrop Knowledge Base 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: Copy 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. [PreviousRunning the Couchdrop Agent as a Service](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/running-the-couchdrop-agent-as-a-service) [NextOthers](https://docs.couchdrop.io/connections/connect-storage/others) Last updated 10 months ago Was this helpful? Was this helpful? --- # Datadog | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/administration/logging/datadog#requirements) Requirements #### [](https://docs.couchdrop.io/administration/logging/datadog#required-configuration) Required Configuration To connect to Datadog you will need: * Datadog Application Key * Datadog API Key #### [](https://docs.couchdrop.io/administration/logging/datadog#optional-configuration) 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 [https://docs.datadoghq.com/api/latest/logs](https://docs.datadoghq.com/api/latest/logs) ### [](https://docs.couchdrop.io/administration/logging/datadog#configuration-steps) 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 5. Click **Save Updates** [PreviousLogging](https://docs.couchdrop.io/administration/logging) [NextSplunk](https://docs.couchdrop.io/administration/logging/splunk) Last updated 6 months ago Was this helpful? * [Requirements](https://docs.couchdrop.io/administration/logging/datadog#requirements) * [Configuration Steps](https://docs.couchdrop.io/administration/logging/datadog#configuration-steps) Was this helpful? --- # Splunk | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/administration/logging/splunk#requirements) Requirements #### [](https://docs.couchdrop.io/administration/logging/splunk#required-configuration) Required Configuration To connect to Splunk you will need: * Event Collector token * HTTP Event Collector URI #### [](https://docs.couchdrop.io/administration/logging/splunk#optional-configuration) 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 [https://docs.splunk.com/Documentation/SplunkCloud/latest/Data/UsetheHTTPEventCollector](https://docs.splunk.com/Documentation/SplunkCloud/latest/Data/UsetheHTTPEventCollector) ### [](https://docs.couchdrop.io/administration/logging/splunk#configuration-steps) 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 5. Click **Save Updates** [PreviousDatadog](https://docs.couchdrop.io/administration/logging/datadog) [NextMicrosoft Sentinel](https://docs.couchdrop.io/administration/logging/microsoft-sentinel) Last updated 6 months ago Was this helpful? * [Requirements](https://docs.couchdrop.io/administration/logging/splunk#requirements) * [Configuration Steps](https://docs.couchdrop.io/administration/logging/splunk#configuration-steps) Was this helpful? --- # Azure Queue | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-platforms/azure-queue#introduction-to-azure-queue-with-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FQ00LvzyGBbO2ggTCn7hc%252Fmicrosoft%2520azure%2520queue%2520storage.png%3Falt%3Dmedia%26token%3Dd2fd655d-54d9-4190-8f08-aa2298420372&width=768&dpr=4&quality=100&sign=46332807&sv=2) [](https://docs.couchdrop.io/connections/connect-platforms/azure-queue#how-azure-queue-works-with-couchdrop) 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 [virtual folder](https://docs.couchdrop.io/connections/virtual-folders) as Couchdrop, rather Azure Queue is configured as a connection that you can use in a file action inside an [Transfer Automations](https://docs.couchdrop.io/features/transfer-automations) or [File Actions](https://docs.couchdrop.io/features/file-actions) . [](https://docs.couchdrop.io/connections/connect-platforms/azure-queue#requirements) 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 [](https://docs.couchdrop.io/connections/connect-platforms/azure-queue#configuration-steps) 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** [PreviousAmazon SQS](https://docs.couchdrop.io/connections/connect-platforms/amazon-sqs) [NextGoogle PubSub](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub) Last updated 4 months ago Was this helpful? * [Introduction to Azure Queue with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/azure-queue#introduction-to-azure-queue-with-couchdrop) * [How Azure Queue works with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/azure-queue#how-azure-queue-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-platforms/azure-queue#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-platforms/azure-queue#configuration-steps) Was this helpful? --- # Creating Users | Couchdrop Knowledge Base 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](https://docs.couchdrop.io/administration/users-and-groups/creating-users#video-guide) [](https://docs.couchdrop.io/administration/users-and-groups/creating-users#creating-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 [The Root Directory](https://docs.couchdrop.io/administration/users-and-groups/the-root-directory) . [](https://docs.couchdrop.io/administration/users-and-groups/creating-users#inviting-users-to-couchdrop) 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** [PreviousUser Roles](https://docs.couchdrop.io/administration/users-and-groups/user-roles) [NextThe Root Directory](https://docs.couchdrop.io/administration/users-and-groups/the-root-directory) Last updated 4 months ago Was this helpful? * [Creating Users Manually](https://docs.couchdrop.io/administration/users-and-groups/creating-users#creating-users-manually) * [Inviting Users to Couchdrop](https://docs.couchdrop.io/administration/users-and-groups/creating-users#inviting-users-to-couchdrop) Was this helpful? --- # Account expiry | Couchdrop Knowledge Base 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. [PreviousAccount Lockout](https://docs.couchdrop.io/administration/security/account-lockout) [NextTwo Factor Authentication](https://docs.couchdrop.io/administration/security/two-factor-authentication) Last updated 1 year ago Was this helpful? Was this helpful? --- # Two Factor Authentication | Couchdrop Knowledge Base [](https://docs.couchdrop.io/administration/security/two-factor-authentication#overview) 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. [](https://docs.couchdrop.io/administration/security/two-factor-authentication#enabling-two-factor-authentication) Enabling Two Factor Authentication ---------------------------------------------------------------------------------------------------------------------------------------------------------- Users can self manage 2fa by logging into the Couchdrop Web App and clicking on their user profile. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FlCMP5Q6wyQ8NTcsRUT5W%252FScreenshot%25202024-03-30%2520at%25209.30.08%2520PM.png%3Falt%3Dmedia%26token%3Dfc4ad5b3-af61-44b8-810b-0dba5e4c0dc7&width=768&dpr=4&quality=100&sign=e70db976&sv=2) ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FNEnHqN9cjnphwHfjpPfm%252FScreenshot%25202024-03-30%2520at%25209.30.29%2520PM.png%3Falt%3Dmedia%26token%3Ddad54bec-af2b-49b3-8921-b47ac72a0e74&width=768&dpr=4&quality=100&sign=984c2aca&sv=2) [](https://docs.couchdrop.io/administration/security/two-factor-authentication#forcing-the-use-of-mfa-two-factor-authentication) 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** ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252F2gJOhv0CGlSs2hf2xCgU%252FScreenshot%25202024-03-30%2520at%25209.16.37%2520PM.png%3Falt%3Dmedia%26token%3D5c445af4-153a-4376-b89c-12a64658f0c1&width=768&dpr=4&quality=100&sign=280cc547&sv=2) [](https://docs.couchdrop.io/administration/security/two-factor-authentication#debugging-issues) 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. [PreviousAccount expiry](https://docs.couchdrop.io/administration/security/account-expiry) [NextStatic IPs](https://docs.couchdrop.io/administration/static-ips) Last updated 1 year ago Was this helpful? * [Overview](https://docs.couchdrop.io/administration/security/two-factor-authentication#overview) * [Enabling Two Factor Authentication](https://docs.couchdrop.io/administration/security/two-factor-authentication#enabling-two-factor-authentication) * [Forcing the use of MFA/Two Factor Authentication](https://docs.couchdrop.io/administration/security/two-factor-authentication#forcing-the-use-of-mfa-two-factor-authentication) * [Debugging issues](https://docs.couchdrop.io/administration/security/two-factor-authentication#debugging-issues) Was this helpful? --- # SAML SSO | Couchdrop Knowledge Base Couchdrop can be configured for SAML authentication via the web interface. ### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso#pre-requisites) 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. ### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso#configuration-steps) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FY9q34N0RQ084NERKDqPh%252FSAML-SSO.png%3Falt%3Dmedia%26token%3Db09e5912-2c12-4a63-ad90-6d8ddeb1f8e6&width=768&dpr=4&quality=100&sign=860e5832&sv=2) ### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso#azure-saml-setup) Azure SAML Setup #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso#required-fields) 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. [PreviousSSO and Single Sign-on](https://docs.couchdrop.io/administration/sso-and-single-sign-on) [NextSCIM - Azure](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure) Last updated 10 months ago Was this helpful? * [Pre-Requisites](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso#pre-requisites) * [Configuration Steps](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso#configuration-steps) * [Azure SAML Setup](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso#azure-saml-setup) Was this helpful? --- # Password Policies | Couchdrop Knowledge Base Couchdrop allows administrators to create comprehensive password policies that enforce good password management to meet security and compliance requirements. [](https://docs.couchdrop.io/administration/security/password-policies#global-password-policies) 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** [](https://docs.couchdrop.io/administration/security/password-policies#group-password-policies) 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. [](https://docs.couchdrop.io/administration/security/password-policies#password-expiry) 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. [PreviousSecurity](https://docs.couchdrop.io/administration/security) [NextAccount Lockout](https://docs.couchdrop.io/administration/security/account-lockout) Last updated 1 year ago Was this helpful? * [Global Password Policies](https://docs.couchdrop.io/administration/security/password-policies#global-password-policies) * [Group Password Policies](https://docs.couchdrop.io/administration/security/password-policies#group-password-policies) * [Password expiry](https://docs.couchdrop.io/administration/security/password-policies#password-expiry) Was this helpful? --- # Microsoft Sentinel | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/administration/logging/microsoft-sentinel#requirements) Requirements #### [](https://docs.couchdrop.io/administration/logging/microsoft-sentinel#required-configuration) Required Configuration To connect to Azure Monitor you will need: * Azure Tenant ID * Azure Client ID * Azure Client Secret * Log Ingestion Endpoint * DCR Immutable ID * Stream Name To learn how to setup Azure Monitor API access you can visit [https://learn.microsoft.com/en-us/azure/azure-monitor/logs/logs-ingestion-api-overview](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/logs-ingestion-api-overview) ### [](https://docs.couchdrop.io/administration/logging/microsoft-sentinel#configuration-steps) 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 5. Click **Save Updates** [PreviousSplunk](https://docs.couchdrop.io/administration/logging/splunk) [NextElastic](https://docs.couchdrop.io/administration/logging/elastic) Last updated 6 months ago Was this helpful? * [Requirements](https://docs.couchdrop.io/administration/logging/microsoft-sentinel#requirements) * [Configuration Steps](https://docs.couchdrop.io/administration/logging/microsoft-sentinel#configuration-steps) Was this helpful? --- # Elastic | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/administration/logging/elastic#requirements) Requirements #### [](https://docs.couchdrop.io/administration/logging/elastic#required-configuration) 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 [https://www.elastic.co/docs/reference/logstash/plugins/plugins-inputs-http](https://www.elastic.co/docs/reference/logstash/plugins/plugins-inputs-http) ### [](https://docs.couchdrop.io/administration/logging/elastic#configuration-steps) 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 5. Click **Save Updates** [PreviousMicrosoft Sentinel](https://docs.couchdrop.io/administration/logging/microsoft-sentinel) [NextWebhook](https://docs.couchdrop.io/administration/logging/webhook) Last updated 6 months ago Was this helpful? * [Requirements](https://docs.couchdrop.io/administration/logging/elastic#requirements) * [Configuration Steps](https://docs.couchdrop.io/administration/logging/elastic#configuration-steps) Was this helpful? --- # Proxy Configuration | Couchdrop Knowledge Base In networks where internet access is only allowed behind a proxy server some additional manual configuration is needed. ### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/proxy-configuration#configuration-steps) Configuration steps For detailed configuration instructions, see [Windows / Mac File Server](https://docs.couchdrop.io/connections/connect-storage/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: Copy { ... "proxies": { "http": "", "https": "" }, ... } 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. #### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/proxy-configuration#proxy-url-syntax-examples) Proxy URL syntax examples: Type Format Example Simple, no username and password http://: [http://127.0.0.1:8080](http://127.0.0.1:8080/) With username and password http://username:password@: [http://proxyuser:\[email protected\]:8080](http://proxyuser:password@127.0.0.1:8080/) Socks socks://: [socks://127.0.0.1:8080](http://13.238.142.115:8080/) ### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/proxy-configuration#debugging) 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 [\[email protected\]](https://docs.couchdrop.io/cdn-cgi/l/email-protection#dba8aeababb4a9af9bb8b4aeb8b3bfa9b4abf5b2b4) . [PreviousServer Requirements](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements) [NextNon-GUI Environments](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/non-gui-environments) Last updated 10 months ago Was this helpful? * [Configuration steps](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/proxy-configuration#configuration-steps) * [Debugging](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/proxy-configuration#debugging) Was this helpful? --- # Google PubSub | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub#introduction-to-google-pubsub-with-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252Fzlf71VgYjTp1vFu6aB4c%252FScreenshot-from-2022-03-03-15-32-26-1024x467.webp%3Falt%3Dmedia%26token%3D4a1918ae-c2f4-42cf-aa0d-c78ee903c8eb&width=768&dpr=4&quality=100&sign=edf23147&sv=2) [](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub#how-google-pubsub-works-with-couchdrop) 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 [virtual folder](https://docs.couchdrop.io/connections/virtual-folders) as Couchdrop, rather Google PubSub is configured as a connection that you can use in a file action inside an [Transfer Automations](https://docs.couchdrop.io/features/transfer-automations) or [File Actions](https://docs.couchdrop.io/features/file-actions) . Connecting Couchdrop to a Google PubSub queue is straight-forward [](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub#requirements) 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 * Create a service account, and then create a key for that account, and download the JSON file associated to use within Couchdrop [](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub#configuration-steps) 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** [PreviousAzure Queue](https://docs.couchdrop.io/connections/connect-platforms/azure-queue) [NextUsers and Groups](https://docs.couchdrop.io/administration/users-and-groups) Last updated 4 months ago Was this helpful? * [Introduction to Google PubSub with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub#introduction-to-google-pubsub-with-couchdrop) * [How Google PubSub works with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub#how-google-pubsub-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-platforms/google-pubsub#configuration-steps) Was this helpful? --- # Server Requirements | Couchdrop Knowledge Base 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. [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#server-requirements) Server Requirements -------------------------------------------------------------------------------------------------------------------------------------------------- While connection requirements can vary depending on the types of transfers involved, we recommend the resources below. Component Recommendation CPU 4-8 VCPU Core Memory 16GB Hard Disk Space 32GB of free disk [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#supported-windows-versions) 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\]](https://docs.couchdrop.io/cdn-cgi/l/email-protection#e794929797889593a7848892848f83958897c98e88) . ### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#software-requirements) Software Requirements You will need Microsoft .NET Framework 4.7.2 to open the agent. ### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#network-requirements) 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. ### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#firewall-requirements) 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\]](https://docs.couchdrop.io/cdn-cgi/l/email-protection#2d5e585d5d425f596d4e42584e45495f425d034442) [PreviousWindows / Mac File Server](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server) [NextProxy Configuration](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/proxy-configuration) Last updated 10 months ago Was this helpful? * [Server Requirements](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#server-requirements) * [Supported Windows Versions](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#supported-windows-versions) * [Software Requirements](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#software-requirements) * [Network Requirements](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#network-requirements) * [Firewall Requirements](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/server-requirements#firewall-requirements) Was this helpful? --- # Boomi | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-ipaas/boomi#introduction-to-boomi-with-couchdrop) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252F9kvhgq4fFnQRXXNOz1Ob%252Fboomi-image.jpg%3Falt%3Dmedia%26token%3D61639155-596e-4814-840b-de9857a37d49&width=768&dpr=4&quality=100&sign=74de1731&sv=2) [](https://docs.couchdrop.io/connections/connect-ipaas/boomi#how-boomi-works-with-couchdrop) 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. [](https://docs.couchdrop.io/connections/connect-ipaas/boomi#requirements) 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** * **Endpoint (Simple URL Path)** * **Username** and **Token** from Shared Web Server → User Management Boomi has a **5 MB maximum file size** limit for incoming files [](https://docs.couchdrop.io/connections/connect-ipaas/boomi#configuration-steps) 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) * The Boomi **Environment API URL**, **Endpoint**, **Username**, and **Token** * Save the configuration Files uploaded into the Couchdrop folder will now be sent automatically to your Boomi process. [PreviousConnect IPaaS](https://docs.couchdrop.io/connections/connect-ipaas) [NextCeligo](https://docs.couchdrop.io/connections/connect-ipaas/celigo) Last updated 4 months ago Was this helpful? * [Introduction to Boomi with Couchdrop](https://docs.couchdrop.io/connections/connect-ipaas/boomi#introduction-to-boomi-with-couchdrop) * [How Boomi works with Couchdrop](https://docs.couchdrop.io/connections/connect-ipaas/boomi#how-boomi-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-ipaas/boomi#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-ipaas/boomi#configuration-steps) Was this helpful? --- # Connect to SFTP | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#introduction) 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. ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#requirements) 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 ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#configuration-steps) 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. ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#how-it-works) 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](https://docs.couchdrop.io/connections/virtual-folders) **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 File Actions (copy, move) Yes Transfer Automations Yes ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#frequently-asked-questions) Frequently Asked Questions Do you support RSA key based authentication[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#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[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#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[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#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[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#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[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#are-sftp-connections-encrypted-with-couchdrop) Absolutely - SFTP as a protocol is very secure and uses asymetric SSL encryption. ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#common-issues-and-errors) Common issues and errors Access denied[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#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[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#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. [PreviousConnect Providers/Partners](https://docs.couchdrop.io/connections/connect-providers-partners) [NextConnect to FTPs](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#configuration-steps) * [How it works](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#how-it-works) * [Frequently Asked Questions](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#frequently-asked-questions) * [Common issues and errors](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp#common-issues-and-errors) Was this helpful? --- # Non-GUI Environments | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/non-gui-environments#install-the-agent-on-your-workstation) Install the agent on your Workstation --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- First, you need to install and configure the Couchdrop agent (Couchdrop Cloud Connector) on your workstation. You can [follow the article here](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server) 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 C:\Users\%username%\AppData\Local\CouchdropCloudConnector 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. ### [](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/non-gui-environments#set-up-the-agent-on-the-server) 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. Copy C:\Couchdrop\couchdrop-cloud-connector-installer.msi /quiet 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. Copy C:\Users\%username%\AppData\Local\CouchdropCloudConnector Now, we need to set up the agent as a service. [Follow the article here](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/running-the-couchdrop-agent-as-a-service) 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. [PreviousProxy Configuration](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/proxy-configuration) [NextRunning the Couchdrop Agent as a Service](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/running-the-couchdrop-agent-as-a-service) Last updated 10 months ago Was this helpful? * [Install the agent on your Workstation](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/non-gui-environments#install-the-agent-on-your-workstation) * [Set up the agent on the Server](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/non-gui-environments#set-up-the-agent-on-the-server) Was this helpful? Copy .\couchdrop-cloud-connector-service.exe install --- # Security | Couchdrop Knowledge Base [Password Policies](https://docs.couchdrop.io/administration/security/password-policies) [Account Lockout](https://docs.couchdrop.io/administration/security/account-lockout) [Account expiry](https://docs.couchdrop.io/administration/security/account-expiry) [Two Factor Authentication](https://docs.couchdrop.io/administration/security/two-factor-authentication) [PreviousCustom Domains](https://docs.couchdrop.io/administration/custom-domains) [NextPassword Policies](https://docs.couchdrop.io/administration/security/password-policies) Was this helpful? Was this helpful? --- # Webhook | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/administration/logging/webhook#requirements) Requirements #### [](https://docs.couchdrop.io/administration/logging/webhook#required-configuration) Required Configuration To setup a Webhook you will need: * Webhook Endpoint * Event JSON attribute #### [](https://docs.couchdrop.io/administration/logging/webhook#optional-configuration) 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 ### [](https://docs.couchdrop.io/administration/logging/webhook#configuration-steps) 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** [PreviousElastic](https://docs.couchdrop.io/administration/logging/elastic) [NextSSO and Single Sign-on](https://docs.couchdrop.io/administration/sso-and-single-sign-on) Last updated 6 months ago Was this helpful? * [Requirements](https://docs.couchdrop.io/administration/logging/webhook#requirements) * [Configuration Steps](https://docs.couchdrop.io/administration/logging/webhook#configuration-steps) Was this helpful? --- # SCIM - Okta | Couchdrop Knowledge Base This guide will help you if you want to provision Users between Okta and Couchdrop. ### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta#supported-features) Supported Features * **Push Users** Users created in Okta will also be created in Couchdrop * **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 ### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta#configuration-steps) Configuration Steps #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta#create-user-provisioning-token-in-couchdrop) Create User Provisioning Token in Couchdrop Navigate to [User Provisioning](https://my.couchdrop.io/manage/settings/userProvisioning) in Couchdrop’s interface and **create a new Provisioning Token**. This will be used in the Azure Active Directory provisioning process. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252F0LUQhobVR77T3rhUTXvq%252FCreate-Provisioning-Token.png%3Falt%3Dmedia%26token%3Dc3a718e6-dc52-4b95-82ff-75fe07b6d93f&width=768&dpr=4&quality=100&sign=614e9661&sv=2) #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta#setup-an-scim-application-for-user-provisioning-in-okta) 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_ ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5777792902159&width=768&dpr=4&quality=100&sign=d724d363&sv=2) Search for Couchdrop SCIM and select the application ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5777795296271&width=768&dpr=4&quality=100&sign=f0967469&sv=2) 02\_Select\_Couchdrop\_App Click on _Add Integration_ and then on _Done_ ![03_Add_Integration.png](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5777834191759&width=300&dpr=4&quality=100&sign=3bb9e36a&sv=2) ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5777843421455&width=768&dpr=4&quality=100&sign=f71c0ddb&sv=2) 04\_Add\_Couchdrop\_SCIM\_Done Assign User and Groups to the Application ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5779292931855&width=768&dpr=4&quality=100&sign=f0183eb7&sv=2) 05\_Assign\_Users Then configure the user provisioning by selecting the _Provisioning_ tab and click _Configure API Integration_ ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5779343710863&width=768&dpr=4&quality=100&sign=68ab5b3c&sv=2) 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_. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5779347950351&width=768&dpr=4&quality=100&sign=6dd885ce&sv=2) 07\_Enable\_API\_and\_test Select _Edit_ and enable _Create User,_ _Update User Attributes_ and _Deactivate Users_ ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5779402620175&width=768&dpr=4&quality=100&sign=7a688a5e&sv=2) 08\_Edit\_Provisioning ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5779461014287&width=768&dpr=4&quality=100&sign=96fc05f2&sv=2) 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](https://help.okta.com/en-us/Content/Topics/users-groups-profiles/usgp-about-group-push.htm#:~:text=Group%20Push%20lets%20you%20push,groups%20are%20managed%20from%20Okta.) ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5779479376655&width=768&dpr=4&quality=100&sign=413624d5&sv=2) 10\_Groups\_push #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta#configure-user-and-group-import-from-couchdrop-to-okta) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5858376467727&width=768&dpr=4&quality=100&sign=a10bb1b4&sv=2) 11\_ToOktaImport Then on the _Import_ Tab click the _Import Now_ button ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5858394676239&width=768&dpr=4&quality=100&sign=bc9176e8&sv=2) 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 ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5858458065423&width=768&dpr=4&quality=100&sign=4f5f076a&sv=2) 13\_Assign\_overview and click _Confirm Assignments_ to trigger the import. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5858458064911&width=768&dpr=4&quality=100&sign=ea373963&sv=2) 14\_assign\_confirm [PreviousSCIM - Azure](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure) [NextCustom Domains](https://docs.couchdrop.io/administration/custom-domains) Last updated 10 months ago Was this helpful? * [Supported Features](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta#supported-features) * [Configuration Steps](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta#configuration-steps) Was this helpful? --- # SFTP Recipes | Couchdrop Knowledge Base [Using SFTP with Azure Blob](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob) [Using SFTP with Azure Files](https://www.couchdrop.io/blog/microsoft-azure-sftp) [Using SFTP To SharePoint](https://www.couchdrop.io/blog/connecting-couchdrop-sftp-with-sharepoint) [Using SFTP Clients](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients) [Using SFTP/SSH Keys](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys) [PreviousMalware Scanning](https://docs.couchdrop.io/administration/malware-scanning) [NextUsing SFTP with Azure Blob](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob) Was this helpful? Was this helpful? --- # Connect to FTPs | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#introduction) 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. ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#requirements) 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 ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#configuration-steps) 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 5. Choose a subfolder from the folder selector 6. Click **Save Settings** Most FTP providers use **port 21 .** Check with your provider - but if unsure - try this port first. ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#how-it-works) 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 [here](https://docs.couchdrop.io/connections/virtual-folders) **Supported features with external** FTP **servers** Feature Supported Inbound SFTP and FTPs Yes Inbound Mailboxes Yes Upload Links Yes Inbound Web hooks (https) Yes Inbound AS2 Yes Inbound S3 (S3 Gateway) Yes File Actions (copy, move) Yes Transfer Automations Yes ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#frequently-asked-questions) Frequently Asked Questions Can we schedule a copy from one FTP server to the cloud[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#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[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#can-couchdrop-provide-static-ips-that-we-can-whitelist) Yes - Contact our support team to request static IPs. Do you support TLS[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#do-you-support-tls) Yes - Connecting via TLS is enabled by default with external connections Do you support implicit SSL for external FTP providers[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#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\]](https://docs.couchdrop.io/cdn-cgi/l/email-protection) and we can chat about options and workarounds ### [](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#common-issues-and-errors) Common issues and errors Access denied[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#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[](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#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. [PreviousConnect to SFTP](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-sftp) [NextAS2](https://docs.couchdrop.io/connections/connect-providers-partners/as2) Last updated 4 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#introduction) * [Requirements](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#configuration-steps) * [How it works](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#how-it-works) * [Frequently Asked Questions](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#frequently-asked-questions) * [Common issues and errors](https://docs.couchdrop.io/connections/connect-providers-partners/connect-to-ftps#common-issues-and-errors) Was this helpful? --- # Running the Couchdrop Agent as a Service | Couchdrop Knowledge Base 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](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server) [.](https://community.movebot.io/hc/en-us/articles/360002289775) 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. Copy .\couchdrop-cloud-connector-service.exe install Next, open the service manager: Copy 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.** [PreviousNon-GUI Environments](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/non-gui-environments) [NextLogging and Debugging](https://docs.couchdrop.io/connections/connect-storage/windows-mac-file-server/logging-and-debugging) Last updated 10 months ago Was this helpful? Was this helpful? --- # Snowflake | Couchdrop Knowledge Base [](https://docs.couchdrop.io/connections/connect-platforms/snowflake#introduction-to-snowflake-with-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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252Fg2RFFRdNfvjAb0nWm4Qu%252Fsnowflake.webp%3Falt%3Dmedia%26token%3D05ed1f94-6d2f-4b3f-b9e7-03bd6c209cf6&width=768&dpr=4&quality=100&sign=f56d21c2&sv=2) [](https://docs.couchdrop.io/connections/connect-platforms/snowflake#how-snowflake-works-with-couchdrop) 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](https://docs.couchdrop.io/connections/virtual-folders) 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](https://docs.couchdrop.io/features/transfer-automations) or [File Actions](https://docs.couchdrop.io/features/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. [](https://docs.couchdrop.io/connections/connect-platforms/snowflake#requirements) 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 [](https://docs.couchdrop.io/connections/connect-platforms/snowflake#configuration-steps) 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. [](https://docs.couchdrop.io/connections/connect-platforms/snowflake#common-issues-connecting-to-snowflake) 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](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 [PreviousConnect Platforms](https://docs.couchdrop.io/connections/connect-platforms) [NextSupabase](https://docs.couchdrop.io/connections/connect-platforms/supabase) Last updated 4 months ago Was this helpful? * [Introduction to Snowflake with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/snowflake#introduction-to-snowflake-with-couchdrop) * [How Snowflake works with Couchdrop](https://docs.couchdrop.io/connections/connect-platforms/snowflake#how-snowflake-works-with-couchdrop) * [Requirements](https://docs.couchdrop.io/connections/connect-platforms/snowflake#requirements) * [Configuration Steps](https://docs.couchdrop.io/connections/connect-platforms/snowflake#configuration-steps) * [Common issues connecting to Snowflake](https://docs.couchdrop.io/connections/connect-platforms/snowflake#common-issues-connecting-to-snowflake) Was this helpful? Copy CREATE|ALTER AUTHENTICATION POLICY PAT_POLICY=( NETWORK_POLICY_EVALUATION = NOT_REQUIRED ); Copy DESCRIBE AUTHENTICATION POLICY ; Copy ALTER AUTHENTICATION POLICY SET AUTHENTICATION_METHODS = ('PROGRAMMATIC_ACCESS_TOKEN'); Copy ALTER USER IF EXISTS ADD PROGRAMMATIC ACCESS TOKEN example_token; --- # SCIM - Azure | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#supported-features) 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 * **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 ### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#configuration-steps) Configuration Steps #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#create-user-provisioning-token-in-couchdrop) Create User Provisioning Token in Couchdrop Navigate to [User Provisioning](https://my.couchdrop.io/manage/settings/userProvisioning) in Couchdrop’s interface and **create a new Provisioning Token**. This will be used in the Azure Active Directory provisioning process. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252F0LUQhobVR77T3rhUTXvq%252FCreate-Provisioning-Token.png%3Falt%3Dmedia%26token%3Dc3a718e6-dc52-4b95-82ff-75fe07b6d93f&width=768&dpr=4&quality=100&sign=614e9661&sv=2) #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#configure-enterprise-application-in-azure-active-directory) Configure Enterprise Application in Azure Active Directory Navigate to your [Administration dashboard](https://aad.portal.azure.com/#blade/Microsoft_AAD_IAM/AppGalleryBladeV2) in Microsoft’s admin portal and **create an enterprise application.** ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598072976143%2Fmceclip1.png&width=768&dpr=4&quality=100&sign=1d7b2d97&sv=2) Provide a name for the application and select “Integrate any other application you don’t find in the gallery (Non-gallery) ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598073126287%2Fmceclip2.png&width=768&dpr=4&quality=100&sign=5f6b4481&sv=2) Next assign users and groups to the newly created application that you would like to have provisioned in Couchdrop. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598073216399%2Fmceclip3.png&width=768&dpr=4&quality=100&sign=bcf4402&sv=2) Select **Add user/group** ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598029468943%2Fmceclip4.png&width=768&dpr=4&quality=100&sign=191ceeaa&sv=2) Select the desired users or groups that should be provisioned through to Couchdrop then **Select** and **Assign**. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598029580303%2Fmceclip5.png&width=768&dpr=4&quality=100&sign=ce31c9a&sv=2) #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#configure-scim-provisioning-between-azure-active-directory-and-couchdrop) 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](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**. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598029772687%2Fmceclip6.png&width=768&dpr=4&quality=100&sign=cc4e06b7&sv=2) #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#configure-user-mapping) 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 ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598074193295%2Fmceclip7.png&width=768&dpr=4&quality=100&sign=ac3e0e66&sv=2) The **externalId** attribute may need to be remapped from **mailNickname** to **objectId** on the Azure Active Directory attribute side depending on your settings. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598074565263%2Fmceclip8.png&width=768&dpr=4&quality=100&sign=83b789fb&sv=2) #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#configure-group-mapping) 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 ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598030447759%2Fmceclip9.png&width=768&dpr=4&quality=100&sign=e75e150d&sv=2) #### [](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#start-the-user-and-group-provisioning-process) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598030648463%2Fmceclip10.png&width=768&dpr=4&quality=100&sign=e74935a2&sv=2) 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.** ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2Fcommunity.couchdrop.io%2Fhc%2Farticle_attachments%2F5598031249807%2Fmceclip11.png&width=768&dpr=4&quality=100&sign=1bdcb87f&sv=2) [PreviousSAML SSO](https://docs.couchdrop.io/administration/sso-and-single-sign-on/saml-sso) [NextSCIM - Okta](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-okta) Last updated 10 months ago Was this helpful? * [Supported Features](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#supported-features) * [Configuration Steps](https://docs.couchdrop.io/administration/sso-and-single-sign-on/scim-azure#configuration-steps) Was this helpful? --- # Using SFTP/SSH Keys | Couchdrop Knowledge Base [How to create a SFTP/SSH key on Windows](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows) [How to create a SFTP/SSH Key On MacOS](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos) [How to create a SFTP/SSH Key On Linux](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux) [How to convert a PPK key to RSA](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa) [How to encrypt/decrypt a private key](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-encrypt-decrypt-a-private-key) [PreviousUsing SCP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-scp) [NextHow to create a SFTP/SSH key on Windows](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows) Was this helpful? Was this helpful? --- # Using SFTP with Azure Blob | Couchdrop Knowledge Base [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#overview) 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. ### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#what-is-azure-blob) 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. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252Fob366gRQpthDwSuCOOOA%252Fazure-blob-icon.png%3Falt%3Dmedia%26token%3D5f27d7a5-a2f8-4976-a7e3-02309317cd27&width=768&dpr=4&quality=100&sign=d75b3743&sv=2) ### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#what-is-sftp) What is SFTP SFTP is the most widely adopted protocol for securely sending and retrieving files in a system to system environment. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#requirements) Requirements ----------------------------------------------------------------------------------------------------------------- To use SFTP with Azure Blob - there are a couple of things you will need 1. An Couchdrop account - you can register at [https://my.couchdrop.io](https://my.couchdrop.io/) 2. An Azure Blob container and access to the Azure portal as an administrator 3. 5 minutes spare and a coffee [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#configuration-steps) Configuration Steps ------------------------------------------------------------------------------------------------------------------------------- 1. Connect Couchdrop and Azure Blob. This is outlined [here](https://docs.couchdrop.io/connections/connect-storage/azure-blob) . 2. Create an SFTP user in Couchdrop and attach them to the Azure folder. Configuring SFTP users in Couchdrop is detailed in [this article](https://docs.couchdrop.io/features/inbound-sftp/create-sftp-users) . 3. Connect and test [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#how-it-works) 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. [PreviousSFTP Recipes](https://docs.couchdrop.io/walkthroughs/sftp-recipes) [NextUsing SFTP Clients](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients) Last updated 4 months ago Was this helpful? * [Overview](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#overview) * [What is Azure Blob](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#what-is-azure-blob) * [What is SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#what-is-sftp) * [Requirements](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#requirements) * [Configuration Steps](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#configuration-steps) * [How it Works](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob#how-it-works) Was this helpful? --- # User Roles | Couchdrop Knowledge Base Couchdrop has a very simple role structure. When thinking about users in Couchdrop, there are **Internal Users** and **External Users**. #### [](https://docs.couchdrop.io/administration/users-and-groups/user-roles#internal-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. 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 #### [](https://docs.couchdrop.io/administration/users-and-groups/user-roles#external-users) 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. [](https://docs.couchdrop.io/administration/users-and-groups/user-roles#available-roles-in-couchdrop) 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. [](https://docs.couchdrop.io/administration/users-and-groups/user-roles#feature-restrictions) 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. [PreviousUsers and Groups](https://docs.couchdrop.io/administration/users-and-groups) [NextCreating Users](https://docs.couchdrop.io/administration/users-and-groups/creating-users) Last updated 2 months ago Was this helpful? * [Available Roles in Couchdrop](https://docs.couchdrop.io/administration/users-and-groups/user-roles#available-roles-in-couchdrop) * [Feature Restrictions](https://docs.couchdrop.io/administration/users-and-groups/user-roles#feature-restrictions) Was this helpful? --- # How to encrypt/decrypt a private key | Couchdrop Knowledge Base [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-encrypt-decrypt-a-private-key#encrypt-a-private-key-on-macos-or-linux) Encrypt a private key on MacOS or Linux ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-encrypt-decrypt-a-private-key#id-1.-check-if-your-key-is-already-encrypted) **1\. Check if Your Key Is Already Encrypted** Private keys are usually stored in `~/.ssh/`. To check: Copy cat ~/.ssh/id_rsa * If you see `ENCRYPTED` in the header (like `-----BEGIN OPENSSH PRIVATE KEY-----` with `ENCRYPTED` noted), then it’s already passphrase-protected. * If not, you can encrypt it. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-encrypt-decrypt-a-private-key#id-2.-encrypt-or-change-the-passphrase) **2\. Encrypt or Change the Passphrase** Copy ssh-keygen -p -f ~/.ssh/id_rsa * `-p` → prompts you to change the passphrase. * `-f` → specifies the key file. You’ll be asked for: 1. The old passphrase (press **Enter** if none exists). 2. A new passphrase (twice, for confirmation). This adds strong encryption to your private key file. * * * Now your private key is safely encrypted with a passphrase. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-encrypt-decrypt-a-private-key#decrypt-a-private-key-in-macos-or-linux) Decrypt a private key in MacOS or Linux ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Decrypting a RSA private key can be done using a single command You will be prompted for the current passphrase. Do not pass the old passphrase on the command line (it would be visible in process lists). [PreviousHow to convert a PPK key to RSA](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa) [NextFAQs](https://docs.couchdrop.io/other/faqs) Last updated 3 months ago Was this helpful? * [Encrypt a private key on MacOS or Linux](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-encrypt-decrypt-a-private-key#encrypt-a-private-key-on-macos-or-linux) * [Decrypt a private key in MacOS or Linux](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-encrypt-decrypt-a-private-key#decrypt-a-private-key-in-macos-or-linux) Was this helpful? Copy ssh-keygen -p -f ~/.ssh/id_rsa -N "" --- # Using SFTP Clients | Couchdrop Knowledge Base [OpenSSH SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/openssh-sftp) [How to use SFTP with Cyberduck](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-cyberduck) [How to use SFTP with FileZilla](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-filezilla) [Using SFTP with Golang](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-golang) [Using Python with SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-python-with-sftp) [Using SFTP with Java](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-java) [Using SFTP with Bash](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-bash) [Using SCP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-scp) [PreviousUsing SFTP with Azure Blob](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-with-azure-blob) [NextOpenSSH SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/openssh-sftp) Was this helpful? Was this helpful? --- # FAQs | Couchdrop Knowledge Base ### [](https://docs.couchdrop.io/other/faqs#can-you-access-my-data) Can you access my data? Couchdrop’s support team may access your file metadata (not file data) and logs for support purposes only. Couchdrop’s engineering staff have access to the underlying technology that can access metadata and log information and the storage locations of the actual data. The encryption keys required to decrypt the actual data are stored in a key-management escrow service operated by Doppler. It is possible within the product to block Couchdrop employees' access within the application. It is a check box under [Administration -> Security](https://app.couchdrop.io/manage/settings/advanced) . Note, if you do require support, Couchdrop may request you enable this or join them for a screen sharing session. ![](https://docs.couchdrop.io/~gitbook/image?url=https%3A%2F%2F391958821-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FpokYqd27yrOUxIBhyvbF%252Fuploads%252FBvKezkUC6PZRpZyYmDvr%252Fmceclip0%2520%281%29.png%3Falt%3Dmedia%26token%3D7099c0db-f3a2-4ec7-bbec-6d9420e50dfe&width=768&dpr=4&quality=100&sign=c1bb29dc&sv=2) ### [](https://docs.couchdrop.io/other/faqs#does-couchdrop-lockout-users-after-to-many-failed-attempts) Does Couchdrop lockout users after to many failed attempts? Yes, see [Account Lockout](https://docs.couchdrop.io/administration/security/account-lockout) for more details ### [](https://docs.couchdrop.io/other/faqs#where-is-my-data-stored) Where is my data stored? Couchdrop stores configuration and metadata in the USA, deep inside fort Amazon AWS. For more information on our approach to data soverienty and security, visit our trusts center [https://trust.couchdrop.io](https://trust.couchdrop.io/) ### [](https://docs.couchdrop.io/other/faqs#do-i-have-to-connect-my-own-storage) Do I have to connect my own storage? No no, we hear you. Couchdrop comes with storage through AWS. Learn more about this [Storage](https://docs.couchdrop.io/features/inbound-sftp/storage) [PreviousHow to encrypt/decrypt a private key](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-encrypt-decrypt-a-private-key) Last updated 1 year ago Was this helpful? * [Can you access my data?](https://docs.couchdrop.io/other/faqs#can-you-access-my-data) * [Does Couchdrop lockout users after to many failed attempts?](https://docs.couchdrop.io/other/faqs#does-couchdrop-lockout-users-after-to-many-failed-attempts) * [Where is my data stored?](https://docs.couchdrop.io/other/faqs#where-is-my-data-stored) * [Do I have to connect my own storage?](https://docs.couchdrop.io/other/faqs#do-i-have-to-connect-my-own-storage) Was this helpful? --- # OpenSSH SFTP | Couchdrop Knowledge Base 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`. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/openssh-sftp#how-to-use-openssh-sftp) How to use OpenSSH SFTP -------------------------------------------------------------------------------------------------------------------------------------------- Here's a brief overview of how to use the `sftp` command: 1. **Connecting to a Server**: * To connect to an SSH server using SFTP, you would typically use the following command: Copy sftp username@hostname * Replace `username` with your username on the server and `hostname` with the hostname or IP address of the server. 2. **Authenticating**: * After executing the command, you will be prompted to enter your password for the specified username. 3. **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. 4. **Transferring Files**: * To upload a file from your local machine to the server, you can use the `put` command: Copy put localfile.txt * To download a file from the server to your local machine, you can use the `get` command: Copy get remotefile.txt 5. **Exiting SFTP**: * To exit the SFTP session, you can use the `exit` command: Copy exit * 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. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/openssh-sftp#using-openssh-sftp-with-couchdrop) Using OpenSSH SFTP with Couchdrop ---------------------------------------------------------------------------------------------------------------------------------------------------------------- Couchdrop supports the default **sftp** command natively. Simply switch out the hostname and credentials from the example above. [PreviousUsing SFTP Clients](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients) [NextHow to use SFTP with Cyberduck](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-cyberduck) Last updated 1 year ago Was this helpful? * [How to use OpenSSH SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/openssh-sftp#how-to-use-openssh-sftp) * [Using OpenSSH SFTP with Couchdrop](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/openssh-sftp#using-openssh-sftp-with-couchdrop) Was this helpful? Copy sftp [email protected] --- # How to create a SFTP/SSH Key On MacOS | Couchdrop Knowledge Base [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos#introduction) Introduction ------------------------------------------------------------------------------------------------------------------------------------------------ RSA keys provide a secure method of authenticating with an SSH or SFTP server without requiring a password. They are based on asymmetric encryption, which uses a matching pair of keys: one public and one private. The public key is shared with the server or service provider, while the private key remains securely on your machine and is used to establish the connection. The keys are stored locally as text files, typically in the `.ssh` directory or saved in the client you are using to connect. For additional protection, the private key can be encrypted with a passphrase, ensuring that even if the file is accessed, it cannot be used without the added layer of security. This combination of encryption and key management makes RSA keys both convenient and highly secure for remote authentication. **Key things to remember:** * The private key is used on the client * The public key is used on the server - and can be shared * Where possible - the private key should be password encrypted If you are connecting using SFTP or SSH - you should never share your private key. Only share the public key. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos#how-to-create-an-rsa-ssh-key-on-macos) How to Create an RSA SSH Key on macOS -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- MacOS comes with everything you need to create a RSA key. You will need to be familiar with using a terminal (command prompt) - but thats an easy hurdle to get past. #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos#id-1.-open-terminal) 1\. Open Terminal * Press **Command + Space** and type `Terminal`, then hit **Enter**. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos#id-2.-generate-the-ssh-key) 2\. Generate the SSH Key Run the following command in your Terminal: * `-t rsa` → specifies RSA as the key type. * `-b 4096` → sets the key length to 4096 bits (more secure than the default 2048). * `-C` → adds a label (usually your email) for identification. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos#id-3.-save-the-key) 3\. Save the Key You’ll be asked where to save the key: * Press **Enter** to accept the default path (`~/.ssh/id_rsa`), or type a custom filename if you want multiple keys. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos#id-4.-set-a-passphrase-optional) 4\. Set a Passphrase (Optional) You can add a passphrase for extra security, or press **Enter** to leave it empty. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos#id-5.-copy-the-public-key) 5\. Copy the Public Key Copy your public key to the clipboard: Now you can paste it into GitHub, GitLab, or any server you want to connect to. [PreviousHow to create a SFTP/SSH key on Windows](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows) [NextHow to create a SFTP/SSH Key On Linux](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux) Last updated 3 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos#introduction) * [How to Create an RSA SSH Key on macOS](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos#how-to-create-an-rsa-ssh-key-on-macos) Was this helpful? Copy ssh-keygen -t rsa -b 4096 -C "[email protected]" Copy Enter file in which to save the key (/Users/yourname/.ssh/id_rsa): Copy pbcopy < ~/.ssh/id_rsa.pub --- # Using Python with SFTP | Couchdrop Knowledge Base Uploading and downloading files with Python is a great way to automate transfers or build out support for SFTP inside you application. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-python-with-sftp#how-to-use-sftp-with-python) How to use SFTP with Python -------------------------------------------------------------------------------------------------------------------------------------------------------------- Using Python with SFTP (SSH File Transfer Protocol) can be accomplished using the `paramiko` library, which allows you to create SSH connections and perform file operations securely. Here's a basic guide on how to use Python with SFTP using `paramiko`: 1. **Install Paramiko**: Before you can use Paramiko, you need to install it. You can install it via pip: Copy pip install paramiko 2. **Connect to the SFTP Server**: Below is an example of how to connect to an SFTP server using Paramiko: Copy import paramiko # Define SFTP connection parameters hostname = 'sftp.example.com' port = 22 username = 'your_username' password = 'your_password' # Create an SSH client ssh_client = paramiko.SSHClient() ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy()) # Connect to the SFTP server ssh_client.connect(hostname, port, username, password) # Create an SFTP session sftp = ssh_client.open_sftp() # Now you can perform SFTP operations 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**: Copy local_file = '/path/to/local/file.txt' remote_file = '/path/to/remote/file.txt' sftp.put(local_file, remote_file) * **Download a file**: Copy remote_file = '/path/to/remote/file.txt' local_file = '/path/to/local/file.txt' sftp.get(remote_file, local_file) * **List directory contents**: Copy directory = '/path/to/directory' files = sftp.listdir(directory) * **Create a directory**: Copy new_directory = '/path/to/new/directory' sftp.mkdir(new_directory) 4. **Close the Connection**: After you've finished with the SFTP operations, make sure to close the connection: Copy sftp.close() ssh_client.close() By following these steps, you can use Python to interact with SFTP servers securely and perform various file operations. Make sure to handle exceptions and errors appropriately, especially when dealing with network connections and file operations. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-python-with-sftp#using-paramiko-and-python-with-couchdrop) Using Paramiko and Python with Couchdrop ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Couchdrop has full support for SFTP uploads with python using Paramiko. 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 [couchdrop-api](https://developers.couchdrop.io/) [PreviousUsing SFTP with Golang](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-golang) [NextUsing SFTP with Java](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-java) Last updated 1 year ago Was this helpful? * [How to use SFTP with Python](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-python-with-sftp#how-to-use-sftp-with-python) * [Using Paramiko and Python with Couchdrop](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-python-with-sftp#using-paramiko-and-python-with-couchdrop) Was this helpful? --- # How to convert a PPK key to RSA | Couchdrop Knowledge Base [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa#converting-using-putty) Converting using Putty -------------------------------------------------------------------------------------------------------------------------------------------------------------- #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa#id-1.-install-puttygen) 1\. Install PuTTYgen * If you don’t already have it, download **PuTTYgen** from the PuTTY download page. * On Windows, it usually installs along with PuTTY. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa#id-2.-open-your-ppk-file) 2\. Open Your PPK File 1. Launch **PuTTYgen**. 2. Click **Load** and browse to your `.ppk` file. * You might need to set the file filter to `*.*` to see your PPK. 3. Once loaded, you’ll see details about the key. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa#id-3.-export-the-pem-key) 3\. Export the PEM Key 1. From the **Conversions** menu, choose: * **Export OpenSSH key** → creates a PEM suitable for SSH. * **Export OpenSSH key (force new file format)** → for newer OpenSSH versions. * **Export OpenSSH key (old PEM format)** → if something expects “classic” PEM. 2. Save the file with a `.pem` extension (e.g., `mykey.pem`). [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa#using-the-command-line) Using the command line -------------------------------------------------------------------------------------------------------------------------------------------------------------- If you have a PPK file on Linux or macOS, you can also use **puttygen** (installed via package manager): * `-O private-openssh` → outputs an OpenSSH-compatible PEM private key. * `-o mykey.pem` → specifies the output filename. * * * After this, you can use the `.pem` file with OpenSSH or cloud providers like AWS EC2. [PreviousHow to create a SFTP/SSH Key On Linux](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux) [NextHow to encrypt/decrypt a private key](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-encrypt-decrypt-a-private-key) Last updated 3 months ago Was this helpful? * [Converting using Putty](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa#converting-using-putty) * [Using the command line](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa#using-the-command-line) Was this helpful? Copy puttygen mykey.ppk -O private-openssh -o mykey.pem --- # How to create a SFTP/SSH key on Windows | Couchdrop Knowledge Base [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#introduction) Introduction -------------------------------------------------------------------------------------------------------------------------------------------------- RSA keys provide a secure method of authenticating with an SSH or SFTP server without requiring a password. They are based on asymmetric encryption, which uses a matching pair of keys: one public and one private. The public key is shared with the server or service provider, while the private key remains securely on your machine and is used to establish the connection. When you attempt to connect, the server uses the public key to generate a challenge that can only be solved by the corresponding private key. This process proves your identity without ever transmitting the private key itself, making the exchange both safe and reliable. The keys are stored locally as text files, typically in the `.ssh` directory or saved in the client you are using to connect. **Key things to remember when create a new key:** * The private key is used on the client * The public key is used on the server - and can be shared * Where possible - the private key should be password encrypted * You will need Powershell If you are connecting using SFTP or SSH - you should never share your private key. Only share the public key. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#how-to-create-an-rsa-ssh-key-on-windows) How to Create an RSA SSH Key on Windows -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#id-1.-open-powershell) 1\. Open PowerShell * Press **Start**, type `PowerShell`, and open **Windows PowerShell**. (If you use Git Bash or WSL, you can follow the same steps there.) * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#id-2.-generate-the-key) 2\. Generate the Key Run the following command: * `-t rsa` → generates an RSA key. * `-b 4096` → sets the key size to 4096 bits (strong security). * `-C` → adds a label, usually your email. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#id-3.-choose-a-save-location) 3\. Choose a Save Location You’ll be prompted with: * Press **Enter** to accept the default, or type a different file path if you want multiple keys. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#id-4.-add-a-passphrase-optional) 4\. Add a Passphrase (Optional) * Enter a passphrase for extra protection, or just press **Enter** to leave it blank. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#id-5.-verify-the-keys) 5\. Verify the Keys Check your `.ssh` folder: You should see: * `id_rsa` → your **private key** * `id_rsa.pub` → your **public key** * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#id-6.-copy-the-public-key) 6\. Copy the Public Key To copy your key to the clipboard: Now you can paste it into GitHub, GitLab, or any server’s authorized keys. [PreviousUsing SFTP/SSH Keys](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys) [NextHow to create a SFTP/SSH Key On MacOS](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos) Last updated 3 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#introduction) * [How to Create an RSA SSH Key on Windows](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-windows#how-to-create-an-rsa-ssh-key-on-windows) Was this helpful? Copy ssh-keygen -t rsa -b 4096 -C "[email protected]" Copy Enter file in which to save the key (C:\Users\YourName/.ssh/id_rsa): Copy dir ~/.ssh Copy Get-Content ~/.ssh/id_rsa.pub | Set-Clipboard --- # How to create a SFTP/SSH Key On Linux | Couchdrop Knowledge Base [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux#introduction) Introduction ------------------------------------------------------------------------------------------------------------------------------------------------ RSA keys provide a secure method of authenticating with an SSH or SFTP server without requiring a password. They are based on asymmetric encryption, which uses a matching pair of keys: one public and one private. The public key is shared with the server or service provider, while the private key remains securely on your machine and is used to establish the connection. When you attempt to connect, the server uses the public key to generate a challenge that can only be solved by the corresponding private key. This process proves your identity without ever transmitting the private key itself, making the exchange both safe and reliable. The keys are stored locally as text files, typically in the `.ssh` directory or saved in the client you are using to connect. **Key things to remember when creating a new key:** * The private key is used on the client * The public key is used on the server - and can be shared * Where possible - the private key should be password encrypted If you are connecting using SFTP or SSH - you should never share your private key. Only share the public key. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux#how-to-create-an-rsa-ssh-key-on-linux) How to Create an RSA SSH Key on Linux -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Linux uses the same toolset as MacOS (although don't tell any die hard linux fans that). You can follow basically the same instructions as above. #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux#id-1.-open-terminal) 1\. Open Terminal * Open your favorite terminal. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux#id-2.-generate-the-ssh-key) 2\. Generate the SSH Key Run the following command in your Terminal: * `-t rsa` → specifies RSA as the key type. * `-b 4096` → sets the key length to 4096 bits (more secure than the default 2048). * `-C` → adds a label (usually your email) for identification. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux#id-3.-save-the-key) 3\. Save the Key You’ll be asked where to save the key: * Press **Enter** to accept the default path (`~/.ssh/id_rsa`), or type a custom filename if you want multiple keys. * * * #### [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux#id-4.-set-a-passphrase-optional) 4\. Set a Passphrase (Optional) You can add a passphrase for extra security, or press **Enter** to leave it empty. [PreviousHow to create a SFTP/SSH Key On MacOS](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-macos) [NextHow to convert a PPK key to RSA](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-convert-a-ppk-key-to-rsa) Last updated 3 months ago Was this helpful? * [Introduction](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux#introduction) * [How to Create an RSA SSH Key on Linux](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys/how-to-create-a-sftp-ssh-key-on-linux#how-to-create-an-rsa-ssh-key-on-linux) Was this helpful? Copy ssh-keygen -t rsa -b 4096 -C "[email protected]" Copy Enter file in which to save the key (/home/yourname/.ssh/id_rsa): --- # Using SFTP with Java | Couchdrop Knowledge Base [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-java#how-to-use-sftp-with-java) How to use SFTP with Java -------------------------------------------------------------------------------------------------------------------------------------------------------- To use SFTP with Java, you can leverage the JSch library, which provides support for SSH communication in Java. Below is a basic guide on how to use JSch to interact with SFTP servers: 1. **Add JSch Dependency**: First, you need to include the JSch library in your Java project. You can do this by adding the dependency to your Maven or Gradle configuration, or by downloading the JAR file and including it in your project manually. For Maven, add the following dependency to your `pom.xml` file: Copy com.jcraft jsch 0.1.55 2. **Create SFTP Connection**: Below is an example of how to connect to an SFTP server using JSch: Copy import com.jcraft.jsch.ChannelSftp; import com.jcraft.jsch.JSch; import com.jcraft.jsch.Session; public class SFTPExample { public static void main(String[] args) { String host = "sftp.example.com"; String username = "your_username"; String password = "your_password"; int port = 22; try { JSch jsch = new JSch(); Session session = jsch.getSession(username, host, port); session.setPassword(password); session.setConfig("StrictHostKeyChecking", "no"); session.connect(); ChannelSftp sftpChannel = (ChannelSftp) session.openChannel("sftp"); sftpChannel.connect(); // Now you can perform SFTP operations using sftpChannel // Close the SFTP channel and session when done sftpChannel.disconnect(); session.disconnect(); } catch (Exception e) { e.printStackTrace(); } } } 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**: Copy sftpChannel.put("/path/to/local/file.txt", "/path/to/remote/file.txt"); * **Download a file**: Copy sftpChannel.get("/path/to/remote/file.txt", "/path/to/local/file.txt"); * **List directory contents**: Copy String files = sftpChannel.ls("/path/to/remote/directory"); 4. **Close the Connection**: After you've finished with the SFTP operations, make sure to close the SFTP channel and the SSH session: Copy sftpChannel.disconnect(); session.disconnect(); By following these steps, you can use Java with JSch to interact with SFTP servers and perform various file operations. Make sure to handle exceptions appropriately when dealing with network connections and file operations. [PreviousUsing Python with SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-python-with-sftp) [NextUsing SFTP with Bash](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-bash) Last updated 1 year ago Was this helpful? Was this helpful? --- # How to use SFTP with FileZilla | Couchdrop Knowledge Base 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. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-filezilla#using-filezilla-with-sftp) 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 ([https://filezilla-project.org/](https://filezilla-project.org/) ) and download the appropriate version for your operating system. * Follow the installation instructions to install FileZilla on your computer. 2. **Open FileZilla**: * After installation, launch FileZilla. 3. **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. 4. **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. 5. **Managing Files**: * You can create, delete, rename, and move files and directories directly from within FileZilla. 6. **Disconnecting**: * Once you're done with your file transfers, you can disconnect from the server by clicking on the "Server" menu and selecting "Disconnect". 7. **Close FileZilla**: * Finally, you can close FileZilla when you're finished with your transfers. That's it! You've successfully used FileZilla with SFTP. Remember to always secure your login credentials and use SFTP for encrypted file transfers. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-filezilla#using-filezilla-with-couchdrop) 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. [PreviousHow to use SFTP with Cyberduck](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-cyberduck) [NextUsing SFTP with Golang](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-golang) Last updated 1 year ago Was this helpful? * [Using FileZilla with SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-filezilla#using-filezilla-with-sftp) * [Using FileZilla with Couchdrop](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-filezilla#using-filezilla-with-couchdrop) Was this helpful? --- # Using SCP | Couchdrop Knowledge Base [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-scp#what-is-scp) What is SCP? ------------------------------------------------------------------------------------------------------------------ SCP (Secure Copy Protocol) and SFTP (SSH File Transfer Protocol) are two distinct protocols used for file transfer over SSH. SCP is specifically designed for copying files between hosts on a network, SFTP provides a more feature-rich file transfer capability, including file manipulation, directory listing, and more. If you want to use SCP with an SFTP server, you need to ensure that the server supports both protocols. However, if the server only supports SFTP, you won't be able to use SCP directly with it. Couchdrop supports both SFTP and SCP. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-scp#how-to-use-scp) How to use SCP ----------------------------------------------------------------------------------------------------------------------- Here's how you can use SCP with an SFTP server if the server supports both protocols: 1. **Check Server Support**: First, confirm that the SFTP server you are connecting to supports SCP. Some SFTP servers might have SCP support disabled or not implemented. 2. **Connect with SCP**: If the server supports SCP, you can use the `scp` command just like you would with any other SCP-enabled server. Here's the basic syntax: Copy scp source_file username@hostname:/path/to/destination Replace `source_file` with the path to the file you want to transfer, `username` with your username on the server, `hostname` with the hostname or IP address of the server, and `/path/to/destination` with the destination directory on the server. For example: Copy scp myfile.txt [email protected]:/home/user/ 3. **Authentication**: SCP uses SSH for authentication, so you might be prompted to enter your password or provide a private key passphrase if you're using key-based authentication. 4. **Transferring Files**: Once authenticated, SCP will securely transfer the specified file to the destination directory on the server. 5. **Close Connection**: After the transfer is complete, SCP will close the connection, and you'll return to your local shell prompt. If the SFTP server does not support SCP, you'll need to use SFTP commands or a dedicated SFTP client to transfer files. Most SFTP servers support a wide range of client applications, making it easy to find one that suits your needs. [PreviousUsing SFTP with Bash](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-bash) [NextUsing SFTP/SSH Keys](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-ssh-keys) Last updated 1 year ago Was this helpful? * [What is SCP?](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-scp#what-is-scp) * [How to use SCP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-scp#how-to-use-scp) Was this helpful? --- # Using SFTP with Bash | Couchdrop Knowledge Base You can use the `sftp` command-line utility directly in a Bash script to perform SFTP operations. Here's a basic guide on how to use SFTP with Bash: 1. **Connecting to an SFTP Server**: You can use the `sftp` command to establish a connection to an SFTP server. Below is an example of how to connect to an SFTP server: Copy #!/bin/bash HOST="sftp.example.com" USERNAME="your_username" PASSWORD="your_password" PORT=22 sftppass -p "$PASSWORD" sftp -oPort=$PORT $USERNAME@$HOST Replace `"sftp.example.com"` with the hostname or IP address of your SFTP server, `"your_username"` with your username, and `"your_password"` with your password. You can also adjust the port number if your SFTP server uses a different port. 2. **Performing SFTP Operations**: Once connected, you can execute SFTP commands interactively or within the script to perform various operations such as uploading files, downloading files, listing directory contents, creating directories, etc. For example: * **Uploading a file**: Copy put /path/to/local/file.txt /path/to/remote/file.txt * **Downloading a file**: Copy get /path/to/remote/file.txt /path/to/local/file.txt * **Listing directory contents**: Copy ls /path/to/remote/directory * **Creating a directory**: Copy mkdir /path/to/remote/new_directory 3. **Exiting SFTP**: Once you've finished with your SFTP operations, you can exit the SFTP session by typing `exit` or by sending an EOF (End-of-File) signal (usually by pressing `Ctrl+D`). 4. **Using Password in Bash Script**: Storing passwords directly in Bash scripts is not recommended for security reasons. However, if you need to automate SFTP operations in a script, you can use tools like `sshpass` to provide the password securely. Make sure to install `sshpass` first (e.g., `sudo apt-get install sshpass` on Debian-based systems). Here's an example of how to use `sshpass` in a Bash script: Copy #!/bin/bash HOST="sftp.example.com" USERNAME="your_username" PASSWORD="your_password" PORT=22 sshpass -p "$PASSWORD" sftp -oPort=$PORT $USERNAME@$HOST < "Open Connection". 4. **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. * 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". 5. **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. 6. **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. 7. **Managing Files**: * Cyberduck allows you to perform various file operations such as creating directories, renaming files, deleting files, and changing file permissions. 8. **Disconnecting**: * When you're finished with your file transfers, click the "Disconnect" button in the Cyberduck toolbar or go to "File" > "Disconnect". 9. **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. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-cyberduck#using-cyberduck-with-couchdrop) 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. [PreviousOpenSSH SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/openssh-sftp) [NextHow to use SFTP with FileZilla](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-filezilla) Last updated 1 year ago Was this helpful? * [Using Cyberduck with SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-cyberduck#using-cyberduck-with-sftp) * [Using Cyberduck with Couchdrop](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-cyberduck#using-cyberduck-with-couchdrop) Was this helpful? --- # Using SFTP with Golang | Couchdrop Knowledge Base Uploading and downloading files programatically with Golang is a great way to automate transfers or build out support for SFTP inside you application. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-golang#how-to-use-sftp-with-golang) 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`: Copy go get golang.org/x/crypto/ssh go get github.com/pkg/sftp 2. **Create an SSH Client and Connect to the Server**: Below is an example of how to connect to an SFTP server using Go: Copy 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 } 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**: Copy 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 } * **Download a file**: Copy 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 } 4. **Close the Connection**: After you've finished with the SFTP operations, make sure to close the SFTP session and the SSH connection: Copy // Close SFTP session sftpClient.Close() // Close SSH connection conn.Close() 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. [](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-golang#using-golang-and-sftp-with-couchdrop) 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 [couchdrop-api](https://developers.couchdrop.io/) [PreviousHow to use SFTP with FileZilla](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/how-to-use-sftp-with-filezilla) [NextUsing Python with SFTP](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-python-with-sftp) Last updated 1 year ago Was this helpful? * [How to use SFTP with Golang](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-golang#how-to-use-sftp-with-golang) * [Using Golang and SFTP with Couchdrop](https://docs.couchdrop.io/walkthroughs/sftp-recipes/using-sftp-clients/using-sftp-with-golang#using-golang-and-sftp-with-couchdrop) Was this helpful? --- # Email Protection | Cloudflare Please enable cookies. Email Protection ================ You are unable to access this email address docs.couchdrop.io ------------------------------------------------------------- The website from which you got to this page is protected by Cloudflare. Email addresses on that page have been hidden in order to keep them from being accessed by malicious bots. **You must enable Javascript in your browser in order to decode the e-mail address**. If you have a website and are interested in protecting it in a similar way, you can [sign up for Cloudflare](https://www.cloudflare.com/sign-up?utm_source=email_protection) . * [How does Cloudflare protect email addresses on website from spammers?](https://developers.cloudflare.com/waf/tools/scrape-shield/email-address-obfuscation/) * [Can I sign up for Cloudflare?](https://developers.cloudflare.com/fundamentals/setup/account/create-account/) Cloudflare Ray ID: **9b9fa1634fb19c1f** • Your IP: Click to reveal 54.237.218.47 • Performance & security by [Cloudflare](https://www.cloudflare.com/5xx-error-landing) ---