How to Connect MySQL on Windows to Django in WSL

If you’re running a Django project in Windows Subsystem for Linux (WSL) and trying to connect it to a MySQL server installed on Windows, you might encounter some connectivity challenges. This is because WSL and Windows operate as separate environments. Here’s a step-by-step guide to bridging the gap and ensuring smooth communication between Django and MySQL.

Step 1: Install MySQL in WSL (If Needed)

If MySQL isn’t installed in your WSL environment, you can set it up with the following commands:

sudo apt update
sudo apt install mysql-server

Once installed, you can start the MySQL service with:

sudo service mysql start

If you prefer using the MySQL instance running on Windows, proceed to the next steps.

Step 2: Configure MySQL for External Connections

To allow WSL to connect to the MySQL server running on Windows, you need to modify the MySQL configuration:

1. Locate the MySQL Configuration File
   The file is usually named my.ini or my.cnf, located in the MySQL installation directory (e.g., C:\ProgramData\MySQL\MySQL Server X.X\my.ini).

2. Update the bind-address Directive
   Open the file and look for the bind-address configuration. Change it to listen on all interfaces (0.0.0.0) or comment it out:

   # bind-address = 127.0.0.1
   

3. Restart MySQL on Windows
   After making these changes, restart the MySQL service on Windows to apply the new configuration.

Step 3: Find the Windows IP Address for WSL

To connect WSL to the Windows MySQL server, you need the Windows IP address as seen from WSL. Run the following command in your WSL terminal:

cat /etc/resolv.conf | grep nameserver

This will output something like:

nameserver 172.20.160.1

The IP address (e.g., 172.20.160.1) is what you’ll use to connect to MySQL from WSL.

Step 4: Update Django Database Settings

In your Django project, modify the DATABASES section of the settings.py file to use the Windows host IP address:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'mydatabase',
        'USER': 'myuser',
        'PASSWORD': 'mypassword',
        'HOST': '172.20.160.1',  # Replace with the IP address found earlier
        'PORT': '3306',          # Default MySQL port
    }
}

Step 5: Test the MySQL Connection from WSL

Verify the connection using the MySQL client in WSL:

mysql -u myuser -p -h 172.20.160.1 -P 3306

If this works, Django should also be able to connect to MySQL using the updated settings.py.

Step 6: Grant MySQL User Privileges

Ensure that the MySQL user (myuser) has sufficient privileges to connect from the WSL IP address:

GRANT ALL PRIVILEGES ON *.* TO 'myuser'@'172.20.160.1' IDENTIFIED BY 'mypassword';
FLUSH PRIVILEGES;

Replace myuser and mypassword with your actual MySQL username and password.

By following these steps, you can seamlessly connect your Django application running in WSL to a MySQL server hosted on Windows. This setup ensures your development environment is cohesive, even when working across distinct platforms. If you encounter any errors, double-check the configurations and permissions, or share the error details for further troubleshooting.