README.md

Localhost Databases

---

MySQL is the world's most popular relational database.

About • Disclaimer • Getting Started • Download • How To Use

---

About

MySQL is the world's most popular open-source relational database management system (RDBMS).

Disclaimer

Important

Localhost Databases is not affiliated with the databases' developers/owners and is not an official product.

Localhost Databases has been developed to run databases in a local Docker environment. To install a production instance, read the databases' respective installation guides.

Getting Started

You will need to make sure your system meets the following prerequisites:

• Docker Engine >= 20.10.0

This repository utilizes Docker to run the MySQL sample. So, before using the MySQL, make sure you have Docker installed on your system.

Download

To use MySQL, you can clone the latest version of Localhost Databases repository for macOS, Linux and Windows.

# Clone this repository.
$ git clone git@github.com:luisaveiro/localhost-databases.git --branch main --single-branch

You can locate the MySQL Docker configuration in the databases directory.

# Navigate to the MySQL folder.
$ cd localhost-databases/databases/mysql

How To Use

There are a few steps you need to follow before you can have an MySQL database set up and running in Docker container. I have outline the steps you would need to take to get started.

1. Environment Variables

Before you start a database in a Docker container, you will need to create a DotEnv file. The DotEnv file will allow you to configure your database's credentials and map a container's port.

Localhost Databases includes a .env.example file for MySQL Database. You can run the following command in the terminal to create your DotEnv file.

# Navigate to a database.
$ cd databases/mysql

# Create .env from .env.example.
$ cp .env.example .env

The MySQL Docker Compose file uses the follow variables from the DotEnv file.

#--------------------------------------------------------------------------
# Docker env
#--------------------------------------------------------------------------

# The project name. | default: mysql
APP_NAME="mysql"

#--------------------------------------------------------------------------
# Database (MySQL) env
#--------------------------------------------------------------------------

# The MySQL database container name. | default: mysql_db
DB_CONTAINER_NAME="${APP_NAME}_db"

# The MySQL database configuration. | default: local
DB_DATABASE="local"

# The MySQL database root credentials.
DB_ROOT_PASSWORD=""

# The MySQL database user credentials.
DB_USERNAME=""
DB_PASSWORD=""

#--------------------------------------------------------------------------
# Network env
#--------------------------------------------------------------------------

# Map the database container exposed port to the host port. | default: 3306
DB_PORT=3306

# The Docker network for the containers. | default: local_dbs_network
NETWORK_NAME="local_dbs_network"

#--------------------------------------------------------------------------
# Volume env
#--------------------------------------------------------------------------

# The database container data volume. | default: mysql_db_data
DB_VOLUME_DATA_NAME="${DB_CONTAINER_NAME}_data"

Note

MySQL allows root's password to be empty.

For a list of available environment variables that the MySQL Docker image supports, you can visit MySQL Docker Hub page.

2. Start Docker container

To start the MySQL container, you can run the following command:

# Navigate to MySQL database.
$ cd databases/mysql

# Run Docker Compose command.
$ docker compose up -d

Expected result

To check the MySQL container is running and the port mapping is configured correctly, you can run the following command:

# List containers
$ docker ps  

You should see a similar output.

CONTAINER ID   IMAGE          COMMAND                  CREATED          STATUS                             PORTS                               NAMES
cb9bac3a9026   mysql:latest   "docker-entrypoint.s…"   11 seconds ago   Up 10 seconds (health: starting)   0.0.0.0:3306->3306/tcp, 33060/tcp   mysql_db

3. Stop Docker container

To stop the MySQL container, you can run the following command:

$ docker compose down

4. Connect to Database

To connect to your MySQL container from your database client, you will need to provide the following settings:

HOST=127.0.0.1
PORT="${DB_PORT}"

USER="${DB_USERNAME}"
PASSWORD="${DB_PASSWORD}"

Expected result

Below is a screenshot of the settings used in TablePlus:

_{^{TablePlus settings for MySQL.}}

---

GitHub • LinkedIn • Twitter