mirror of
https://expo.survex.com/repositories/expoweb/.git/
synced 2024-12-18 14:32:23 +00:00
199 lines
14 KiB
HTML
199 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>CUCC Expedition Handbook: Windows expo laptop</title>
|
|
<link rel="stylesheet" type="text/css" href="/css/main2.css" />
|
|
</head>
|
|
<body>
|
|
<style>body { background: #fff url(/images/style/bg-system.png) repeat-x 0 0 }</style>
|
|
<h2 id="tophead">CUCC Expedition Handbook - Computers/WSL</h2>
|
|
|
|
<h1>WSL on a Windows laptop</h1>
|
|
|
|
<p>First read the generic instructions for all the software installations you will need:
|
|
<br>
|
|
<a href="basiclaptop.html">Setting up a basic Expo laptop</a>
|
|
<br>
|
|
<a href="surveylaptop.html">Setting up a Survey machine for cave survey production</a>
|
|
<br>
|
|
<a href="bulkupdatelaptop.html">Setting up a machine for expo bulk data rearrangements</a>
|
|
<br>
|
|
<a href="winlaptop.html">Setting up a Windows machine for expo bulk data rearrangements</a>
|
|
</p>
|
|
This is how to <a href="https://www.theregister.com/2022/11/23/wsl_microsoft_store_default_version/">
|
|
install and use WSL</a> and by default we use Ubuntu24.04. We assume that you have a relatively recent machine. If not, see the bottom of this page about WSL1, which is different and old.
|
|
|
|
<p>You will be doing all your work in the
|
|
<var>\\wsl.localhost\Ubuntu\home\username\expo\</var>filesystem, not in <var>C:/Users/username/expo</var> not even if you have mounted it as <var>/mnt/c/username/expo</var>. If you try that you will hit file permissions problems and it will also be quite slow (but see WSL1 below).
|
|
|
|
|
|
<h4>WSL - Creating another ssh key</h4>
|
|
|
|
<p>If you have PuTTY installed and working, but you now want to use WSL rsync, you need to set up a key again within the WSL environment.
|
|
<p>[ Now that Microsoft allows installation of OpenSSL using <a href="">standard Windows tools</a> on Windows 10 and 11, we need someone to revise all the Windows/troggle documentation for a PuTty-free route. Volunteers? ]
|
|
|
|
<p> So on a machine with WSL enabled, click on "Ubuntu" in the start menu system under "Apps"
|
|
<br />
|
|
which puts you into the WSL environment with a new command prompt, e.g.<br />
|
|
<span style="font-family:monospace; size=x-small; background-color: lightgray">
|
|
<span style="color: green">
|
|
username@machinename</span><span style="color: yellow">:~</span>$
|
|
</span>
|
|
where 'username' is your logged-in user name.
|
|
<p>and now you can setup keys in the same way as you would on a Linux machine using ssh-keygen:
|
|
<pre>
|
|
<tt>$ <b>ssh-keygen -C "username@machinename-wsl"</b>
|
|
Generating public/private rsa key pair.
|
|
Enter file in which to save the key (/home/username/.ssh/id_rsa): <b>id_rsa_wsl</b>
|
|
Enter passphrase (empty for no passphrase):
|
|
Enter same passphrase again:
|
|
Your identification has been saved in <em>id_rsa_wsl</em>.
|
|
Your public key has been saved in <em>id_rsa_wsl.pub</em>.
|
|
The key fingerprint is:
|
|
SHA256:ySs0YD5IG2ZD50+riUDHWosNq+WJdqpkDlINXh709r0 philip@muscogee-wsl
|
|
The key's randomart image is:
|
|
+---[RSA 2048]----+
|
|
| . o |
|
|
| ..+ . |
|
|
| oB+* + |
|
|
|.=O%.* + o |
|
|
|.+*o= = S . |
|
|
|.* o = . . . |
|
|
|=++.o . . E |
|
|
|B o . |
|
|
|oo |
|
|
+----[SHA256]-----+
|
|
$
|
|
</tt>
|
|
</pre>
|
|
The generated key is in the current directory and you need to move them to ~/.ssh/ as is standard on Linux (which is not at all the same place that puTTY uses to keep keys on Windows).
|
|
<p>Now you have to complete the <a href="keyexchange.html">key-pair setup</a> with the new key "id_ras_wsl.pub". But you don't need anyone else's help this time as you can use puTTY to ssh into the server and copy your key to the right place yourself: it is a <a href="keyexchange.html#secondmachine">"Second Machine"</a>.
|
|
<p>
|
|
Now finally you can use all the usual command line tools at your wsl command line to communicate with the server with ssh, scp, rsync, such as:
|
|
<pre>
|
|
<tt>rsync -nazv --delete-after --prune-empty-dirs expo@expo.survex.com:expofiles/ expofiles</tt></pre>
|
|
|
|
<p>If you are disturbed by the instructions to produce an entirely different SSL key for WSL to use when your PC already has a perfectly good PuTTy key installed on the server, then you are right. It is inelegant. But it works, the instructions are shorter and there are fewer things that go wrong. If you are terribly offended by that then you can set your PC up to use one key shared between WSL and normal-Windows as described in <a href="https://devblogs.microsoft.com/commandline/sharing-ssh-keys-between-windows-and-wsl-2/">this October 2019 article</a>. (Don't set up a password on the key because then you don't need to install keychain.) But beware, this sort of thing goes out of date quite rapidly.
|
|
|
|
<h3 id="pain">Python on WSL</h3>
|
|
<p>WSL installs python by default, but it may be a rather old python (depending on the history of your laptop, phase of moon etc.) and if you want development speed you want python3.13. [NB check what version of python is running on the server. It was 3.11.2 in December 2024.].
|
|
|
|
<p>We used to have lengthy instructions fo installing python using "deadsnakes" but since December 2024 we just use the <var>uv</var> utility for everything, see <a href="troglaptop.html">⚒ troggle development machine</a>
|
|
<!--
|
|
<p>To install python3.11 and pip follow <a href="https://www.linuxcapable.com/how-to-install-python-3-11-on-ubuntu-linux/">these instructions</a> to the letter. But that's not enough, you need to configure pip to work properly with python3.11 (this is because it's a bit bleeding edge as yet), so you ALSO then need to re-install the latest with:
|
|
</p>
|
|
<code><pre>
|
|
curl -sS https://bootstrap.pypa.io/get-pip.py | python3.11
|
|
|
|
and test the result using:
|
|
|
|
python3.11 -m pip --version
|
|
</pre></code>
|
|
<p>The error you are trying to get rid of when attempting to use pip looks like this:<br />
|
|
<var>ImportError: cannot import name 'html5lib' from ...</var>
|
|
-->
|
|
<h2>WSL1 Historic problems</h2>
|
|
|
|
<p>Do not use WSL1. And with WSL2, put all your development files into the <var>ext4</var> filesystem on <var>\\wsl.localhost\Ubuntu\home\username\expo\</var>. In 2024 the hassles of working with NTFS files under WSL are not worth it. If your Windows laptop can't install WSL2, install a Xubuntu dual-boot system on a separate disc partition or SD card.
|
|
|
|
<p>
|
|
<a href="https://learn.microsoft.com/en-us/windows/wsl/compare-versions?source=recommendations">WSL2 is now noticeably even slower</a> for NTFS files mounted as /mnt/c or /mnt/d, so now it is only really useable if you move all the troggle code into your Linux filespace on <var>\\wsl.localhost\Ubuntu\home</var> which means that those files will only be accesible from Linux.
|
|
|
|
<h3>WSL1 and WSL2</h3>
|
|
<p>WSL now installs as WSL2 by default, but older machines (mostly laptops) may not have the Hyper-V Virtualization hardware and may have to run WSL1.
|
|
This may be fine: the behaviour is nearly identical so far as an expo laptop is concerned, where you just want to use rsync and scp. An old 2011-era PC had
|
|
been doing troggle development happily using WSL1. However time is clearly running out for WSL1, and the file handling is now very noticably slower. If your laptop won't run WSL2 then you are advised to get rid of Windows completely and install Xubuntu as a dual boot system.
|
|
|
|
|
|
<h3>WSL2 - things to watch for</h3>
|
|
<p>On some Windows 10 laptops WSL1 fails to install properly and
|
|
<a href="https://learn.microsoft.com/en-us/windows/wsl/compare-versions?source=recommendations">you have to use WSL2</a>.
|
|
<p>You should <a href="https://learn.microsoft.com/en-us/windows/wsl/wsl-config#wslconf">check that the configuration files</a> do what you want.
|
|
<p>When running a full troggle development laptop (see separate <a href="../troggle/troglaptop.html">troggle documentation</a>)
|
|
you will want to use a virtual environment (python venv or uv). This barfs untidily if you have the code on NTFS, e.g. if mounted on <var>/mnt/c/</var>. You almost
|
|
certainly have to move all your code to the internal network share e.g. <var>\\wsl$\Ubuntu\home\expo\troggle\</var> which
|
|
is how it looks when you are browing from Windows.
|
|
(No, don't try to be cute and keep it on <var>/mnt/c/</var> and just put a soft link in <var>/home/expo/</var>. That doesn't work either.)
|
|
This means that the code is actually living on a Linux <var>ext4</var> filesystem hidden away on your disc where you can only see it using the
|
|
'network' method <var>\\wsl$\Ubuntu\home\expo\troggle\</var>. This means that file access is noticably faster too. You will need to make sure that your backup/archive methods access this filesystem though.
|
|
|
|
<p>NB rsync doesn't work with NTFS partitions the way that WSL1 does.
|
|
|
|
<p>Read <a href="https://code.visualstudio.com/blogs/2019/09/03/wsl2">WSL & Visual Studio Code</a> and go back and read the bits about VS Code
|
|
running remotely in the ※Windows data maintenance laptop page.
|
|
|
|
|
|
<h3>WSL1 gotchas and tips</h3>
|
|
|
|
<p><a href="https://linuxnightly.com/mount-and-access-hard-drives-in-windows-subsystem-for-linux-wsl/">WSL using files on NTFS</a>
|
|
unfortunately introduces a wonderful new problem of file permissions. Every file on the Windows filesystem NTFS has a set of
|
|
permissions managed by the filesystem. Every NTFS file that WSL knows about (if mounted with -o metadata) acquires a completely parallel set of file
|
|
permissions that are fundamentally different things and are never in sync in any sense. <a
|
|
href="https://devblogs.microsoft.com/commandline/chmod-chown-wsl-improvements/">All sorts of fun</a> results. The alternative is to store all your data
|
|
in the \\wsl$\ ext4 filesystem (WSL2 only, not WSL1).
|
|
|
|
|
|
|
|
<h3 id="permissions">Permissions, permissions..</h3>
|
|
<p>Having happily used WSL1 for a couple of years since 2020, it was a rude awakening to try this with a new laptop with a small
|
|
hard-drive, so all the expo code was re-mounted on a plugged-in SD card. The problem of permissions that seemed to be purely a WSL2 issue reappeared with
|
|
a vengence on WSL1.
|
|
<p>The recommended WSL procedure (Jan.2021) said to mount the drive using
|
|
<a href="https://devblogs.microsoft.com/commandline/chmod-chown-wsl-improvements/">a new 'metadata' setting</a>:
|
|
<pre><code>sudo umount /mnt/d
|
|
sudo mount -t drvfs D: /mnt/d -o metadata,uid=1000,gid=1000,umask=22,fmask=111</code></pre>
|
|
<p>This is probably why there is a difference between automatically-mounted drives (e.g. C:, /mnt/c) and plug-in drives:
|
|
"<em>By default, WSL will set the uid and gid to the default user with drives that are auto-mounted during instance start. If you mount manually, you will
|
|
have to set these explicitly (the default user that gets created when WSL is first installed has a uid=1000 and gid=1000).</em>"
|
|
<p>And of course you will need to arrange that this happens automatically whenever you start WSL, so you will need to set
|
|
<a href="https://help.ubuntu.com/community/Fstab"><var>/etc/fstab</var></a>, so ensure that the relevant line says:
|
|
<pre><code>D: /mnt/d drvfs metadata,uid=1000,gid=1000,umask=22,fmask=11 0 0</code></pre>
|
|
|
|
<p>See also <a href="https://docs.microsoft.com/en-us/windows/wsl/file-permissions">File Permissions for WSL</a> (Dec. 2021).
|
|
|
|
The trick is to make sure that all the files in your development folders, e.g. <var>C:\expo\</var> which contains your repos e.g. <var>C:\expo\troggle\</var> are owned in the Windows system by the default Windows user e.g. <var>MACHINENAME\philip</var> and owned in the Linux system e.g. <var>/mnt/c/expo/</var> by the default Linux user, e.g. <var>philip:philip</var> using <br><var>sudo chown -Rhv philip:philip *</var>
|
|
<br>
|
|
and then <em>reboot your machine</em> as this doesn't seem to properly take effect until you do that.
|
|
<p>
|
|
See also <a href="https://learn.microsoft.com/en-us/windows/wsl/file-permissions">WSL File Permissions</a>.
|
|
|
|
<h3 id="bold">"Are you feeling lucky, punk"</h3>
|
|
|
|
|
|
|
|
<ul>
|
|
<li>WSL: <a href="https://hackaday.com/2019/12/23/linux-fu-wsl-tricks-blur-the-windows-linux-line/"> Converting Windows paths to Linux paths and
|
|
vice-versa</a>.
|
|
|
|
<li>Even if you have the hardware, you may have to enable it in
|
|
your BIOS and install the Windows Feature to do it. Instructions <a href="https://www.omgubuntu.co.uk/how-to-install-wsl2-on-windows-10">here</a>
|
|
and <a href="https://www.windowscentral.com/how-install-wsl2-windows-10">here</a>.
|
|
|
|
|
|
<li><a href="https://www.hanselman.com/blog/CoolWSLWindowsSubsystemForLinuxTipsAndTricksYouOrIDidntKnowWerePossible.aspx">Cool WSL tricks</a> - running Windows commands from WSL environment and running Linux commands from Windows terminal.
|
|
<li><a href="https://code.visualstudio.com/blogs/2019/09/03/wsl2">deep integration</a> - Don't use gitforwindows, install the linux git client in WSL2
|
|
|
|
<li><a href="https://blog.anaisbetts.org/using-github-credentials-in-wsl2/">using-github-credentials-in-wsl2</a> - How to use gitforwindows and WSL to connect to GitHub.
|
|
|
|
</ul>
|
|
|
|
<p>When things go wrong when trying to sort this out, you may find these pages useful. I did.
|
|
<tt><a href="https://serverfault.com/questions/423075/rsync-failed-to-set-permission-operation-not-permitted">rsync - failed to set permission - operation not permitted</a></tt>
|
|
<tt><a href="https://blogs.msdn.microsoft.com/wsl/2017/04/18/file-system-improvements-to-the-windows-subsystem-for-linux/">file-system-improvements-to-the-windows-subsystem-for-linux/</a></tt>
|
|
<tt><a href="https://stackoverflow.com/questions/48328446/id-rsa-pub-file-ssh-error-invalid-format">id-rsa-pub-file-ssh-error-invalid-format</a></tt>
|
|
<tt><a href="https://stackoverflow.com/questions/42863913/key-load-public-invalid-format">key-load-public-invalid-format</a></tt>
|
|
<tt><a href="https://superuser.com/questions/1370877/ssh-error-loading-key-id-rsa-invalid-format">ssh-error-loading-key-id-rsa-invalid-format</a></tt>
|
|
<tt><a href="https://devblogs.microsoft.com/commandline/chmod-chown-wsl-improvements/">chmod-chown-wsl-improvements</a></tt>
|
|
<tt><a href="https://www.scivision.dev/mount-usb-drives-windows-subsystem-for-linux/">mount-usb-drives-windows-subsystem-for-linux</a></tt>
|
|
<tt><a href="https://man.openbsd.org/ssh">ssh command line</a></tt>
|
|
|
|
|
|
<hr />
|
|
Go back to: ※ <a href="basiclaptop.html">Basic laptop</a><br />
|
|
Go back to: ⁂ <a href="surveylaptop.html">Survey laptop</a><br />
|
|
Go back to: ☯ <a href="winlaptop.html">Windows Bulk Update laptop</a><br />
|
|
Go back to: ⚒ <a href="troglaptop.html">Troggle development laptop</a><br />
|
|
<hr /></body>
|
|
</html>
|