Connect through SSH
Sigma supports connecting through Secure Shell (SSH) for PostgreSQL, Redshift, AlloyDB, and MySQL connections.
The SSH protocol is a secure remote shell protocol, where clients and servers communicate on a secure channel. It has three layers:
| Transport layer | Secures communication between the server and the client, monitors data encryption and decryption, protects the integrity of the connection, caches data, and performs data compression. |
| Authentication layer | Performs client authentication at the beginning of each session. |
| Connection layer | Manages communication channels after successful authentication. |
SSH channels use public key cryptography to authenticate the client. After establishing the connection, SSH encrypts information to safely exchange it between the server and the client. This provides the data security that is independent of the particular network infrastructure.
Requirements
-
Admin privileges in your Sigma organization; see account types.
-
A PostgreSQL, Redshift, AlloyDB or MySQL database.
SSH server parameters
To enable SSH connections, send the following Sigma information to your system admin.
| Public key | Download |
| User | sigmacomputing |
| Sigma IP addresses | Sigma's egress IP addresses are listed on all individual connection pages in the Sigma Administration portal. |
Get Sigma IPs
Follow these steps to get Sigma IPs from the app:
-
Open your Admin Portal to the Connection page.
-
Select any connection, or click Create Connection.
-
Look for the IP addresses under connection credentials.
Connect to Sigma through SSH
-
Download or save Sigma’s SSH public key.
-
Add Sigma IPs to your allowlist.
-
Create an SSH user account, and name it sigmacomputing.
The user sigmacomputing authenticates through the public key.
-
Authorize Sigma's public key according to the instructions of your SSH server.
-
For most servers, the SSH default port is 22. It is also the default port on Sigma.
Check that the port on your SSH server matches the port on Sigma.
-
In Sigma, navigate to your connection’s page in the Admin Portal.
-
Under Connection Credentials, switch on the SSH Tunnel.
Set these parameters:
Tunnel host This is your IP address. Tunnel port This value must match the port of your SSH server.
Sigma's defaults to port 22, which is common for most servers.
-
-
If you are editing an existing connection, click Save.
If you are creating a new connection, continue specifying the Connection features, Write access, and so on.
Updated 7 months ago