File server setup: FTP, SFTP, S3, Google Cloud Storage, Azure Files and MEGA

This article covers the provider-specific details for connecting a credential-based storage backend to Kompass. It assumes you have read the File server integration article, which explains the overall setup: the configuration wizard, directory categories, the identifier template, and permissions.

Unlike the cloud providers (Google Drive, OneDrive, Dropbox, ShareFile), these backends do not use OAuth. You enter credentials directly in the wizard. Passwords and keys are obscured before storage and shown as redacted in the administration area afterwards.

Untested providers. As noted in the main article, these backends are implemented and selectable but have not yet been verified end to end. Please involve Kompass Staff before relying on one of them in production.

FTP

Enter the host address, username, password, and port (default 21). You also choose a TLS mode:

  • None – plain FTP without encryption.
  • Implicit TLS – the connection is encrypted from the start (typically port 990).
  • Explicit TLS – the connection starts plain and is upgraded to TLS (FTPS). This is the most common secure setup.

Choose the mode your server requires. If you are unsure, ask whoever runs the FTP server.

SFTP

Enter the host address, username, password, and port (default 22). Only password authentication is supported at the moment. SSH key authentication is not available, so the account you use must allow password login.

Amazon S3

Enter an Access Key ID and Secret Access Key. Region, endpoint, and provider are optional.

  • Create a dedicated IAM user with read-only access to the buckets you want to expose, and use that user's access keys. Kompass only reads, so there is no reason to grant write permissions.
  • S3-compatible storage from other vendors can be used by filling in the endpoint and provider fields.
  • There is no bucket selection during setup. Instead, include the bucket name as the first segment of each path in the Categories configuration, for example my-bucket/Projects/.

Google Cloud Storage

Authentication uses a service account. In the Google Cloud console, create a service account with read access to the buckets (the Storage Object Viewer role is sufficient), create a JSON key for it, and paste the full JSON into the wizard. Project number and location are optional.

As with S3, there is no bucket selection during setup: include the bucket name as the first segment of each path in the Categories configuration, for example my-bucket/Projects/.

Azure Files

Enter the storage account name and an account key (found under Access keys on the storage account in the Azure portal). The share name and endpoint are optional.

  • If you fill in the share name, paths in the Categories configuration are relative to that share.
  • If you leave the share name empty, include it as the first segment of each path instead, for example my-share/Projects/.

MEGA

Enter the email address and password of the MEGA account. No other settings are needed.

After entering credentials

Once the wizard completes, continue with the steps from the main article: run Test connection to see the top-level folders, then configure the Categories field and the identifier template so Kompass can match folders to projects.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us