This is my journal about configuring Windows 10 to become my primary machine for web development. Not all of these steps necessary, you can choose whatever step that suits your need.
SideNote:
- i'm using Windows 10 Pro 64bit
- i'm using Ubuntu 20.04 as default WSL distro
- How-Tos
- Install and Configure Colemak as My Default Keyboard Layout
- Change Machine Name
- Turn on Disk Encryption (Windows 10 Pro only)
- Enable Built in Clipboard
- Enable Night Light
- Change to Small Taskbar
- Enable Fingerprint
- Enable WSL and Upgrade to WSL 2
- Install Chocolatey (Package Manager for Windows)
- Install and Configure Terminal for Windows from Microsoft Store
- Install Ubuntu Tools and Utility in WSL
- Make WSL Terminal Pretty and Powerful
- Sharing SSH between Windows and WSL and Configure Correct Permission for SSH in WSL
- Fix Folder and Files Default Permission in Windows (From WSL Perspective)
- Install and Configure Git
- Sharing Git Credentials Between Windows and WSL
- Install and Configured Docker for Windows
- Install and Configure VSCode + Remote Development Pack
- Restart WSL from Task Manager
- Install OpenSSH Server and Client
- Known Bugs
I'm using colemak as my keyboard layout for more than 5 years now. Unfortunately, Windows not shipped with colemak out of the box so i need to install it myself (c'mon guys, colemak even included by default in linux).
- Colemak for Windows have 2 version, one with Capslock mapped to Backspace and one that doesn't. I'm using the former. You can download both version here. For the one i use, download it from here.
- Go to Settings > Time & Language > Preferred Language and Choose the primary language. Mine is English (US). Then click Options button. Make sure that Colemak already registered there.
- To make Colemak as primary keyboard layout, Go to Settings and type
Advanced Keyboard Settingsand choose Colemak from the dropdown. - To disable (annoying) Ctrl + Shift combo that change the keyboard layout accidentally, still in
Advanced Keyboard Settings, go toInput language hot keyschooseBetween input languagesthen pressChange Key Sequencebutton. ChooseNot Assignedoptions for both of settings.
- Go to Settings > System > About > Rename this PC
Since i have many confidential files, i need to encrypt my harddisk. We can use Bitlocker which is come with Windows 10 Pro by default.
- Open explorer (Win + E)
- Right click on C:\ (i only have single partition for everything), then choose Turn on Bitlocker
- Go to Settings > System > Clipboard > Clipboard History > On
- Access clipboard using Win + V
- Go to Settings > System > Display > Night light > On
- Go to Settings > Personalization > Colors > Choose your color > Dark
- Go to Settings > Personalization > Taskbar > Use small taskbar buttons > On
If your machine support Windows Hello, you can setup fingerprint mode for login which very convenient IMO.
- Setup your account with password first
- Go to Settings > Account > Sign in options > Windows Hello Fingerprint
-
To enable WSL, go to Settings > Apps > Program and Features (on the top right side) > Turn off Windows features on or off > Check Hyper-V, Virtual Machine Platform, and Windows Subsystem for Linux
-
Follow instruction in this page to upgrade to WSL 2. Your Windows version must be in version 2004 to use WSL 2.
-
Included in that page, there are steps for Ubuntu 20.04 installation from Microsoft Store after done installing WSL 2. We also will set WSL 2 as default WSL (since we have WSL 1 and WSL 2).
-
Set default distro to Ubuntu 20.04 by using
wsl -s <DistributionName>, wsl --setdefault <DistributionName>
- Follow this instruction from Chocolatey install guide
-
Install
Terminalfrom Microsoft Store -
Make Ubuntu 20.04 as default by setting the value of
defaultProfileto Ubuntu guid. You can find it under list, still in settings.json file -
Change starting directory to linux home directory instead of /mnt/c/User by adding this properties under Ubuntu 20.04 profile
"startingDirectory": "\\\\wsl$\\Ubuntu-20.04\\home\\[linux-username]"
-
We can also reorder the list and move Ubuntu 20.04 to the top so by default Terminal app will choose Ubuntu when we click
+button.
sudo apt install curl git net-tools xsel acpi htop
I already use several tools not only to make my terminal more powerful, but also pleasing to the eye. The tools are:
-
Homebrew. Homebrew, which is known as package manager in MacOS, also available in linux. Homebrew provide many ready to use scripts and tools so we don't need to built from source manually. To install, follow instruction here. To backup and restore, you can use
brew bundle dumpfor backup andbrew bundleto restore. More on those, you can read it here -
ZSH + Oh-My-ZSH + antigen
-
Tmux
-
Powerline fonts. We can install the font in Windows automatically without having to install them one by one using font viewer.
-
Clone the font from https://github.com/powerline/powerline.git in directory that you have chosen.
-
Open Powershell, then run
Get-ExecutionPolicy. If it returnsRestricted, then runSet-ExecutionPolicy Bypass -Scope Process -
Change directory to where powerline cloned (get inside the folder called
fonts-master), and runinstall.ps1
-
-
Change font in Terminal to powerline font by adding this line to Ubuntu profile in settings.json
"fontFace": "DejaVu Sans Mono for Powerline" -
To open wsl directory on windows explorer, simply open wsl and run
explorer.exe .. If you come previously from ubuntu, you can copy your configuration file here (.zshrc, .tmux.conf, .gitconfig, ssh folder etc)
My WSL console appearance:
-
Follow instruction here
-
Don't forget to set the permission (chmod) of the SSH folder and files so we can use it normally.
.ssh directory: 700 (drwx------)
public key (.pub file) & known host: 644 (-rw-r--r--)
private key (id_rsa): 600 (-rw-------)
lastly your home directory should not be writeable by the group or others (at most 755 (drwxr-xr-x)).
Windows by default assign 777 if the file is located outside WSL. We can fix this by
-
adding this setting in
.profileinside WSL home directoryif [[ "$(umask)" = "0000" ]]; then umask 0022 fi -
create file (if not exists)
/etc/wsl.confand put this inside the file content[automount] enabled=true options=metadata,uid=1000,gid=1000,umask=022
Git can be a pain for a cross platform project. This is due to difference in how line ending being treated in Windows and *nix OS. Windows using CRLF, *nix using LF
-
Install git in WSL with
sudo apt install gitif you haven't done this before. This git limited to WSL console only. If you want to use git in your IDE, you must install Git for Windows -
If you see all your existing project suddenly become modified, don't panic. Resolve it by using this setting in your global git config
git config --global core.autocrlf true git config --global core.filemode falseBasically,
core.autocrlf truewill use this conversion ruleCheckout -> CRLF, Commit -> LF. This is suitable for windows, since any project from remote repo's line ending will automatically converted to CRLF in checkout. On commit, it will be automatically converted to LF. Meanwhilecore.filemode falsewill ignore the difference in permission between folder/file checked out in WSL or Windows storage.Still see the files modified in git status ? check your entire config by using
git config --list --show-originto make sure that the global config is not overridden by project-scoped config.By the way, if you have project that meant to be run in Linux, put them inside WSL folder. If you put the project outside WSL, the access will be significantly slow and some watch feature (create react app hot reload, webpack watch) will not work. More on that, see the comment about WSL 2 limitation here
- Follow instructions here
- Download the exe here
- If WSL 2 is installed, Docker will ask to use WSL 2 by default.
- After installation finished, go to docker icon in taskbar, then choose Settings > Resources > WSL Integration > turn on Ubuntu 20.04
- Check the integration by opening WSL console, then type
docker version. It should return with installed docker information.
-
Install VSCode, then download Remote Development extension from Microsoft
-
To set default terminal in VSCode to WSL, put this in VSCode settings.json
"terminal.integrated.shell.windows": "C:\\Windows\\System32\\wsl.exe" -
To open your project using VSCode in WSL context, the easy way is just open WSL console, go to your project root, then type
code .and VSCode will be open and automatically connected with WSL. -
See here for more complete instruction on setting VSCode and WSL
Sometimes, the connection to the WSL is lost / freeze. We can restart it by go to Task Manager > Services > LxssManager then right click and choose Restart.
To make ssh command accessible from Powershell, we can install OpenSSH via Settings > Apps > Apps & features > Optional features > Add a feature > type "OpenSSH"
Open the Task Manager and see if Vmmem is causing your CPU / memory usage to 100%. Don't worry, that's not because your machine is lack of memory. In the following github issue, someone reported that his machine (which having 64GB RAM) also encountered this problem too. Basically, it's a known bug when we use WSL 2. This is the workaround:
-
Create a file under C:\Users\your-username called .wslconfig and put this inside the file. Basically it is for limiting how much memory that wsl2 consumes. We can change the configuration as we see fit.
[wsl2] memory=4GB swap=16GB localhostForwarding=true
Another workaround is to empty the cache in linux so it will free the memory and return it to windows
-
create an alias called drop_cache
alias drop_cache="sudo sh -c \"/usr/bin/echo 3 > /proc/sys/vm/drop_caches\" && printf '%s\n' 'Ram-cache Cleared'"and run this everytime the
Vmmemstart eating up your RAM.