Skip to content

Commit

Permalink
Merge pull request #4 from BruceFletcher/master
Browse files Browse the repository at this point in the history
Added MySQL relay script and documentation
  • Loading branch information
jstarks authored Nov 26, 2018
2 parents 0755886 + b4c7b89 commit cf5ebb2
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use Windows named pipes from the Windows Subsystem for Linux (WSL).
For example, you can:

* Connect to Docker for Windows from the Linux Docker client in WSL
* Connect to MySQL Server running as a Windows service
* Connect interactively to a Hyper-V Linux VM's serial console
* Use gdb to connect to debug the kernel of a Hyper-V Linux VM

Expand Down Expand Up @@ -105,6 +106,45 @@ $ sudo adduser <my_user> docker

Then open a new WSL window to reset your group membership.

## Connect to MySQL Server running as a Windows service

If you run MySQL Server as a Windows service, you can configure it to
communicate through TCP, named pipes or shared memory. If you use named
pipes, connecting to MySQL from WSL is very similar to connecting
to Docker.

The `mysqld-relay` script is designed to be run in a `sudo` shell.
Before creating the relay, it will try to configure your environment
(if it has not been configured yet) by:

* creating `/var/run/mysqld/`,
* creating a `mysql` group, and
* adding your user account to the `mysql` group.

You can of course pull out just the npiperelay command if you don't
need any of the above checks.

Note that if you need to enter a password for sudo, the following
command will fail because of the lack of password input:

```bash
$ sudo mysqld-relay &
```

In that case, you can run it like this:

```bash
user@machine:~$ sudo -s
[sudo] password for user:
root@machine:~# mysqld-relay &
root@machine:~# exit
user@machine:~$ _
```

Now you can use the Linux `mysql` command line client or any other
Linux process that expects to talk to MySQL Server through
`/var/run/mysqld/mysqld.sock`.

## Connecting to a Hyper-V Linux VM's serial console

If you have a Linux VM configured in Hyper-V, you may wish to use its serial
Expand Down
21 changes: 21 additions & 0 deletions scripts/mysqld-relay
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#!/bin/sh

if [ -z "${SUDO_USER+x}" ]; then
echo "mysqld-relay must be run via 'sudo'"
exit 1
fi

if [ ! -e /var/run/mysqld ]; then
mkdir /var/run/mysqld
fi

if [ ! $(getent group exists mysql) ]; then
groupadd mysql
fi

if $(id -Gn $SUDO_USER | grep -qv '\bmysql\b'); then
usermod -aG mysql $SUDO_USER
echo "*** Log out and back in to enable 'mysql' group membership ***"
fi

exec socat UNIX-LISTEN:/var/run/mysqld/mysqld.sock,fork,group=mysql,umask=007 EXEC:"npiperelay.exe -ep -s //./pipe/MYSQL",nofork

0 comments on commit cf5ebb2

Please sign in to comment.