Skip to main content
tiCrypt

External SFTP Servers

AdministratorRequires: Super-admin role

An external SFTP server is an SFTP server outside tiCrypt that a Super-admin registers so that specific users and teams can push files from their Vault to it. Users reach it through SFTP bidirectional, under My Computer in the Vault. An entry holds the server's name, host, port, an optional expiration date and an allowlist of users and teams. It holds no credentials: each user signs in with their own account on the server.

An external SFTP server is not an SFTP inbox endpoint. The SFTP inbox endpoint in System Settings is tiCrypt's own SFTP service, which receives files from people without a tiCrypt account. An external SFTP server belongs to someone else and is a destination for data leaving tiCrypt.

Why external SFTP servers are allowlisted​

SFTP bidirectional is the one kind of SFTP connection that can send Vault files to a server outside tiCrypt, where they arrive decrypted. Users cannot type an address for it. They choose from the servers registered here, and each time a user connects, tiCrypt Connect asks the backend to confirm that the user, or one of their teams, is on that server's allowlist. The backend refuses the connection otherwise and logs every check. The push itself runs as a download through tiCrypt Connect, so project download rules and download records apply as they do for any download.

Treat each entry as an export authorization rather than a connection setting, and register only destinations your institution has approved to receive the data in question.

SFTP inbound needs no entry here. It only brings data into the Vault, so users can connect it to any server their computer can reach. See SFTP Connections.

What an entry controls​

The following table describes the fields of an external SFTP server.

FieldEffect
NameThe label users see in the Select SFTP server list. Up to 80 characters, none of / \ | " : * ? < > { }, and different from the name of every other entry.
Hostname or IPThe address tiCrypt Connect dials, up to 256 characters. It must be an IPv4 address or a domain name with at least one dot; localhost and IPv6 addresses are rejected with "Must be a valid domain name or IP address". The allowlist check matches this host and the port exactly, and two entries cannot share the same host and port.
PortThe SSH port of the server, from 1 to 65535. The default is 22.
Expiration (optional)After this date the server no longer appears in users' Select SFTP server list. Leave it empty for a server with no end date.
AllowlistThe teams and users who can connect, chosen with a team picker and a user picker. If the allowlist is left empty, nobody in the system can access the server.

If another entry already uses the same host and port, the pop-up shows a red notice, "An SFTP server "<name>" already exists with hostname "<host>" and port <port>", and the save button stays disabled.

The following table describes the columns of the External SFTP Servers table.

ColumnDescription
NameThe name of the entry.
HostnameThe host name or IP address.
PortThe SSH port.
ExpirationThe expiration date, if the entry has one.
note

Admins and Super-admins see every registered server in the Select SFTP server list, but they can connect only to servers whose allowlist includes them or one of their teams.

Create a New SFTP Server​

Location: Management > Miscellaneous > External SFTP Servers

  1. Click the Create SFTP Server button in the top right panel.
  2. In the Create SFTP Server pop-up, enter the server name, host name or IP address, port, and optional expiration date.
  3. Under Allowlist, select the teams and users who can connect to the server.
  4. Click Create.
Result:

The server appears in the External SFTP Servers table. The users and team members on its allowlist can now select it under Connect to SFTP server > SFTP bidirectional.

Edit an SFTP Server​

Location: Management > Miscellaneous > External SFTP Servers

  1. Select the SFTP server you want to edit.
  2. Click the Edit button in the top right panel.
  3. In the Update <name> pop-up, edit the server name, host name or IP address, port, and optional expiration date.
  4. Update the teams and users on the Allowlist.
  5. Click Update.
Result:

The change applies to the next connection. A user removed from the allowlist is refused the next time they connect.

View an SFTP Server​

Location: Management > Miscellaneous > External SFTP Servers

  1. Select the SFTP server you want to view.
  2. Click the View button in the top right panel.
  3. In the detail panel, review the cards described in the table below.

The following table describes the cards of the SFTP server detail panel.

CardDescription
Basic infoName, Host, Expiration ("Never" when there is none), Created on, Last modified on and the ID.
Allowed usersThe users on the allowlist, or "No users".
Allowed teamsThe teams on the allowlist, or "No teams".
Allowed projectsProjects whose members can also connect, or "No projects". Projects cannot be added from the Create SFTP Server or Update pop-up.
Result: The detail panel shows who can connect to the server and until when.

Refresh SFTP Server(s)​

bulk-action

Location: Management > Miscellaneous > External SFTP Servers

  1. Click the Refresh button in the top right panel.

Export SFTP Server(s) in CSV Format​

bulk-action

Location: Management > Miscellaneous > External SFTP Servers

  1. Select the SFTP server(s) you want to export.
  2. Click the Export CSV button in the top right panel.
  3. Select the Selected items option.
  4. In the local window, select the export location.
  5. Click Save.

Export SFTP Server(s) in JSON Format​

bulk-action

Location: Management > Miscellaneous > External SFTP Servers

  1. Select the SFTP server(s) you want to export.
  2. Click the Export JSON button in the top right panel.
  3. Select Export selected items.
  4. In the local window, select the export location.
  5. Click Save.

Delete Existing SFTP Server(s)​

bulk-action

Location: Management > Miscellaneous > External SFTP Servers

  1. Select the SFTP server(s) you want to delete.
  2. Click the Delete button in the top right panel.
  3. In the confirmation prompt, click Yes. Click No to keep the servers.
Result:

The server disappears from users' Select SFTP server list, and new SFTP bidirectional connections to it are refused. Files already pushed to the server stay there.