Connecting to your Onyx Database via Remote SQL using tools such as MySQL Workbench
This is a brief guide to connecting to MySQL on Onyx using an SSH Tunnel within the MySQL WorkBench tool provided by the MySQL website - external link opens in a new window. Other remote MySQL software may look slightly different, but the general information required will be the same.
Create a new connection within MySQL WorkBench (or your database access tool of choice) using the following details:
Connection Name: Enter a name to identify this connection.
Connection Method: Select Standard TCP/IP over SSH.
SSH Hostname: sites01.sites.onyx.io:12345 (where 12345 is the SSH port shown in the Access Details section of the Onyx Portal - click 'Enable SFTP/SSH Access' if this isn't shown)
SSH Username: webuser
SSH Password: Click the Store in Keychain (Mac) or Store in Vault (PC) button and enter your password from the Access Details section of the Onyx Portal (whilst you're there, ensure SSH/SFTP access is enabled, you'll need it in a minute).
Username: Enter the MySQL username here.
Password: Click the Store in Keychain (Mac) or Store in Vault (PC) button and enter your MySQL user's password.
MySQL Hostname/Username/Password: You can get this from the Databases section of the Onyx Portal - click on Details and use the information there (the hostname is simply the IP address of the Onyx database server)
MySQL Server Port: 3306
Click Test Connection to confirm the settings are correct. You may see a certificate warning that you'll need to accept.
Click OK to save the connection.
You can now simply click the connection in the MySQL WorkBench dashboard to open the SSH tunnel and connect to the Onyx database.