All Categories > ​Onyx Documentation ​ > ​ ​Getting Started with Onyx > Connecting to your Onyx Database via MySQL WorkBench

Connecting to your Onyx Database via MySQL WorkBench

Updated 1 year ago by Tristan Payne

This is a brief guide covering connecting to MySQL on Onyx. For this guide we will be 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.

Prerequisites

Before you attempt to connect to your sites database, you will first need to ensure that you have enabled SSH/SFTP via your access details within the Onyx portal.

We have an easy to read guide that covers this process step by step Here (Link opens in a new tab).

Connecting using MySQL WorkBench

Once you have installed and opened MySQL WorkBench (or your database access tool of choice), Create a new connection using the following details:

  1. Connection Name: Enter a name to identify this connection.
  2. Connection Method: Select Standard TCP/IP over SSH.

  1. SSH Hostname & Port: Use sites01.sites.onyx.io:PORTHERE

(In this case We will be using 30954 however you should use the SSH port shown in the Access Details section of the Onyx Portal)

Not sure where to find your SSH port? Click Here! (Link opens in new tab)
  1. SSH Username: webuser

  1. SSH Password: Click the Store in Keychain (MacOS) or Store in Vault (PC) button.

  1. Enter your password from the Access Details section of the Onyx Portal.

  1. Within your Onyx Portal, Navigate to Databases and select the Database you would like to connect to:

You can click the GIF above to enlarge it!
  1. MySQL Hostname: This is simply the IP of the Onyx Database server and can be found within your Onyx Dashboard > Databases.
  1. MySQL Server Port: 3306

  1. Username: Enter the MySQL username shown in your Onyx Dashboard > Databases here.
  1. Password: Click the Store in Keychain (Mac) or Store in Vault (PC) button.

  1. Enter your password as shown in your Onyx Dashboard > Databases

  1. Click OK to test the connection

  1. You may see the following certificate warning that you will have to accept before the connection can be established:

  1. Click OK to save the connection.
  2. Done! You can now simply click the connection in the MySQL WorkBench dashboard to open the SSH tunnel and connect to the Onyx database.

How did we do?

Powered by HelpDocs (opens in a new tab)
© Krystal Hosting Ltd 2002–