SSH tunneling to access your site’s database

While it isn’t common, there may be times you need to access your Flywheel site’s database using an external tool instead of the Database manager in your Flywheel dashboard. Thanks to our SSH gateway and a nifty feature called SSH tunneling, you can do just that.

SSH tunneling allows you to set up a secure connection to transmit data via an encrypted SSH connection. In our example here we’ll be setting up MySQL Workbench, a visual database design tool, but the concepts will apply to any number of tools that can connect to a server via SSH tunneling.

Prep

1. If you haven’t already, set up your SSH key in your Flywheel dashboard and test your SSH connection.
2. Using SSH, run cat ~/.my.cnf to view your site’s my.cnf file to get the host IP address, database user, and database password. Alternatively, you can download a copy of your site’s wp-config.php file and get the DB_HOST, DB_USER, and DB_PASSWORD values.
3. Choose and open the third-party tool you’ll be connecting to the database. We’re going to use MySQL Workbench as an example here, but there are various tools available that can be used.

Connection Settings

In your chosen tool, fill in the connection settings to set up the connection with your Flywheel site’s database. Here’s an example in MySQL Workbench:

How to enter the SSH username

You can connect to a site using your user account or an organization (org) account.

• To connect with a user account, enter username+site-slug (Example: flytrevan+super-fly).
• To connect with an org account, enter the word team first, then org-name+site-slug (Example: team+fly-design-studio+super-fly).

Finding your username

Your SSH username begins with your Flywheel username, which can be found in a couple of different ways:

1. By connecting to ssh.getflywheel.com via SSH and copying it from the prompt
2. Or, on your Profile page

Note

If you’re connecting to a site owned by an Organization, the Organization’s username can be found before the site slug in the URL when viewing the site in the Flywheel dashboard.

Finding your site-slug

The second part of your SSH username is the site-slug, which can be found in a couple of places:

1. In the menu, once you’ve connected via SSH.
2. At the end of the URL (after the site owner’s username) when viewing a site in the Flywheel dashboard.
   

Save and test the connection

Once you’ve got everything filled out, you can test and save your connection settings. Now you can connect to your Flywheel site’s database whenever you want to!

Need help?

If you have any questions our Happiness Engineers are here to help!