From 02911cb6ba740d8f299d71cabdcf8378d318e661 Mon Sep 17 00:00:00 2001
From: 4cuck <40539855+4cuck@users.noreply.github.com>
Date: Wed, 27 Sep 2023 02:28:44 +0200
Subject: [PATCH] improve readme and column names

---
 server/templates/about.html.j2     | 39 ++++++++++++++++++++----------
 server/templates/instances.html.j2 | 15 ++++++------
 2 files changed, 34 insertions(+), 20 deletions(-)

diff --git a/server/templates/about.html.j2 b/server/templates/about.html.j2
index 1b45cc9..16a3b1d 100644
--- a/server/templates/about.html.j2
+++ b/server/templates/about.html.j2
@@ -1,6 +1,6 @@
 {# SPDX-License-Identifier: AGPL-3.0-only #}
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-bs-theme="dark">
   <head>
     <meta charset="utf-8">
     <link href="/static/bootstrap.min.css" rel="stylesheet">
@@ -13,7 +13,7 @@
     <div class="container">
     <h1>Nitter instance uptime & health tracker</h1>
     <p><a href="/">Home</a></p>
-    <p>Uptime check interval: {{uptime_interval_s}}s.</p>
+    <p id="update-interval">Uptime check interval: {{uptime_interval_s}}s.</p>
     <p>Instance re-fetching interval, including RSS & version check: {{wiki_interval_s}}s.</p>
     <p>Fetched latest commit: {{latest_commit}}</p>
 
@@ -24,19 +24,32 @@
       {%- endfor %}
     </ul>
 
-    <p>The same data can also be fetched as JSON from <code>/api/v1/instances</code></p>
+    <p>
+      <h4>Table Explanations</h4>
+      <ul>
+        <li><code>Country</code> for the host country reported in the instance wiki.</li>
+        <li><code>Healthy</code> stands for hosts which are reachable and pass a content check. Known bad hosts are marked with a ❓, these instances block healthchecks.</li>
+        <li><code>Average Time</code> is the response time average over the last {{ping_avg_interval_h}} hours. This is not a network ping.</li>
+        <li><code>All Time %</code> for all time percentage of the instance being healthy.</li>
+        <li><code>RSS</code> whether the host has RSS feeds enabled.</li>
+        <li><code>Nitter Version</code> which nitter version the host reports.</li>
+        <li><code>Connectivity</code> the IP connectivity support. One of All, IPv4, IPv6</li>
+        <li><code>Points</code> is a weighted instance score based on the availability over the last 3h, 30 and 120 days, together with the version.</li>
+      </ul>
+    </p>
 
-    <p>Explanations</p>
-    <ul>
-      <li><code>Healthy</code> stands for hosts which are reachable and pass a content check. Known bad hosts are marked with a ❓, these instances block healthchecks.</li>
-      <li><code>Response Time</code> is the response time over the last {{ping_avg_interval_h}} hours. This is not a network ping.</li>
-      <li><code>Average</code> is the time average over the last {{ping_avg_interval_h}} hours.</li>
-      <li><code>RSS</code> whether the host has RSS feeds enabled.</li>
-      <li><code>Version</code> which nitter version the host reports.</li>
-      <li><code>Points</code> is a weighted instance score based on the availability over the last 3h, 30 and 120 days, together with the version.</li>
-    </ul>
+    <p>Settings for visible columns are stored locally per client.</p>
 
-    <p>Table settings are stored locally per client.</p>
+    <p id="api">
+      <h4>API</h4>
+      The same data as visible in the website/table can also be fetched as JSON from <code>/api/v1/instances</code> (<a rel="nofollow" href="/api/v1/instances">link</a>).
+      Note that the data only changes in the intervals stated <a href="#update-interval">above</a>. Thus requesting it very often will get you rate limited.
+    </p>
+    <p>
+      Please <b>do not use instances listed here for scraping(<a rel="nofollow" href="https://en.wikipedia.org/wiki/Web_scraping">?</a>) !</b>
+      Instead <a href="https://github.com/zedeus/nitter/#docker">host your own</a> nitter instance, so public instances can be used by less tech savy people and not get overrun by you. You can get help with that at the listed matrix channel.
+    </p>
+    <p>The purpose of this API is to serve services like Twiiit, Farside or people looking for indication that their RSS feed is down - but not scrapers. Scraping will bring the downfall of public instances.</p>
 
     <p><a rel="nofollow" href="https://github.com/4cuck/nitter-status">Sourcecode</a></p>
     <p>License: AGPL3</p>
diff --git a/server/templates/instances.html.j2 b/server/templates/instances.html.j2
index 5278e7e..074ab72 100644
--- a/server/templates/instances.html.j2
+++ b/server/templates/instances.html.j2
@@ -22,9 +22,9 @@
   <div class="container">
     <h1>Nitter Instance Uptime & Health</h1>
     <p><a href="/about">About</a></p>
-    <p>Please use <a rel="nofollow" href="/api/v1/instances">/api/v1/instances</a> for bots.</p>
+    <p>Please use the <a rel="nofollow" href="/about#api">API</a> for bots. Please <b>do NOT use these instances for scraping</b>, host nitter yourself.</p>
     <p>Last Updated {{last_updated}} <a rel="nofollow" href="https://time.is/UTC">UTC</a>.</p>
-    <p>You can customize the visible columns at the bottom.</p>
+    <p>Customize the visible columns <a href="#column-settings">down below</a>.</p>
     <div class="table-responsive">
       <table id="status-tbl" class="table sortable table-hover table-sm">
       <thead>
@@ -33,10 +33,10 @@
           <th data-name="country" scope="col">Country</th>
           <th scope="col">Healthy</th>
           <th scope="col">Health History</th>
-          <th data-name="average" scope="col">Average (ms)</th>
-          <th scope="col">All Healthy %</th>
+          <th data-name="average" scope="col">Average Time</th>
+          <th scope="col">All Time %</th>
           <th data-name="rss" scope="col">RSS</th>
-          <th data-name="version" scope="col">Version</th>
+          <th data-name="version" scope="col">Nitter Version</th>
           <th data-name="connectivity" scope="col">Connectivity</th>
           <th scope="col">Points</th>
           </tr>
@@ -83,7 +83,7 @@
             {%- endif -%}
           </td>
           {%- if host.recent_checks -%}
-          <td data-name="average">{{host.ping_avg}}</td>
+          <td data-name="average">{{host.ping_avg}}ms</td>
           {% endif %}
           <td>{{host.healthy_percentage_overall}}</td>
           <td data-name="rss">{% if host.rss -%} ✅ {%- else -%} ❌ {%- endif -%}</td>
@@ -125,7 +125,8 @@
       </table>
     </div>
     <noscript>Toggling table columns and sorting requires JS.</noscript>
-    <div class="form mt-2">
+    <div id="column-settings" class="form mt-2">
+      Visible Columns:
       <div class="form-check">
         <input class="form-check-input toggle-column" data-name="connectivity" type="checkbox" id="checkConnectivity">
         <label class="form-check-label" for="checkConnectivity">