For the complete documentation index, see llms.txt. This page is also available as Markdown.

Root Directory

Learn how root directories control what a user can see and access in Couchdrop.

Overview

The root directory is a key access control in Couchdrop. It determines the highest-level folder a user can see and access.

How root directories work

Every Couchdrop user is assigned a root directory.

The root directory can point to Couchdrop-hosted storage or any folder within connected storage, such as SharePoint, Amazon S3, Google Drive, or an external SFTP server.

Root isolation

Root isolation prevents a user from accessing any location above their assigned root directory.

For example, if a user's root directory is:

/SharePoint/Customers/Acme

The user sees that location as:

/

They cannot navigate above their root directory or access locations such as:

/SharePoint
/SharePoint/Customers
/SharePoint/Customers/Other-Customer

The underlying storage path is also hidden from the user. They do not need to know that their files are stored in SharePoint.

When creating an SFTP user, the root directory is configured using the Home Directory setting.

Root directories let you expose a specific folder without exposing the rest of your connected storage. Multiple users can also be assigned to the same root directory.

Folder permissions

Root directories can be combined with filesystem permissions to further control what a user can do within their assigned location. Couchdrop supports global filesystem permissions including Read only and Write only.

Read only

Users can view and download files, but cannot upload, modify, or delete them.

Write only

Users can upload files, but cannot view existing files or folders.

Write-only access is useful for file collection workflows where a sender should be able to submit files without seeing files uploaded by other users.

Why root directories matter

Root directories let you give users access to only the files and folders they require while keeping the rest of your storage structure hidden.

This provides several important protections:

  • Users cannot navigate above their assigned root

  • Users only see paths relative to their root

  • The true storage location is hidden

  • Multiple users can share the same root directory

  • Additional folder permissions can be applied

Root directories are particularly useful when providing different customers, partners, applications, or teams with access to separate locations in the same connected storage.

Last updated

Was this helpful?