Sonny 🤔

Posted on Nov 26, 2017

Getting Up and Running with the Windows Subsystem for Linux

#windows #linux #bashonwindows #tmux

An exercise in futility

This weekend I started tinkering around with the Windows Subsystem for Linux (WSL). I was mainly inspired to really start experimenting when I saw /u/noahnichols2008's post on reddit. Here are some of my thoughts/observations.

Background

I'm a software engineer working mainly in Python, AWS, Ansible, etc. I work on the open source cloud compliance rules engine Cloud Custodian and have been doing most of my development work recently on a 2016 15" Macbook Pro. Previously, I survived through university working on a variety of Windows machines, from Windows 7, to 8, to 10, all without the WSL. During that time, I stood up multiple Ubuntu dual boots, VM's, etc. while also dipping my toes into Vagrant. These days, I mainly use iTerm2 as my terminal emulator of choice on macOS, tmux for logging in and out of random ec2 instances without pulling my hair out, and vim. Due to the nature of developing on and maintaining a large fleet of VM's in the cloud, I'm more familiar with doing things the GNU/Linux way than the M$FT way.

I bought myself a 12" Macbook a few weeks ago to see if I would be able to handle the small size and the controversial butterfly keyboard. Despite all the hooplah that Apple gave to the keyswitches during the announcement, I just found the keyboard to be incredibly unimpressive, annoying to type on, and unreliable. I returned it, and put the idea of buying a laptop on the back burner for a while. A few things I did like about it, however were the size, screen, and USB-C. Luckily, the Huawei Matebook X went on sale that featured all those things... but it ran Windows.

Again, I'm not a stranger to Windows. I've only relatively recently started working on macOS. For the vast majority of my life, I've used Windows in various forms: desktop, 2 in 1's, tablets, and laptops. While all my experiences with Windows has been serviceable, the development experience has been a nightmare. When Microsoft announced WSL, I was very intrigued. Running GNU/Linux basically natively in Windows? Being able to get actual work done and then being able to edit photos in Lightroom or Photoshop without having to buy a Mac or run a VM? It all sounded too good to be true. After all, isn't this the same Microsoft whose former CEO Steve Ballmer once said:

Linux is a cancer

Well, I thought I'd give it a shot.

Setup

Getting WSL up and running in the first place is a pain in the ass by itself. WSL isn't enabled out of the box for some reason, possibly because Microsoft is too afraid of normies accidentally going into cmd.exe and typing dir instead of ls? Anyways, to get started you actually have to do a non-trivial amount of things first.

Step 1: Update everything

If you want the latest and greatest features of the WSL, you're gonna have to spend some time doing a whole lot of nothing while Windows finds and updates itself to the latest version. This by itself is a pretty trivial effort, just go into your system settings and Check for Updates.

Step 2: Enable the Windows Subsystem for Linux

Again, I have no idea why Microsoft would disable this by default, especially since there really isn't much of a chance that this would actually confuse someone. To actually jump into the WSL you would need to open cmd.exe and run bash which as far as I know, is enough of a barrier to entry as most normal people need. However, I digress. Hit Start and search for Turn Windows Features On or Off, then look for the Windows Subsystem for Linux and turn it on.

Step 3: Updates 2: Electric Boogaloo

Once you've enabled the WSL, you'll then be prompted that enabling it will require another update. Go ahead and get update it. Stay strong, we're almost there.

Step 4: (Actually) Getting Started

Now that we're completely up to date and have WSL enabled, we can finally get started. Head over to the Windows App Store and download Ubuntu (or some other flavor of GNU/Linux. As of right now, only SUSE and Ubuntu are available). That will install an app on your computer that will finally let you use Ubuntu natively(-ish) on your PC. However, that just opens up cmd.exe with Bash, which means you're still getting a terrible terminal emulator and an awful experience.

Step 5: Getting it to look good.

Unlike other operating systems, there isn't exactly an over-abundance of ~good~ terminal emulators available for Windows. By default, Bash for Windows/Ubuntu will run in the equivalent of good ol' command prompt. With minimal colors and poor/no powerline font support. To combat this, we're gonna have to use something else for the time being, until Microsoft decides to bundle in a usable terminal emulator into Windows. Here are a few options:

cmd.exe
mintty
cmder
comemu
hyper.js

Of those, I've used cmder, mintty, and hyper.js.

The most important things I look for in a terminal emulator are:

Performance: I want to be able to type and see the characters move across the screen real-time. Unfortunately, this isn't necessarily a given.
Themeable: I'm vain. I need to have pretty colors on the screen.
Panes: Nice to have, but not necessary.
Tabs: Nice to have, but not necessary.

Hyper.js (a javascript electron based terminal emulator) is awful on Windows. It isn't that much better on macOS either. It's slow, uses a ton of system resources, and the "amazing" plugin system has a ton of issues running on Windows. Also, for some reason it doesn't like it when I use Ctrl+h to move between panes in Vim.

Cmder is ok; I haven't really used it heavily with WSL, but have had a decent experience with it in the past when I was working on Windows in university. From the time I have tinkered around with it recently, it's been a bit slow to respond when working in Vim and generally moving around the file system.

That leads us to mintty. If you want to get started with WSL, there really isn't any other choice but the WSL Terminal from my perspective. It's fast (using around 5MB of ram writing this in Vim, compared to ~100MB for .hyper.js sitting at an empty screen and 35MB for cmder), has nice themeing capabilities, and is relatively full featured. To get started, simply follow the instructions in the Readme for wsltty.

Optional Step 6: XFCE on WSL

I poked around with this a bit over a weekend and was able to get it mostly working. With this, you'll have full access to most GUI GNU/Linux applications, albeit with a few caveats.

Getting Started

To get started, you'll want to install a Windows X server, i.e. XMing, or VcXsrv. Install either of these to get started.

Then, add the following to your .bashrc, changing /some/directory/you/specify to your own directory:

export DISPLAY=:0
export XDG_RUNTIME_DIR=/some/directory/you/specify 
export RUNLEVEL=3
sudo mkdir /var/run/dbus
sudo dbus-daemon --config-file=/usr/share/dbus-1/system.conf
rm -rf .cache/sessions

Now, you can install XFCE:

sudo apt install xfce4
sudo apt install blueman
sudo apt install gnome-themes-standard
sudo apt-get install libcanberra-gtk3-module

From there, assuming everything went smoothly, you should be able to run the following and get a GUI:

xfce4-session

Thanks to /u/kenshen for his post on /r/bashonubuntuonwindows

After getting all that setup, you now have access to any number of terminal emulators on GNU/Linux. However, I"ll be sticking with WSLtty for now.

Using WSL

Now, onto actually using WSL. As mentioned before, the pain of setting up a functional and nice-to-look-at terminal emulator was a huge pain in the ass. Since the main two requirements were performance and themeable, Mintty/WSLtty seemed to cover both of those bases. However, for those coming from iTerm2 with its nice split panes and easy movement with keyboard shortcuts, this was still going to be an uphill battle.

Using tmux

To combat this, I started using tmux more. I had already been using tmux in the context of logging into an instance, starting tmux, and then creating splits with tmux to allow myself to run processes, attach/detach from sessions, and generally not hate my life. Since I would be moving from OS to OS and terminal emulator to terminal emulator, it made less sense for me to put the burden on myself of memorizing different keyboard shortcuts to do things that I would want across all of my environments.

Here is my .tmux.conf:

# remap prefix from 'C-b' to 'C-a'
unbind C-b
set-option -g prefix C-a
bind-key C-a send-prefix

# split panes using d and s, a la iTerm2
bind -n M-d split-window -h
bind -n M-s split-window -v
unbind '"'
unbind %

# reload config file (change file location to your the tmux.conf you want to use)
bind r source-file ~/.tmux.conf

bind -n M-j select-pane -D 
bind -n M-k select-pane -U
bind -n M-h select-pane -L
bind -n M-l select-pane -R

set -g mouse on
set -g base-index 1
setw -g pane-base-index 1

Here, I switch the prefix from the default C-b to a more sensible C-a and change the split behavior to M-d and M-s (alt+d and alt+s) to better align with my habitual cmd+d pane splitting in iTerm2. I also enabled mouse movement for scrolling through history, logs, etc. and updated the pane-base-index to start at 1 for better ergonomics. Additionally, I've added the ability to move between panes with hjkl a la Vim with the alt modifier key. Now, I've simply added the following to my .bashrc to start tmux every time:

[[ $- != *i* ]] && return
[[ -z "$TMUX" ]] && exec tmux

Fish: A better shell

Now that we have some basic movement and functionality in place, it's time to upgrade our shell. Bash is great, but it lacks a lot of nice-to-haves that can be fixed with adding a whole bunch of stuff to your .bashrc or .bash_profile, but I want that stuff out of the box. To get this, I use Fish. Fish offers a lot of great features such as better auto-completion of commands, a package manager (Oh My Fish, man page completion, and editing themes in a web based UI (which admittedly, I don't use very often)).

Installing Fish is fairly straight forward, simply:

sudo apt-get install fish

Then, install oh-my-fish:

curl -L https://get.oh-my.fish | fish

I use the agnoster theme, install with:

omf install agnoster

Now, all you need to do is update your shell. Supposedly WSL now supports changing shells with chsh, but I haven't been able to get it to work. I stick this in the bottom of my .bashrc (hacky, I know):

if [[ -t 1 && -x /usr/bin/fish ]]; then
    exec /usr/bin/fish
fi

Additional (important) Info

Now, WSL isn't exactly 100% interop with Windows. Even something as simple as opening a file in notepad.exe isn't going to work out of the box. For one, Microsoft doesn't want you working with files in the WSL in Windows, this can cause issues as the file systems between the two are sufficiently different. Additionally, even looking for the WSL in explorer isn't very easy. To access your home directory, you'll have to go to:

C:\Users\<Windows User>\AppData\Local\Packages\CanonicalGroupLimited.UbuntuonWindows_79rhkp1fndgsc\LocalState\rootfs

Note: Do not touch anything in here, if anything it should only be read-only.

However, there aren't restrictions on accessing files in your Windows system. Simply go to:

/mnt/c

From there, you'll have access to everything in you C:/ drive, and should be able to access other drives as well.

Conclusion

WSL is a very interesting project from Microsoft. It's very obviously trying to win over macOS users who have sworn off Windows as an operating system, instead opting for the greener fields of a unix-based operating system. Its recent release of a command line tool to change the color scheme of cmd.exe and moving the Ubuntu and SUSE distros to the Microsoft Store are very clearly signs of its desire to get back the developer demographic. From my time tinkering around with it, I have to say it's definitely a mixed bag. The level of effort for even getting it up and running is non-trivial, especially on a fan-less ultrabook that I'm typing on right now. Additionally, the lack of an absolutely knock-out terminal emulator to use for WSL without significant research is incredibly off-putting for those trying to get started.

There are certainly resources out there for figuring out how to get up and running, /r/bashonubuntuonwindows comes to mind as a decent, though somewhat spare place for answers, and their github repo certainly has answers if you're willing to dig through some Github issues. Unfortunately, it just isn't "out of the box" enough to really recommend anyone use as of right now. Especially, if you're just getting started.

If you have a great .tmux.conf, .bashrc, etc., you might be able to switch over relatively easily. But, until Microsoft fixes some of the random exant issues with things like dbus not properly starting, or WSL randomly having issues finding certain files, this is kind of a futile exercise. You can certainly get stuff done, at the expense of spending a ton of time getting stupid stuff done.

Top comments (9)

Dave Jacoby • Dec 1 '17 • Edited

I like people talking about WSL. I have a lot of "real" Linux at my work, so I haven't spent too much time with WSL as my main development environment.

I can't help thinking that this tells us a lot more about how you use a Unix machine than how most developers would need to get WSL going.

I mean, there is nothing I'd want to run with a window from Linux that doesn't have an equivalent in Windows, so it's been probably more than six years since I've installed or used XMing, and none of the research clusters have fish, so it makes no sense for me to use it over bash, even if I need to have a 200-line .bashrc file.

Similarly, I've not built up a need for either tmux or screen.

I take a point back. Default term uses a standard library for text (USC-2) that came from the 80s and pre-exists Unicode, so using UTF-8 things in your prompt, like I do (I have the local temperature between time and path, with degree symbol), doesn't work in it so gnome-terminal in Windows is worth looking into.

Anyway, the suggestions I would make are more:

apt-get install build-essential
Bookmark Microsoft's bug-tracking repo for WSL and report your problems
Follow Rich Turner on Twitter. He's a Senior PM working with console and WSL issues.

But still, thanks for this. I'll try fish on my work box for a while.

Bernhard Döbler • Nov 28 '17

You write I should use the dialog "Turn Windows Features On or Off". You can use the store and install Ubuntu, also.
In the past I went your way and after installing the fall update 2017 I installed Ubuntu from the store. I now have two Linuxes running on Windows 10.

Leah • Nov 30 '17

chsh works fine on the wsl, but wsltty always explicitly starts bash

Robin Kretzschmar • Nov 16 '18

I had strange issues, for example tilix could not save the preferences and showed a dbus error.

Found the solution In this Reddit post:

3) Now we need to fix dbus: The issue with this was that by default, dbus uses unix sockets to communication, which windows bash at the moment doesn’t support. So we just need to tell it to use tcp. In /etc/dbus-1/session.conf, you need to replace unix:tmpdir=/tmp with tcp:host=localhost,port=0 and then you are done. Note this file needs root to edit. An easy way to do this is to execute the following:

sudo sed -i ‘s$<listen>.*</listen>$<listen>tcp:host=localhost,port=0</listen>$’ /etc/dbus-1/session.conf

Don't forget to restart the session afterwards!

Patrick Schönfeld • Nov 27 '17

Thanks for the article, took some tipps from it like ... for a terminal other than cmder.

Recently I tried to setup a decent dev environment on Windows 10 myself and you really share my sentiments.

I do think the movement at Microsoft is pretty cool and it's amazing what they did so far, but there really is a lot to do. One of the things is, on a MacOS system I do not have to enable magic windows features, after that install something from a ui application, find or decent terminal emulator or use the real awful included one and afterwards type bash ... to get a working shell.

In MacOS I just open a terminal and even if some might find iTerm2 to be better - the included one is already quiet decent.

But there is a lot more where it lacks behind IMHO.

Adrian B.G. • Dec 9 '17

I really tried to make a nodejs project ran on WSL, after many compilation errors I found out it doesnt work with real projects. Also it state to not modify it's files with Windows software like an IDE so, it's cool but git bash is enough for me, and I moved the project to Cloud9 AWS.