Configuring the application database

The application database is responsible for storing crucial information such as users, teams, projects, APIs, and other necessary data required for the application to function. By default, there are no embedded database settings.

MySQL

The minimum recommended versions are MySQL 8.0.17, and the utf8mb4 character set is required. You can provide the connection details to MySQL by using environment variables as shown below:

Please note that Apidog does not create the database for you. You can use the following SQL statement to create the database:

No need to add any tables. Apidog will create those on startup. Keep in mind that Apidog will be connecting from within your Docker container, so make sure that MYSQL_HOST either: a) you're using a fully qualified hostname, or b) that you've set a proper entry in your container's /etc/hosts file.

By providing the MySQL connection details mentioned above, Apidog will be able to locate the application database.

Redis

The minimum recommended versions are Redis 6.0.5. You can provide the connection details to Redis by using environment variables as shown below:

Keep in mind that Apidog will be connecting from within your Docker container, so make sure that REDIS_HOST either: a) you're using a fully qualified hostname, or b) that you've set a proper entry in your container's /etc/hosts file.

Configuring the application database

MySQL#

Redis#

MySQL

Redis