> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://krystal-dev.crisp.help/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Connecting to your Onyx Database via MySQL WorkBench

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](https://dev.mysql.com/downloads/workbench/).

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.

![](https://storage.crisp.chat/users/helpdesk/website/6ee304cf166c5000/1e6041ff-8aac-46ba-8f9b-9e95ad_ryb7hf.png)

We have an easy to read guide that covers this process step by step [Here (Link opens in a new tab)](http://onyx.help/getting-started/connecting-to-your-site-using-sftp).

#### **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**.

![](https://storage.crisp.chat/users/helpdesk/website/b47ac7ab2b33b800/472fd6ca-7620-4575-b194-037395_hxjixy.png)

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)_

![](https://storage.crisp.chat/users/helpdesk/website/f4cdb2cb1221b800/7219af0f-8bf0-408c-b322-d5ffba_m1drgx.png)

| Not sure where to find your SSH port? Click Here! (Link opens in new tab)

1.  **SSH Username**: webuser

![](https://storage.crisp.chat/users/helpdesk/website/dd84ee5b9d01680/8d22cc64-cac7-48c4-8cac-8638a3_13r2jp4.png)

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

![](https://storage.crisp.chat/users/helpdesk/website/c9a650b282b65800/b1cd0674-dd7e-4cef-b5f2-03e130_1538sgj.png)

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

![](https://storage.crisp.chat/users/helpdesk/website/8845cf3181825800/3f18fc26-beeb-4a6b-b622-e12faf_fdqu8a.png)

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

![](https://storage.crisp.chat/users/helpdesk/website/d17aaba4b5aeb800/0ba2a2e7-dbc0-4584-b032-b5cdcf_11sohpp.gif)

| 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.

![](https://files.helpdocs.io/iveabsei6n/articles/iwab64hdup/1665405731588/connecting-onyx-database-via-my-sql-work-bench-image-7.png)

1.  **MySQL Server Port**: 3306

![](https://files.helpdocs.io/iveabsei6n/articles/iwab64hdup/1665405755312/connecting-onyx-database-via-my-sql-work-bench-image-8.png)

1.  **Username**: Enter the **MySQL username** shown in your Onyx Dashboard > Databases here.

![](https://files.helpdocs.io/iveabsei6n/articles/iwab64hdup/1665405808045/connecting-onyx-database-via-my-sql-work-bench-image-9.png)

1.  **Password**: Click the **Store in Keychain** (Mac) or **Store in Vault** (PC) button.

![](https://files.helpdocs.io/iveabsei6n/articles/iwab64hdup/1665405916832/connecting-onyx-database-via-my-sql-work-bench-image-10.png)

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

![](https://files.helpdocs.io/iveabsei6n/articles/iwab64hdup/1665405927938/connecting-onyx-database-via-my-sql-work-bench-image-11.png)

1.  Click **OK** to test the connection

![](https://files.helpdocs.io/iveabsei6n/articles/iwab64hdup/1665406137081/connecting-onyx-database-via-my-sql-work-bench-image-12.png)

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

![](https://files.helpdocs.io/iveabsei6n/articles/iwab64hdup/1665406151106/connecting-onyx-database-via-my-sql-work-bench-image-13.png)

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.

* * *

* * *