[Savannah-cvs] [786] fix typos, update, augment

[ineiev]

Revision: 786
          
http://svn.savannah.gnu.org/viewvc/?view=rev&root=administration&revision=786
Author:   ineiev
Date:     2024-05-13 08:52:04 -0400 (Mon, 13 May 2024)
Log Message:
-----------
fix typos, update, augment

Modified Paths:
--------------
    trunk/sviki/Mirroring.mdwn

Modified: trunk/sviki/Mirroring.mdwn
===================================================================
--- trunk/sviki/Mirroring.mdwn  2024-04-22 10:58:33 UTC (rev 785)
+++ trunk/sviki/Mirroring.mdwn  2024-05-13 12:52:04 UTC (rev 786)
@@ -25,7 +25,8 @@
 2. On download0.savannah.gnu.org, add the mirror URLs to
    `/srv/download/00_MIRRORS.html` (alphabetical, check
    [list online](//download-mirror.savannah.gnu.org/releases/00_MIRRORS.html))
-   and `/srv/download/00_MIRRORS.txt` (no order).
+   and `/srv/download/00_MIRRORS.txt` (no order).  Supported protocols
+   are FTP, HTTP, HTTPS, RSYNC.
 
 ## Client-side overview
 
@@ -56,9 +57,9 @@
 `download.savannah.gnu.org` serves directory listing directly, and
 only redirects actual files.  See nginx details below.
 
-## Server-side redirection overview
+##<a id='redirection'></a> Server-side redirection overview
 
-Redirection is implemented using a Perl CGI script,
+Redirection is implemented using a Perl CGI script
 called from nginx running on `download0.sv.gnu.org`.
 
 Both gnu and nongnu redirections are served from
@@ -65,7 +66,7 @@
 download0.savannah.gnu.org VM. `ftpmirror.gnu.org` is
 CNAME'd to `ftpmirror.sv.gnu.org`, which points
 to the same IP as download0 (remember Savannah admins
-only control *.sv.gnu.org DNS entries).
+only control \*.sv.gnu.org DNS entries).
 
 The nginx configuration files are:
 `download0:/etc/nginx/sites-available/ftpmirror`,
@@ -77,7 +78,7 @@
 The `*-common*.inc` files contain the CGI configurations.
 The other files include them twice (once for HTTP, once for HTTPS).
 
-The HTTPS CGI configuration for `gnu mirror` is:
+The HTTP CGI configuration for `gnu mirror` is:
 
     location / {
         gzip off;
@@ -151,17 +152,15 @@
 (Yemen [YE] uses the mirrors located in Azerbaijan [AZ], Zimbabwe [ZW] uses
 the mirrors located in South Africa [ZA].)
 
-See 'mirmon' section below to learn how these files are generated.
+See [['mirmon' section below|Mirroring#mirmon]] to learn how these files are
+generated.
 
 The Perl script 
[mirror-redirect](//git.savannah.nongnu.org/cgit/administration/savane.git/tree/backend/external/mirror-redirect.in?h=i18n)
 uses [Geo::IP](https://metacpan.org/pod/Geo::IP) module
 to detect users' regions based on their IP.
 
-## Server-side Mirmon overview
+##<a id="mirmon"> Server-side Mirmon overview
 
-NOTE: Most of this section was copied from the [[Mirmon]] page
-and updated as needed.
-
 1.  The authoritative lists of mirrors are managed manually.
     For `gnu mirror`, GNU webmasters update the lists
     (<http://www.gnu.org/prep/ftp.html>, generated from
@@ -174,13 +173,15 @@
 
     We maintain 3 separate mirmon configurations:
 
-    * `gnu` - list of HTTP-only mirrors for ftpmirror.gnu.org.
-      The `gnu` list is used later by the redirection CGI script.
-    * `allgnu` - list of HTTP, FTP, RSYNC mirrors for ftpmirror.gnu.org.
+    * `gnu` - list of HTTP(S)-only mirrors for ftpmirror.gnu.org.
+      The `gnu` list is used later to compile the list of active mirrors
+      for the redirection CGI script.
+    * `allgnu` - list of HTTP(S), FTP, RSYNC mirrors for ftpmirror.gnu.org.
       The `allgnu` list is used only by human admins to check which
       mirrors are up-to-date.
-    * `nongnu` - list of HTTP-only mirrors for download.savannah.gnu.org.
-      The `nongnu` list is used later by the redirection CGI script.
+    * `nongnu` - list of mirrors for download.savannah.gnu.org.
+     The `nongnu` list is used later to compile the list of active mirrors
+     for the redirection CGI script.
 
 3.  The mirmon input lists (of mirrors to check) are here:
 
@@ -231,7 +232,7 @@
 5.  Two auxiliary scripts
     `/opt/savannah/mirrors/scripts/update-active-mirrors-{gnu,nongnu}.sh`
     trivially invoke
-    
[sv_mirmon-to-geip](//git.savannah.nongnu.org/cgit/administration/savane.git/tree/backend/misc/sv_mirmon-to-geoip.in?h=i18n);
+    
[sv_mirmon-to-geoip](//git.savannah.nongnu.org/cgit/administration/savane.git/tree/backend/misc/sv_mirmon-to-geoip.in?h=i18n);
     that script reads the state file and the mirror list and generates simple
     text files containing the active and up-to-date mirrors and region
     redirections:
@@ -239,7 +240,8 @@
         # ls /opt/savannah/mirrors/active-mirror-lists/
         download-https.txt  download.txt  gnu-https.txt  gnu.txt
 
-    These are the four files used in the CGI scripts (see above section).
+    These are the four files used in the CGI scripts (see
+    [[above section|Mirroring#redirection]]).
 
 6.  The 3 mirmon invocations are executed as cronjobs in
     `/etc/cron.d/sv-mirmon`:
@@ -284,6 +286,31 @@
             fastcgi_pass unix:/var/run/fcgiwrap.socket;
         }
 
+    The web page accepts two optional parameters,
+
+    * *addr* overrides the detected IP address
+    * *cc* overrides the detected country code
+
+    For example,
+
+        $ wget -o /dev/null -O - \
+          'https://ftpmirror.gnu.org/mirror-check/?addr=209.51.188.113&cc=lt'
+        GNU Savannah - mirror check
+
+        Requested path: /
+        Query string:   addr=209.51.188.113&cc=lt
+
+        Detected remote address: 209.51.188.113 (overridden in query string)
+        Detected country: United States
+        Country code: lt (overridden in query string)
+        Suggested mirror: https://sunsite.icm.edu.pl/pub/gnu
+
+        All mirrors from pl:
+
+          https://ftp.task.gda.pl/pub/gnu/
+          https://ftp.man.poznan.pl/gnu/
+          https://sunsite.icm.edu.pl/pub/gnu/
+
 3.  Mirmon cronjob logs are saved in `/var/log/mirmon`.
     Current implementation saves only the most recent run.
 
@@ -306,3 +333,10 @@
         -rw-r--r-- 1 2.1K Feb 11 08:32 download.txt
         -rw-r--r-- 1 4.4K Feb 11 08:22 gnu-https.txt
         -rw-r--r-- 1 4.2K Feb 11 08:22 gnu.txt
+
+5. Redirection script statistics are available at
+  <https://download.savannah.gnu.org/dl-stats/> (for download) and
+  <https://download.savannah.gnu.org/ftp-stats/> (for ftpmirror).
+
+6. Other summaries based on latest nginx logs are available (for ftpmirror
+   only) at <https://download.savannah.gnu.org/ftpmirror-stats/>.