Skip to main content

What is an SFTP Connection?

When you place large files that are hard to upload through the browser on an SFTP server, OneSight reads them directly at query time. Files are not copied or stored, so replacing the original takes effect starting with the next query. The connection is encrypted over SSH. Plain FTP, which is not encrypted, is not supported.
Only users with Admin privileges can register a data source. Issuing the server account (Step 1) must be handled by the person who manages that server.

What You’ll Need

  • The server’s address and port (default 22)
  • A read-only account and that account’s password or SSH private key
  • The path to the files you want to read

Step 1: Prepare a Read-Only Account (Server)

OneSight only performs listing and reading of files. It does not upload or delete files, so use an account without write permissions.
1

Create a Dedicated Account

Create a separate account used only for the OneSight connection. Keeping it from being shared with other purposes makes it easier to revoke access later.
2

Grant Access to Only the Required Path

Grant read permission only to the directory containing the data files. If possible, we recommend restricting the account (e.g., with chroot) so it cannot leave that directory.
3

Choose an Authentication Method

Use either a password or an SSH private key. For security, an SSH private key is recommended.
If you use an SSH private key, it must be a key without a passphrase. Keys with a passphrase will fail to connect, and the cause isn’t shown — it just appears as an authentication failure.

Step 2: Connect to OneSight

1

Select Storage

Choose Data Sources → Add → Storage → SFTP.
2

Enter Connection Details and Connect

Enter the items below and verify the connection.The password and private key you enter are encrypted with AES-256-GCM before being stored at registration, and are never shown on screen again.
3

Select a File

Click a folder to navigate, then select the file to use. For SQLite (.db) files, next choose the table to query.
4

Review and Register

Check the data in the preview, review the automatically suggested mapping, then give it a name and register it.

If the Connection Fails

The server must be an address reachable from outside. Addresses that are only reachable within an internal network or VPN are blocked by security policy. In this case, work with the person who manages the server to set up an external access path.
If the server is configured to allow only certain IPs, you’ll need to add OneSight’s server address to the allowlist. Please request the IP to allow through Contact Us.
Check whether the key has a passphrase set. Keys with a passphrase are not supported. Also, be sure to paste the entire file contents of the private key, including the header and footer lines.

Supported File Types and Size Limits

Excel, JSON, and SQLite have size limits because their formats require the entire file to be downloaded before it can be opened. A notice is shown at the registration step if the limit is exceeded.

Next Steps

Amazon S3 Connection

Connect S3 and S3-compatible storage

Contact Us

Contact us if you can’t get connected