Terminus can create and share an AWS S3 bucket to you via an SFTP connection. This method allows a team to directly upload the required files to a Terminus S3 bucket utilizing an FTP client supported by AWS.
- AWS Supports the following FTP Clients. You will need access to at least one of them. Please choose an option which works best with your OS of your computer:
- OpenSSH (Macintosh and Linux). Comes default installed on Mac
- WinSCP (Microsoft Windows only) Download here: https://winscp.net/eng/index.php
- Cyberduck (Windows, Macintosh, and Linux) Download here: https://cyberduck.io/
- FileZilla (Windows, Macintosh, and Linux) Download here: https://filezilla-project.org/
- Public SSH Key that will be used to securely transfer the data. If you have an existing key pair, please send the public key to the Technical Consultant. If you do not have an existing key pair, you can generate a pair by following the “Generate SSH Key Pair” section below.
- Access to the .CSV file to be shared with Terminus
Generate SSH Key Pair
1. The Terminal app is in the Utilities folder in Applications. To open it, either open your Applications folder, then open Utilities and double-click on Terminal, or press Command - spacebar to launch Spotlight and type "Terminal," then double-click the search result.
2. You can use the ‘ssh-keygen’ command at the Terminal command line interface to generate a new key pair. The following is an example of the ssh-keygen output for the command `ssh-keygen -P "" -f my_new_key`, which you can type directly into the Terminal window, and run by hitting the “return” button on your keyboard. Note: You can add a passphrase to the private key file by entering a selected passphrase between the quotes or change the resulting key name by altering the file name after the ‘-f’ command. These are optional and not required. For example: `ssh-keygen -P “example-passphrase” -f custom_key_name`
3. The above command will generate two files in the working directory of your laptop. You can open it in a finder window by typing “open .” and hitting enter.
4. Please save both of these files in a safe place on your computer, as they will grant you access to the SFTP server created by your Technical Consultant. Please email the `.pub` (stands for public key) file to your Technical Consultant so they can add the credential to the SFTP server that is generated.
1. Windows uses a slightly different SSH key pair format. The public key must be in the PUB format, and the private key must be in the PPK format. On Windows, you can use PuTTYgen to create an SSH key pair in the appropriate formats. To generate a key pair, you will need to download PuTTY at https://www.ssh.com/ssh/putty/windows/install
2. After downloading PuTTY, go to Windows Start menu → All Programs → PuTTY→ PuTTYgen.
3. To create a new key pair, select the type of key to generate from the bottom of the screen. Please select SSH-2 RSA with 2048 bit key size.
4. Then click Generate, and start moving the mouse within the Window. Putty uses mouse movements to collect randomness.
5. You can now specify a passphrase for the key. This is optional and not required.
6. You should save the private key by clicking “Save private key”. This will let you choose where to store your private key. Please save this file in a safe place on your computer, as it will grant you access to the SFTP server created by your Technical Consultant.
7. It may be advisable to also save the public key, though it can be later regenerated by loading the private key (by clicking Load).
8. The public key which will need to be sent to your Technical Consultant is viewable in the highlighted box. You can copy-paste this in an email or attach it in an email as a saved ‘.pub’ file.
How to Upload
1. All the SFTP Methods listed are outlined here by Amazon. In this example, we will show how FileZilla is leveraged.
2. Open up the FileZilla application and navigate to the Site Manager (Command + S) or (File -> Site Manager).
3. A new window should open up and give you the option to add a connection with the “New Site” button. Fill in the details for the site like the example below. The Protocol should be equal to “SFTP”, Port equal to “22”, and Logon Type as “Key File”. The Host and User will be provided to you by your Technical Consultant. Lastly, the key file will be the SSH key file that you generated in the “Generate SSH Key Pair” instructions. By clicking “Browse…” you can lookup this file in your computer’s system.
4. Once all the details are filled out, you can click the “Connect” button at the bottom of the window.
5. You should see a successful connection message at the top of your screen in the “Status” section of the FileZilla application. Once you are successfully connected, you can drag and drop the correct files from your local computer to the S3 bucket that you’ve successfully connected to. At this point, Terminus will take the data files and import them into the Hub platform.