Skip to content
English
Schedule Meeting
  • There are no suggestions because the search field is empty.

SFTP Setup

SFTP (Secure File Transfer Protocol) access is provided for clients with specific use cases. In order to establish a SFTP connection, please follow the instructions below to get up and running.

  1. Generate an SSH key pair using RSA on the machine that intends to send files to Breadboard. This can be done in a number of ways, but you can follow these steps for any linux based machine:

⚠️ NOTE: Windows PuTTY users should select RSA when generating a key

Untitled (6)

  1. In any terminal application, run ssh-keygen -t rsa. When prompted to store the key on your local host, we recommend renaming this key as breadboard-sftp
  2. supply any additional password for this key based on your needs, and when complete you should have generated two files breadboard-sftp (the private key), and breadboard-sftp.pub (the public key)
  3. Email the public key to engineering@breadboard.com paying careful attention to send over the file contents exactly as they are. We recommend running a command such as cat ./breadboard-ftp.pub | xsel which will print the file’s contents and copy them to your clipboard. You can then paste this in the email body.

⚠️ NOTE: Breadboard will never ask for your private key and you should not send it to anyone. You are solely responsible for this file. If it is compromised at any time, email engineering@breadboard.com so we can disable it.

  1. Once you send over your public key in step (2), Breadboard will contact you back with a user name and authorized endpoint to send your files. We will also send over requirements for the files being uploaded to ensure the data ingestion pipeline succeeds.
  2. Now that you have your user name and authorized endpoint for SFTP, decide on the method you want to send files, and frequency. For simplicity in this example, we recommend installing FileZilla, a popular SFTP client
    1. . open FileZilla and click on the top right icon to establish a connection

Untitled (7)

ii. In the configuration, enter information for the following items

Protocol: SFTP

Host: sftp.breadboard.com

Login Type: Key File

User: user name provided to you by Breadboard

Key File: location where your SSH Private key is located. FileZilla may ask to reformat the key for you, in which case you can agree to that process

Untitled (8)

iii. Once you select “connect”, you may see a warning asking about whether or not you should trust who you are connecting to and that FileZilla cannot guarantee safety. This is a standard practice when establishing a connection for the first time. After confirming the host name correctly, you can agree to this dialogue and you should be able to connect from there.

Untitled (9)