From 05149db4c1e495eecaf74d267e91f61dee7ee40d Mon Sep 17 00:00:00 2001
From: Martin Fischer <martin@push-f.com>
Date: Sat, 15 Jan 2022 06:09:37 +0100
Subject: [help] render user documentation once on startup

Currently we have two kinds of user documentation:

* the about page[1] which is written in HTML and part of the web
  application and can therefore link instance-specific pages
  (like e.g. the preferences) via Jinja variables

* the Sphinx documentation[2] which is written in reStructuredText
  and cannot link instance-specific pages since it doesn't know
  which instance the user is using

The plan is to integrate the user documentation currently in Sphinx
into the application, so that it can also link instance specific pages.
We also want to enable the user documentation to be translated.

This commit implements the first step in this endeavor (see #722).

[1]: searx/templates/__common__/about.html
[2]: docs/user/ (currently served at https://docs.searxng.org/user/)
---
 searx/help/about.html | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 102 insertions(+)
 create mode 100644 searx/help/about.html

(limited to 'searx/help/about.html')

diff --git a/searx/help/about.html b/searx/help/about.html
new file mode 100644
index 000000000..5a9065f03
--- /dev/null
+++ b/searx/help/about.html
@@ -0,0 +1,102 @@
+<div{% if rtl %} dir="ltr"{% endif %}>
+  <h1>About <a href="{{ url_for('index') }}">searxng</a></h1>
+
+  <p>
+    SearXNG is a fork from the well-known <a href="https://github.com/searx/searx">searx</a>
+    <a href="https://en.wikipedia.org/wiki/Metasearch_engine"> metasearch engine</a>,
+    aggregating the results of other <a href="{{ url_for('preferences') }}">search engines</a>
+    while not storing information about its users.
+  </p>
+
+  <p>More about SearXNG ...</p>
+
+  <ul>
+    <li><a href="{{ searx_git_url }}">SearXNG sources</a></li>
+    <li><a href="https://weblate.bubu1.eu/projects/searxng/">weblate</a></li>
+  </ul>
+
+  <hr />
+
+  <h2>Why use it?</h2>
+
+  <ul>
+    <li>
+      SearXNG may not offer you as personalised results as Google, but it doesn't
+      generate a profile about you.
+    </li>
+    <li>
+      SearXNG doesn't care about what you search for, never shares anything with a
+      third party, and it can't be used to compromise you.
+    </li>
+    <li>
+      SearXNG is free software, the code is 100% open and you can help to make
+      it better.  See more on <a href="{{ searx_git_url
+      }}">SearXNG sources</a>.
+    </li>
+  </ul>
+
+  <p>
+    If you do care about privacy, want to be a conscious user, or otherwise
+    believe in digital freedom, make SearXNG your default search engine or run
+    it on your own server
+  </p>
+
+  <h2>Technical details - How does it work?</h2>
+
+  <p>
+    SearXNG is a <a href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</a>,
+    inspired by the <a href="https://beniz.github.io/seeks/">seeks project</a>.
+
+    It provides basic privacy by mixing your queries with searches on other
+    platforms without storing search data. Queries are made using a POST request
+    on every browser (except Chromium-based browsers*).  Therefore they show up
+    in neither our logs, nor your url history. In the case of Chromium-based
+    browser users there is an exception: searx uses the search bar to perform GET
+    requests.
+
+    SearXNG can be added to your browser's search bar; moreover, it can be set as
+    the default search engine.
+  </p>
+
+  <h2 id='add to browser'>How to set as the default search engine?</h2>
+
+  <p>
+    SearXNG supports <a href="https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md">OpenSearch</a>.
+    For more information on changing your default search engine, see your browser's documentation:
+  </p>
+
+  <ul>
+    <li><a href="https://support.mozilla.org/en-US/kb/add-or-remove-search-engine-firefox">Firefox</a></li>
+    <li><a href="https://support.microsoft.com/en-us/help/4028574/microsoft-edge-change-the-default-search-engine">Microsoft Edge</a></li>
+    <li>Chromium-based browsers <a href="https://www.chromium.org/tab-to-search">only add websites that the user navigates to without a path.</a>
+  </ul>
+
+  <h2>Where to find anonymous usage statistics of this instance ?</h2>
+
+  <p>
+    <a href="{{ url_for('stats') }}">Stats page</a> contains some useful data about the engines used.
+  </p>
+
+  <h2>How can I make it my own?</h2>
+
+  <p>
+    SearXNG appreciates your concern regarding logs, so take the code from
+    the <a href="{{ searx_git_url }}">SearXNG project</a> and
+    run it yourself!
+  </p>
+  <p>
+    Add your instance to this <a href="{{ get_setting('brand.public_instances') }}"> list of
+    public instances</a> to help other people reclaim their privacy and make the
+    Internet freer!  The more decentralized the Internet is, the more freedom we
+    have!
+  </p>
+
+  <h2>Where are the docs & code of this instance?</h2>
+
+  <p>
+    See the <a href="{{ get_setting('brand.docs_url') }}">SearXNG docs</a>
+    and <a href="{{ searx_git_url }}">SearXNG sources</a>
+  </p>
+
+</div>
+{% include "__common__/aboutextend.html" ignore missing %}
-- 
cgit v1.2.3