Added instructions on how to configure Rust on MSYS2; updated earlier instructions up to that point

Author: tieneupin

src/murfey/templates/bootstrap.html

@@ -1,17 +1,21 @@
 {% extends "base.html" %} {% block title %}Bootstrapping instructions{% endblock
 %} {% block content %}
 <h1>Bootstrapping instructions</h1>
-<h2>Installing a Linux Environment</h2>
-<h3>Installing Cygwin</h3>
+<h2>1. Setting Up a POSIX Environment</h2>
+<h3>Option 1: Installing Cygwin</h3>
 <p>
-  If you already have a Cygwin install that you would like to preserve, rename
-  it so that it doesn't get overwritten (something like "cygwin64-old").
+  Cygwin is a lightweight POSIX environment that provides the minimum
+  requirements needed for a Windows client PC to efficiently transfer files to a
+  Unix storage server. However, it currently does not support building and
+  installing packages which have been written in Rust, which many modern Python
+  packages, including Murfey's dependencies, now make use of. Nevertheless,
+  older versions of Murfey will still work with it.
 </p>
 <p>
-  Download the Cygwin setup executable using this
+  To install, download the Cygwin setup executable using this
   <a href="{{ proxy_path }}/cygwin/setup-x86_64.exe">mirror</a>, and then run
   the following from a terminal (both Command Prompt and Windows Powershell
-  work)
+  work):
 </p>
 <pre style="font-family: monospace">
     $ setup-x86_64.exe -O -R C:\cygwin64 -s {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/cygwin -P curl,python3,rsync -q
@@ -21,38 +25,43 @@ <h3>Installing Cygwin</h3>
   Cygwin install command will occasionally hang after completion. In such an
   event, just hit Enter to return to a normal command prompt window.
 </p>
+<p>
+  If you already have a Cygwin install that you would like to preserve, rename
+  it so that it doesn't get overwritten (something like "cygwin64-old") before
+  running the command line above.
+</p>
 
-<h3>Installing MSYS2</h3>
+<h3>Option 2: Installing MSYS2</h3>
 <p>
-  MSYS2 is a lightweight Linux environment which provides compiler support for
+  MSYS2 is a lightweight POSIX environment which provides compiler support for
   the more modern programming languages used by Murfey's package dependencies.
 </p>
 <p>
-  The Murfey server supports the forwarding of download requests to client PCs
-  that cannot access the wider internet. Download the MSYS2 setup executable
+  The Murfey server supports the forwarding of download requests to
+  network-restricted client PCs. To install MSYS2, download the setup executable
   using this
-  <a href="{{ proxy_path }}/msys2/distrib/msys2-x86_64-latest.exe">mirror</a>,
-  and run the executable using the default settings. This will install it to
+  <a href="{{ proxy_path }}/msys2/repo/distrib/msys2-x86_64-latest.exe"
+    >mirror</a
+  >, then run it using the default settings. This will install MSYS2 to
   C:\msys64.
 </p>
+<h4>A. Setting Up the Package Manager (If Network-Restricted)</h4>
 <p>
   By default, MSYS2 comes with preset lists of mirrors and servers that it
-  installs its packages from. These will need to be disabled, and replaced with
-  URLs of the same format that point to the Murfey server the client PC is
-  connected to.
+  installs its packages from. On a network-restricted PC, these will need to be
+  replaced with files that point to the Murfey server instead. They can be
+  downloaded via this
+  <a href="{{ proxy_path }}/msys2/config/pacman.d.zip">link</a>.
 </p>
 <p>
-  These lists can be found in the following folder, if the default installation
-  options were chosen:
+  Once downloaded, extract the files to
+  <span style="font-family: monospace">%MSYS64%\etc\pacman.d</span>. If MSYS2
+  was installed at the default location, this will be:
 </p>
 <pre style="font-family: monospace">
-    C:\msys64\etc\pacman.d\mirrorlist.{environment}
-</pre>
-<p>This is an example of how the URL to the Murfey server should look like:</p>
-<pre style="font-family: monospace">
-    Server = https://repo.msys2.org/mingw/x86_64/  # Original URL
-    Server = {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/msys2/mingw/x86_64/  # Murfey URL
+    C:\msys64\etc\pacman.d
 </pre>
+<h4>B. Installing Dependencies</h4>
 <p>
   MSYS2 comes with multiple environments, but UCRT64 is the most modern one. In
   order for the Murfey client to be able to install and run its dependencies
@@ -70,12 +79,44 @@ <h3>Installing MSYS2</h3>
   <span style="font-family: monospace">vim</span> can also be installed by
   running
   <span style="font-family: monospace">pacman -S &lt;package-name&gt;</span>.
-  You can browse the other packages supported by
-  <span style="font-family: monospace">pacman</span> by searching the repo using
+  You can browse the other packages available on MSYS2 by searching the repo
+  using
   <span style="font-family: monospace">pacman -Ss &lt;package-name&gt;</span>
 </p>
+<h4>C. Configuring the Rust Package Manager (If Network-Restricted)</h4>
+<p>
+  Many newer Python packages now have dependencies written in Rust that allow
+  them to operate more efficiently. MSYS2 supports the compilation and
+  installation of such packages, and is thus our recommended POSIX environment
+  to use Murfey with.
+</p>
+<p>
+  Rust packages and their associated metadata are, by default, stored in
+  <span style="font-family: monospace">https://crates.io</span>. Package
+  download and installation is in turn conducted by the package manager
+  <span style="font-family: monospace">cargo</span>. For network-restricted
+  client PCs, Murfey also supports mirroring
+  <span style="font-family: monospace">https://crates.io</span> to facilitate
+  the installation of Rust packages.
+</p>
+<p>
+  To configure <span style="font-family: monospace">cargo</span>, simply
+  download the pre-configured
+  <span style="font-family: monospace">config.toml</span> file via this
+  <a href="{{ proxy_path }}/rust/cargo/config.toml">link</a>. This file should
+  then be pasted in a <span style="font-family: monospace">.cargo</span> folder,
+  which, by default, shold be located in your User Profile homespace:
+</p>
+<pre style="font-family: monospace">%USERPROFILE%\.cargo</pre>
+<p>For a user named Murfey, for example, this would take the form:</p>
+<pre style="font-family: monospace">C:\Users\Murfey\.cargo</pre>
+<p>
+  With this file configured,
+  <span style="font-family: monospace">cargo</span> will know to look for
+  package metadata and files via the Murfey mirror instead.
+</p>
 
-<h2>Setting Up Python</h2>
+<h2>2. Setting Up Python</h2>
 <p>
   Once Python and pip are installed in the terminal, you have the option to
   install Murfey in either the base environment or a virtual environment. The