/emacs-wsl-config

Emacs running on WSL2 (Ubuntu 20.04) with a VCSrv serving the GUI.

Primary LanguagePowerShell

Emacs-WSL

This guide shows you how to run Emacs with the Windows Subsystem for Linux WSL (Version 1 and 2) on Windows 10 using Ubuntu 20.04 LTS as Linux distribution and VcXsrv as X server to run Emacs in a graphical display.

./img/emacs-wsl.png

Contents

Preparation

Clone this repository with Git or download it to any place on your machine to be able use the batch scripts (recommended) later on.

Enable WSL 1 or WSL 2

Open PowerShell as Administrator and run:

dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart

For WSL 2 (see requirements) you have to enable another feature:

dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart

Restart the computer.

Download and install the Linux kernel update package.

If you want to use WSL 2 you should set it as default before intstalling Ubuntu:

wsl --set-default-version 2

If you are not able to install WSL with this instructions go have a look at the official Microsoft docs (site) on how to install WSL.

Install Ubuntu 20.04

To install Ubuntu 20.04 open PowerShell and run:

curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
Add-AppxPackage .\ubuntu-2004.appx

After installation open Start (WIN) and launch the Ubuntu 20.04 LTS terminal. After a short while you will be prompted to enter a username and a password. This user will be your default user for the distribution and is considered the Linux administrator with the ability to run sudo commands.

Make sure everything is up to date:

sudo apt update && sudo apt upgrade -y

If you already have been using another Linux distribution you might want to set Ubuntu 20.04 as default. Open PowerShell and run:

wsl --set-default Ubuntu-20.04

Install Emacs 27.1

To install Emacs 27.1 in Ubuntu 20.04 you can

  • use (double-click) the three batch scripts (.bat) from the ./install-emacs folder
  • or clone this repo in the Ubuntu terminal and run the shell scripts from the ./install-emacs folder
  • or run the following commands in the Ubuntu terminal

Check out the commands run and especially the remarks below in any case.

  1. Install all dependencies (taken from the snap): 
    sudo apt update
sudo apt install -y autoconf automake bsd-mailx dbus-x11 debhelper dpkg-dev \
    libacl1-dev libasound2-dev libdbus-1-dev libgif-dev libgnutls28-dev libgpm-dev \
    libgtk-3-dev libjansson-dev libjpeg-dev liblcms2-dev liblockfile-dev libm17n-dev \
    libncurses5-dev liboss4-salsa2 libotf-dev libpng-dev librsvg2-dev \
    libselinux1-dev libsystemd-dev libtiff-dev libxml2-dev libxpm-dev procps quilt \
    sharutils texinfo zlib1g-dev gvfs language-pack-en-base libasound2 libaspell15 \
    libasyncns0 libatk-bridge2.0-0 libatk1.0-0 libatspi2.0-0 libbrotli1 \
    libcairo-gobject2 libcairo2 libcanberra-gtk3-0 libcanberra-gtk3-module \
    libcanberra0 libcroco3 libdatrie1 libdb5.3 libdrm2 libegl1 libenchant1c2a \
    libepoxy0 libflac8 libfontconfig1 libfreetype6 libgbm1 libgdk-pixbuf2.0-0 \
    libgif7 libgl1 libglvnd0 libglx0 libgpm2 libgraphite2-3 libgstreamer-gl1.0-0 \
    libgstreamer-plugins-base1.0-0 libgstreamer1.0-0 libgtk-3-0 libgudev-1.0-0 \
    libharfbuzz-icu0 libharfbuzz0b libhyphen0 libice6 libicu66 libjansson4 \
    libjavascriptcoregtk-4.0-18 libjbig0 libjpeg-turbo8 liblcms2-2 liblockfile1 \
    libltdl7 libm17n-0 libnotify4 libnss-mdns libnss-myhostname libnss-systemd \
    libogg0 liborc-0.4-0 libotf0 libpango-1.0-0 libpangocairo-1.0-0 \
    libpangoft2-1.0-0 libpixman-1-0 libpng16-16 libpulse0 librsvg2-2 libsasl2-2 \
    libsecret-1-0 libsm6 libsndfile1 libsoup2.4-1 libssl1.1 libstdc++6 libtdb1 \
    libthai0 libtiff5 libvorbis0a libvorbisenc2 libvorbisfile3 libwayland-client0 \
    libwayland-cursor0 libwayland-egl1 libwayland-server0 libwebp6 libwebpdemux2 \
    libwoff1 libx11-6 libx11-xcb1 libxau6 libxcb-render0 libxcb-shm0 libxcb1 \
    libxcomposite1 libxcursor1 libxdamage1 libxdmcp6 libxext6 libxfixes3 libxi6 \
    libxinerama1 libxkbcommon0 libxml2 libxpm4 libxrandr2 libxrender1 libxslt1.1 \
    libyajl2

    There will be a dialog about the mail server configuration, just select no configuration to leave it as it is and confirm with OK (use TAB and RET to get through this).

    If you are on Ubuntu 18.04 use the dependencies from ./install-emacs/ubuntu-18.04-dependencies.sh. In that case you will also have to modify the scripts (if you plan to use them) as the distribution is hardcoded into them to make sure to use the right distribution even it is not set as default.

  2. Download and extract Emacs: 
    cd ~
wget https://ftp.gnu.org/pub/gnu/emacs/emacs-27.1.tar.gz
tar -xzvf emacs-27.1.tar.gz
  3. Configure and install Emacs: This Step will take a while and you are prompted to enter your password once. 
    cd ~/emacs-27.1
./configure --with-cairo
make
sudo make install
rm ~/emacs-27.1.tar.gz

    Keeps the directory where Emacs was cloned to in case any step fails (to clean or reinstall) or to be able to reconfigure.

To try out if Emacs is working just run it directly in the terminal with emacs -nw.

Install Windows X-Server VcXsrv

An X-server lets you access a Linux application or desktop environment’s graphic user interface (GUI). This guide is using VcXsrv (free, open source, GPLv3).

Installation

Download VcXsrv from https://sourceforge.net/projects/vcxsrv/ and install it. Check out the next section about the firewall configuration before launching it (app is called XLaunch) for a first time to add the firewall rules.

Windows Defender Firewall Configuration

The first time you launch VcXsrv you are notified that Windows Defender Firewall has blocked some features.

./img/vcxsrv-windows-defender-firewall.png

You have to allow VcXsrv to communicate on:

  • WSL 1 Private networks
  • WSL 2 Private and public networks.

After allowing access the following inbound rules are added:

WSl 1

./img/vcxsrv-wsl1-firewall-inbound-rules.png

WSL 2

./img/vcxsrv-wsl2-firewall-inbound-rules.png

If you missed this step or are not sure what you’ve chosen or if you are switching from WSL 1 to WSL 2 you can retrigger this dialog by deleting the inbound rules (admin rights needed) and restart VcXsrv. The inbound rules shown above can be found at WIN Windows Defender Firewall > Advanced Settings (or WIN-r wf.msc RET).

WSL 2 Additional Firewall Configuration

To make VcXsrv work with WSL 2 you have to disable access control. Disabling the user access control with the -ac flag has some security issues:

-ac disables host-based access control mechanisms. Enables access by any host, and permits any host to modify the access control list. Use with extreme caution. This option exists primarily for running test suites remotely.

Therefore we want to restrict the access as much as possible. Unfortunately you can’t modify the firewall rules if you have no admin rights. In that case you have to live with the security issue (not sure how severe it is).

If you have admin rights you can add an inbound firewall rule to restrict access as much as possible. As the IP used by WSL 2 is dynamic a powershell script is provided later on to create/update the rule.

If you want to use the additional firewall rule make sure that you disable the existing inbound rules:

  1. Go to the inbound rule settings with WIN Windows Defender Firewall > Advanced Settings (or WIN-r wf.msc RET).
  2. Search for VcXsrv entries (there should be two) and disable all found.

Run Emacs in Terminal

Run Emacs with emacs -nw in Ubuntu terminal.

Run Emacs in Graphical Display

To run Emacs in a graphical display you have to:

  1. WSL 2 only, optional Created/update the inbound firewall rule (admin rights needed)
  2. Run VcXsrv
  3. Run Emacs

For convenience there are batch scripts (double-clickable) to (you can copy the run-emacs folder for WSL 1 or WSL 2 to wherever you want):

WSL 2 only Create/update the Inbound Firewall Rule

As described in WSL 2 Additional Firewall Configuration we want to restrict the access by adding a firewall rule. Make sure you have disabled the existing VcXsrv firewall rules.

To create or update the inbound firewall rule you can use the batch script ./run-emacs-wsl-2/wsl-2_2-firewall-rule.bat. If VcXsrv was running before the firewall rule was updated it has to be restarted.

Run VcXsrv

To run VcXsrv use the batch script provided or run the following commands in cmd (if you haven’t used the default installation path you have to adapt the script/command):

If VcXsrv is already running it will show an error message. In that case stop VcXsrv if needed and run the script again.

Run Emacs

To run Emacs you can launch Ubuntu terminal and run the following commands or use the batch script:

You can add the lines without setsid emacs to ~/.bashrc and then just use setsid emacs to launch Emacs in the background. If you do so VcXsrv has to be running before launching the terminal else this will give an error when starting the terminal and in that case slow the startup down.

To not have to type this over and over add an alias in ~/.bashrc and then run Emacs with ema (needs a restart):

  • WSL 1 
    alias ema='
export DISPLAY=:0.0
export LIBGL_ALWAYS_INDIRECT=1
setsid emacs
'
  • WSL 2 
    alias ema='
export DISPLAY=$(ip route | awk '/^default/{print $3; exit}'):0.0
export LIBGL_ALWAYS_INDIRECT=1
setsid emacs
'

Optional Additions

Use Windows Terminal

Install Windows Terminal from Microsoft from the Microsoft Store.

The Windows Terminal is a modern, fast, efficient, powerful, and productive terminal application for users of command-line tools and shells like Command Prompt, PowerShell, and WSL.

To make it open WSL by default:

  • Open the Windows Terminal.
  • Open the settings by clicking on the dropdown button in the tab bar and then select settings (bound to Ctrl-,).
  • Copy the GUID for WSL (example: {12345678-1234-1234-1234-1234567890AB}).
  • Set the default profile to the one copied from WSL: 
    {
    ...
    "defaultProfile": "{12345678-1234-1234-1234-1234567890AB}",
    ...

To change the default path to ~:

  • Go to the settings (Ctrl-,).
  • Add a line in the WSL part at the end (make sure to also add the , on the previous line): 
    {
    ...
    "source": "Windows.Terminal.Wsl",
    "startingDirectory": "//wsl$/Ubuntu-20.04/home/<username>/"
},

Change keyboard layout

If you want to change the keyboard layout used make sure x11-xkb-utils is installed (sudo apt install x11-xkb-utils) and add for instance

setxkbmap -layout us

to ~/.bashrc or to the alias to use the US keyboard layout. Or add it to the scripts used to run Emacs (... && setxkbmap -layout us && setsid emacs).

Generate SSH Key

Generate a new ED25519 SSH key pair:

ssh-keygen -t ed25519 -C "email@example.com"

A dialog will ask you to:

  • input a file path: use the suggested path by pressing Enter
  • enter a password: enter your password

To copy the generated ssh key into the clipboard use:

clip.exe < ~/.ssh/id_ed25519.pub

Use en_US Language

Bash on Ubuntu on Windows starts on the language defined in your Country or Region settings (maybe this got changed, not 100 % sure). If you want to change the default language to en_US you may need to run the following commands:

sudo apt install -y language-pack-en language-pack-en-base manpages
sudo locale-gen en_US.UTF-8
sudo update-locale LANG=en_US.UTF8

Mount Network Drives Automatically

To do so the fstab file needs to be configured.

For instance to mount H: add this to “/etc/fstab” (the directory has to exist to make this work, so in this case sudo mkdir /mnt/h is needed beforehand):

H: /mnt/h drvfs defaults 0 0

From now on that network drive is automatically mounted.

Zsh and oh-my-zsh

If you want to use zsh and oh-my-zsh:

sudo apt install zsh
chsh -s $(which zsh)
sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"

Restart WSL.

In some scripts you need to change bash to zsh to be able to use it when emulating a terminal in Emacs.

FAQ

Where is the root folder located?

The root is accessible as \\wsl$ in file explorer followed by the distribution. You can show the current distribution name by running wsl -l -q in cmd.

How to access Linux files from Windows?

Run explorer.exe . in WSL to open the Windows File Explorer at the current location. The path will start with \\wsl$ unless it is a mounted drive. In the File Explorer the files and folders can be copied, moved and edited as usual (see this blog post).

How start WSL from File Explorer in the current folder?

To start WSL from Windows File Explorer just type wsl into the location input box or hold down Shift while right-clicking and select Open Linux shell here from the context menu. If it’s a network drive it has to be mounted else this will not work.

./img/wsl-from-windows-explorer.png

What ways are there to run WSL?

See https://docs.microsoft.com/en-us/windows/wsl/wsl-config#ways-to-run-wsl.

Troubleshooting

Check out the Microsoft docs:

The GUI is not loading/showing at all

Check your firewall settings (see WSL 2 Additional Firewall Configuration).