diff --git a/src/murfey/templates/bootstrap.html b/src/murfey/templates/bootstrap.html index 3880e4ff1..a0375fd15 100644 --- a/src/murfey/templates/bootstrap.html +++ b/src/murfey/templates/bootstrap.html @@ -1,42 +1,11 @@ -{% extends "base.html" %} {% block title %}Bootstrapping instructions{% endblock +{% extends "base.html" %} {% block title %}Bootstrapping Instructions{% endblock %} {% block content %} -

Bootstrapping instructions

+

Bootstrapping Instructions

1. Setting Up a POSIX Environment

-

Option 1: Installing Cygwin

+

A. Installing MSYS2 (Recommended)

- 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. -

-

- To install, download the Cygwin setup executable using this - mirror, and then run - the following from a terminal (both Command Prompt and Windows Powershell - work): -

-
-    $ setup-x86_64.exe -O -R C:\cygwin64 -s {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/cygwin -P curl,python3,rsync -q
-
-

- This will install Cygwin with the minimum packages needed to run Murfey. The - Cygwin install command will occasionally hang after completion. In such an - event, just hit Enter to return to a normal command prompt window. -

-

- 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. -

- -

Option 2: Installing MSYS2

-

- MSYS2 is a lightweight POSIX environment which provides compiler support for - the more modern programming languages used by Murfey's package dependencies. + MSYS2 is a POSIX environment which provides extensive compiler support for the + more modern programming languages used by Murfey's package dependencies.

The Murfey server supports the forwarding of download requests to @@ -47,7 +16,7 @@

Option 2: Installing MSYS2

>, then run it using the default settings. This will install MSYS2 to C:\msys64.

-

A. Setting Up the Package Manager (If Network-Restricted)

+

Setting Up the MSYS2 Package Manager (If Network-Restricted)

By default, MSYS2 comes with preset lists of mirrors and servers that it installs its packages from. On a network-restricted PC, these will need to be @@ -67,7 +36,7 @@

A. Setting Up the Package Manager (If Network-Restricted)

> C:\msys64\etc\pacman.d -

B. Installing Dependencies

+

Installing Dependencies

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 @@ -100,7 +69,7 @@

B. Installing Dependencies

>pacman -Ss <package-name>

-

C. Configuring the Rust Package Manager (If Network-Restricted)

+

Configuring the Rust Package Manager (If Network-Restricted)

Many newer Python packages now have dependencies written in Rust that allow them to operate more efficiently. MSYS2 supports the compilation and @@ -140,7 +109,7 @@

C. Configuring the Rust Package Manager (If Network-Restricted)

style="font-family: Consolas, Monaco, "Lucida Console", monospace" >.cargo - folder, which, by default, shold be located in your User Profile homespace: + folder, which, by default, should be located in your User Profile homespace:

C. Configuring the Rust Package Manager (If Network-Restricted)
   instead.
 

-

D. Running MSYS2 Through Command Prompt

+

Running MSYS2 Through Command Prompt

In order to run Murfey via the terminal, MSYS2 will have to be run through - Windoww's Command Prompt terminal, as there is an ongoing bug with MSYS2's + Window's Command Prompt terminal, as there is an ongoing bug with MSYS2's pre-packaged terminal that prevents mouse interaction with interactive apps in the terminal.

@@ -187,12 +156,48 @@

D. Running MSYS2 Through Command Prompt

shortcut icon to taste.

+

B. Installing Cygwin (Legacy)

+

+ Cygwin is a lightweight POSIX environment that provides the minimum + requirements needed for a Windows client PC to run Murfey . However, it 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. It is still possible to install and run Murfey via Cygwin, but older + versions of its dependencies will have to be installed. +

+

+ To install, download the Cygwin setup executable using this + mirror, and then run + the following from a terminal (both Command Prompt and Windows Powershell + work): +

+
+    $ setup-x86_64.exe -O -R C:\cygwin64 -s {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/cygwin -P curl,python3,rsync -q
+
+

+ This will install Cygwin with the minimum packages needed to run Murfey. The + Cygwin install command will occasionally hang after completion. In such an + event, just hit Enter to return to a normal command prompt window. +

+

+ 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. +

+

2. Setting Up Python

- 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 - base environment is simpler, but uninstallation of the Python packages in the - future could potentially interfere with the base environment's functionality. + 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 base environment is + simpler, but uninstallation of the Python packages in the future could + potentially interfere with the base environment's functionality.

A. (Optional) Setting Up a Virtual Environment

To set up a virtual environment, run the following commands: