From 47a595213427d89bbd4984a8eac168fe024cf173 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Sun, 2 May 2021 10:15:39 +1200 Subject: [PATCH] Add WSL instructions to the README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 257af76..3f452f6 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,21 @@ cargo install age-plugin-yubikey Help from new packagers is very welcome. +### Windows Subsystem for Linux (WSL) + +WSL does not currently provide native support for USB devices. However, Windows +binaries installed on the host can be run from inside a WSL environment. This +means that you can encrypt or decrypt files inside a WSL environment with a +YubiKey: + +1. Install `age-plugin-yubikey` on the Windows host. +2. Install an age client inside the WSL environment. +3. Ensure that `age-plugin-yubikey.exe` is available in the WSL environment's + `PATH`. For default WSL setups, the Windows host's `PATH` is automatically + added to the WSL environment's `PATH` (see + [this Microsoft blog post](https://devblogs.microsoft.com/commandline/share-environment-vars-between-wsl-and-windows/) + for more details). + ## Configuration There are two ways to configure a YubiKey as an `age` identity. You can run the