SFTP Option for Uploading Customer Backups

Published Date: July 9, 2024

Audience: Internal

Products and Versions Covered:  

• Self-hosted to Cloud
• Self-hosted to Customer-Validated Cloud

Summary

We offer an SFTP option for uploading your backups. Please follow the instructions below and send us the necessary information so we can upload the backups. Feel free to reach out if you have any questions.

Resolution

Generate SSH key pairs

1. Mac/Linux/Unix

   • Creating SSH Keys on Mac/Linux/Unix using ssh-keygen
     In a command terminal: ssh-keygen -t rsa -b 4096 -f <key_name>
   • For example: 

   • ssh-keygen -t rsa -b 4096 -f sftp-key Generating public/private rsa key pair. Enter passphrase (empty for no passphrase): Enter same passphrase again: Your identification has been saved in sftp-key Your public key has been saved in sftp-key.pub The key fingerprint is: SHA256:F/gMdr//mVCz3ZTFWzAXBJDch6Gu2HqQ4N3kCdVrgUY jhansen@C02G320JMD6R The key's randomart image is: +---[RSA 4096]----+ | .E+.+oBoo| | = =.o * | | * o.o . +| | . o *.= =| | . o S *.. =.| | . +o=. ...=| | ..o .. .o| | .. .. o| | .. .+.| +----[SHA256]-----+

   • In the example above, the public SSH key file name is sftp-key.pub

2. Windows

   • Creating SSH Keys on Windows using PuTTYgen
     • Download and install PuTTY
     • Go to Windows Start menu → All Programs → PuTTY → PuTTYgen
     • Select "RSA" as the Type of key to generate with 2048 bit key size (4096 would also work)
     • Click "Generate" and start moving the mouse cursor within the PuTTY window. Continue to move the mouse until the progress bar is full.
     • Then click "Save public key" and "Save Private key."
     • Copy/Paste the Public key and provide it to Jama Support

Note: We require SSH keys in PEM format. PEM formatted public keys have the following format
ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAA...

Determine the IP address you will connect from

You will need to provide the public-facing IP address from which you will be connecting.
For example:

• What Is My IP?
• IP Chicken - What is my IP address? Free public IP lookup.

Connecting to the SFTP Server

SFTP Server details

SFTP Client info

Customers may need to consult the documentation for their specific client for additional usage details and troubleshooting. We’ve included some examples below from Common SFTP Clients.

• OpenSSH Command line (Linux, Mac, Windows)
  • sftp -i <key_name> <user_name>@<sftp_hostname>
  • For example, sftp -i sftp-key jason@sftp-us.jamacloud.com
  • To upload a file, use the put command. For example, put hello.txt
• Filezilla (Windows, Mac, Linux)
  • Open the FileZilla client.
  • Choose File, and then choose Site Manager.
  • In the Site Manager dialog box, choose New Site.
  • On the General tab, for Protocol, choose SFTP.
  • Enter the protocol you are using for Hostname, followed by the SFTP server hostname.
    • For example, sftp://sftp-us.jamacloud.com
  • For “Port number,” enter 22
  • For “Login Type,” choose “Key file.”
  • For “Key file,” browse/select your SSH Private Key
  • For “User,” enter the SFTP account username
  • Click “Connect.”
  • Perform file transfer
• CyberDuck (Windows, Mac)
  • Open the Cyberduck client
  • Choose Open Connection, select “SFTP” as the Protocol
  • For “Server,” use the SFTP Hostname from the table above
  • For “Port number,” enter 22
  • For “Username,” enter the user name of the SFTP account
  • For “SSH Private Key,” choose or enter the SSH private key
  • Click “Connect.”
  • Perform file transfer
• WinSCP (Windows)
  • In the “Login” box, select “SFTP” for File Protocol
  • For “Hostname,” use the SFTP Hostname from the table above
  • For “Port” enter 22
  • For “User name,” enter the user name of the SFTP account
  • Choose “Advanced” to open the “Advanced Site Settings” dialog box. In the SSH section, choose “Authentication.”
  • For “Private Key,” browse and choose the SSH private key
  • Click “OK”, then “Save.”
  • Please see the AWS doc for additional config details or the WinSCP Documentation
  • Perform file transfer

Feedback:
We welcome your input! Please sign in to leave any comments, suggestions, or improvement ideas below.