Added parameters and logic to resolve original proxy path for use in documentation if HTTP request was passed to server via frontend

tieneupin · tieneupin · commit f39a6c0055a5 · 2025-04-01T15:46:58.000+01:00
diff --git a/src/murfey/server/__init__.py b/src/murfey/server/__init__.py
@@ -216,6 +216,9 @@ def respond_with_template(
         "hostname": get_hostname(),
         "microscope": get_microscope(),
         "version": murfey.__version__,
+        # Extra parameters to reconstruct URLs for forwarded requests
+        "netloc": request.url.netloc,
+        "proxy_path": "",
     }
     if parameters:
         template_parameters.update(parameters)
diff --git a/src/murfey/server/api/bootstrap.py b/src/murfey/server/api/bootstrap.py
@@ -105,8 +105,23 @@ def get_bootstrap_instructions(request: Request):
     machine with no internet access.
     """
 
+    # Constructs the netloc (hostname + port) and proxy path depending on if the
+    # request was forwarded via proxy
+    netloc = (
+        f"{request.headers['X-Forwarded-Host']}:{request.headers['X-Forwarded-Port']}"
+        if request.headers.get("X-Forwarded-Host")
+        and request.headers.get("X-Forwarded-Port")
+        else request.url.netloc
+    )
+    # Additional bit in URL path after the netloc caused by the proxy reroute
+    proxy_path = request.url.path.removesuffix(f"{bootstrap.prefix}/")
+
     return respond_with_template(
         request=request,
+        parameters={
+            "netloc": netloc,
+            "proxy_path": proxy_path,
+        },
         filename="bootstrap.html",
     )
 
diff --git a/src/murfey/templates/base.html b/src/murfey/templates/base.html
@@ -1,22 +1,24 @@
 <html>
   <head>
     <title>Murfey - {% block title %}{% endblock %}</title>
-    <link href="{{ url_for('static', path='/styles.css') }}" rel="stylesheet" />
     <link
-      href="{{ url_for('images', path='/icon_268.png') }}"
+      href="{{ proxy_path }}{{ url_for('static', path='/styles.css') }}"
+      rel="stylesheet"
+    />
+    <link
+      href="{{ proxy_path }}{{ url_for('images', path='/icon_268.png') }}"
       rel="icon"
       type="image/png"
     />
   </head>
   <body>
     <div class="topnav">
-      <a href="/">Home</a>
-      <a href="/visits">Active Visits</a>
-      <a href="/bootstrap">Installation instructions</a>
-      <a href="/pypi/fastapi">FastAPI PyPI</a>
+      <a href="{{ proxy_path }}/docs">Home</a>
+      <a href="{{ proxy_path }}/bootstrap">Installation Instructions</a>
+      <a href="{{ proxy_path }}/pypi/fastapi">FastAPI (PyPI)</a>
       <p style="text-align: right; margin: 8px 10px 0 auto">
         <img
-          src="{{ url_for('images', path='/diamond.png') }}"
+          src="{{ proxy_path }}{{ url_for('images', path='/diamond.png') }}"
           style="height: 25px"
         />
       </p>
diff --git a/src/murfey/templates/bootstrap.html b/src/murfey/templates/bootstrap.html
@@ -1,36 +1,39 @@
 {% extends "base.html" %} {% block title %}Bootstrapping instructions{% endblock
 %} {% block content %}
 <h1>Bootstrapping instructions</h1>
-<h2>Installing a Linux Terminal</h2>
+<h2>Installing a Linux Environment</h2>
 <h3>Installing Cygwin</h3>
 <p>
-  If you already have a Cygwin install, rename it so that it doesn't get
-  overwritten (something like "[install name]-old").
+  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").
 </p>
 <p>
   Download the Cygwin setup executable using this
-  <a href="/cygwin/setup-x86_64.exe">mirror</a>, and then run the following from
-  a terminal (both Command Prompt and Windows Powershell work)
+  <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)
 </p>
 <pre style="font-family: monospace">
-    $ setup-x86_64.exe -O -R C:\cygwin64 -s {{ request.url.scheme }}://{{ request.url.netloc }}/cygwin -P curl,python3,rsync -q
+    $ setup-x86_64.exe -O -R C:\cygwin64 -s {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/cygwin -P curl,python3,rsync -q
 </pre>
 <p>
-  The Cygwin install sometimes hangs even when it is finished, hit Enter to
-  return to a command prompt.
+  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.
 </p>
 
 <h3>Installing MSYS2</h3>
 <p>
   MSYS2 is a lightweight Linux environment which provides compiler support for
-  the more modern programming languages used in the backend of Murfey's package
-  dependencies.
+  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
-  using this <a href="/msys2/setup-x86_64.exe">mirror</a>, and run the
-  executable using the default settings.
+  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
+  C:\msys64.
 </p>
 <p>
   By default, MSYS2 comes with preset lists of mirrors and servers that it
@@ -48,7 +51,7 @@ <h3>Installing MSYS2</h3>
 <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 }}://{{ request.url.netloc }}/msys2/mingw/x86_64  # Murfey URL
+    Server = {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/msys2/mingw/x86_64/  # Murfey URL
 </pre>
 <p>
   MSYS2 comes with multiple environments, but UCRT64 is the most modern one. In
@@ -57,11 +60,20 @@ <h3>Installing MSYS2</h3>
   environment. This can be achieved using the following commands:
 </p>
 <pre style="font-family: monospace">
-    $ pacman -Syu --disable-download-timeout  # Downloads the package database and searches for updates
-    $ pacman -S rsync --disable-download-timeout
-    $ pacman -S mingw-w64-python-pip --disable-download-timeout
-    $ pacman -S mingw-w64-x86_64-rust --disable-download-timeout
+    $ pacman -Syu
+    $ pacman -S rsync
+    $ pacman -S mingw-w64-ucrt-x86_64-python-pip
+    $ pacman -S mingw-w64-ucrt-x86_64-rust
 </pre>
+<p>
+  Other utility packages such as
+  <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
+  <span style="font-family: monospace">pacman -Ss &lt;package-name&gt;</span>
+</p>
 
 <h2>Setting Up Python</h2>
 <p>
@@ -73,7 +85,7 @@ <h2>Setting Up Python</h2>
 <h3>Setting Up a Virtual Environment</h3>
 <p>To set up a virtual environment, run the following commands:</p>
 <pre style="font-family: monospace">
-    $ pip install virtualenv --index-url {{ request.url.scheme }}://{{ request.url.netloc }}/pypi --trusted-host {{ request.url.hostname }}
+    $ pip install virtualenv --index-url {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/pypi --trusted-host {{ netloc }}
     $ virtualenv your-env-name  # Create the virtual environment
     $ source your-env-name/bin/activate  # Activate the virtual environment
 </pre>
@@ -84,6 +96,9 @@ <h3>Installing Murfey</h3>
   commands:
 </p>
 <pre style="font-family: monospace">
-    $ pip install murfey[client] --index-url {{ request.url.scheme }}://{{ request.url.netloc }}/pypi --trusted-host {{ request.url.hostname }}
+    $ pip install murfey[client] --index-url {{ request.url.scheme }}://{{ netloc }}{{ proxy_path }}/pypi --trusted-host {{ netloc }}
+</pre>
+<pre>
+  If you wish to install the client-side dependencies needed to run Murfey via the web UI, replace <span style="font-family: monospace;">murfey[client]</span> with <span style="font-family: monospace;">murfey[client,instrument-server]</span>.
 </pre>
 {% endblock %}
