Directus: External databases

How to connect Directus to a MySQL, MariaDB, or PostgreSQL database

👋 Welcome to the Stackhero documentation!

Stackhero provides a Directus cloud service that is production-ready in just 2 minutes:

• Unlimited collections, items, users, roles, API requests, and data transfers
• Custom domain name with built-in HTTPS for secure access (for example, https://cms.your-company.com)
• Dedicated email server for unlimited transactional and notification emails
• Integrated Redis cache for high performance
• Consistent performance and enhanced security with private, dedicated infrastructure
• One-click updates to keep your system up to date effortlessly

Focus on your project, not on the setup: you can discover Stackhero's Directus cloud solution in just 5 minutes.

Directus instances on Stackhero come configured with a SQLite database by default. This makes it easy to get started, so you can explore the platform or run tests within minutes. However, for production environments a more robust external database is recommended.

Connecting Directus to a MySQL or MariaDB database

1. First, create a user for Directus on MySQL or MariaDB. Open phpMyAdmin and navigate to User accounts followed by Add user account.

2. Provide a username (for example, directus). Set a secure password by clicking the Generate button, choose Native MySQL authentication, and check Create database with same name and grant all privileges.

   Directus user creation on a MySQL/MariaDB database

3. Next, log in to your Stackhero dashboard. Select your Directus service and click Configure.

4. In the configuration panel under Database, choose MySQL/MariaDB and complete the remaining fields as shown in the screenshot below.

   Configuration of MySQL/MariaDB for Directus

Connecting Directus to a PostgreSQL database

1. Start by creating a user for Directus on PostgreSQL. Open PgAdmin, expand servers > postgresql, right-click on Login/Group Roles, and select Create > Login/Group Role....

2. In the Name field, enter directus.

3. Switch to the Definition tab and set a strong, secure password.

4. Next, go to the Privileges tab, check Can login, and save the new user.

   Directus user creation on a PostgreSQL database

5. Now create a database for Directus. Right-click on Databases and choose Create > Database.

6. Enter directus in the Database field, select directus as the owner, and save your changes.

   Directus database creation on PostgreSQL

7. Finally, navigate to your Stackhero dashboard, select your Directus service, and click Configure.

8. Under Database, select PostgreSQL and fill in the additional fields as shown below.

   Configuration of PostgreSQL for Directus

Directus error "🚨 ER_NOT_SUPPORTED_AUTH_MODE: Client does not support authentication protocol requested by server"

If you see the error 🚨 ER_NOT_SUPPORTED_AUTH_MODE: Client does not support authentication protocol requested by server; consider upgrading MySQL client when using a MySQL server that employs the new caching SHA2 authentication, Directus will not be able to connect properly. The solution is to switch to the traditional native MySQL authentication.

1. If you are using phpMyAdmin, navigate to User accounts, select your Directus user, click Change password, and enter your password. Be sure to choose Native MySQL authentication as the password hashing method.

2. Alternatively, you can run the following SQL commands using the CLI. Replace directus with your username and mySecretPassword with your chosen password:

   ALTER USER 'directus'@'%' IDENTIFIED WITH 'mysql_native_password' BY 'mySecretPassword';
   FLUSH PRIVILEGES;
   

Following these steps will help ensure that your Directus installation on Stackhero uses an external database designed for a production environment, offering improved performance and reliability.