Merge pull request #25 from return42/brand-001

SearxNG brand

AUTHORS.rst

@@ -1,21 +1,18 @@
-Searx was created by Adam Tauber and is maintained by Adam Tauber, Noémi Ványi, @pofilo, Gaspard d'Hautefeuille and Émilien Devos.
+searxng is a fork from `searx <https://github.com/searx/searx>`_ and is
+maintained by Alexandre Flament (`@dalf <https://github.com/dalf>`_) and Markus
+Heiser (`@return42 <https://github.com/return42>`_)
 
-Major contributing authors:
+People who have submitted patches/translations, reported bugs, consulted
+features or generally made searx better:
 
-- Adam Tauber <asciimoo@gmail.com> `@asciimoo <https://github.com/asciimoo>`_
-- Matej Cotman
-- Thomas Pointhuber
-- Alexandre Flament `@dalf <https://github.com/dalf>`_
-- @Cqoicebordel
-- Noémi Ványi
-- Marc Abonce Seguin @a01200356
-- @pofilo
-- Markus Heiser @return42
-- Émilien Devos @unixfox
-- Alexandre Flament
-
-People who have submitted patches/translations, reported bugs, consulted features or
-generally made searx better:
+- Adam Tauber `@asciimoo <https://github.com/asciimoo>`_
+- Matej Cotman `@matejc <https://github.com/matejc>`_
+- Émilien Devos `@unixfox <https://github.com/unixfox>`_
+- Thomas Pointhuber `pointhi <https://github.com/pointhi>`_
+- Noémi Ványi `@kvch <https://github.com/kvch>`_
+- `@Cqoicebordel <https://github.com/Cqoicebordel>`_
+- Marc Abonce Seguin `@MarcAbonce <https://github.com/MarcAbonce>`_
+- `@pofilo <https://github.com/pofilo>`_
 
 - Laszlo Hammerl
 - Stefan Marsiske

CHANGELOG.rst

@@ -180,7 +180,7 @@ New settings.yml
 - ``ui.advanced_search`` - add preference for displaying advanced settings ( #2327 )
 - ``server.method: "POST"`` - Make default query submission method configurable ( #2130 )
 - ``server.default_http_headers`` - add default http headers ( #2295 )
-- ``engines.*.proxies`` - Using proxy only for specific engines ( #1827 #2319 ), see https://searx.github.io/searx/dev/engine_overview.html#settings-yml
+- ``engines.*.proxies`` - Using proxy only for specific engines ( #1827 #2319 ), see https://searxng.github.io/searxng/dev/engine_overview.html#settings-yml
 - ``enabled_plugins`` - Enabled plugins ( a05c660e3036ad8d02072fc6731af54c2ed6151c )
 - ``preferences.lock`` - Let admins lock user preferences ( #2270 )
 
@@ -296,8 +296,8 @@ Special thanks to `NLNet <https://nlnet.nl>`__ for sponsoring multiple features
    - Wikivoyage
    - Rubygems
  - Engine fixes (google, google images, startpage, gigablast, yacy)
- - Private engines introduced - more details: https://searx.github.io/searx/blog/private-engines.html
- - Greatly improved documentation - check it at https://searx.github.io/searx
+ - Private engines introduced - more details: https://searxng.github.io/searxng/blog/private-engines.html
+ - Greatly improved documentation - check it at https://searxng.github.io/searxng
  - Added autofocus to all search inputs
  - CSP friendly oscar theme
  - Added option to hide engine errors with `display_error_messages` engine option (true/false values, default is true)
@@ -595,7 +595,7 @@ News
 News
 ~~~~
 
-New documentation page is available: https://searx.github.io/searx
+New documentation page is available: https://searxng.github.io/searxng
 
 
 0.8.0 2015.09.08

CONTRIBUTING.md

@@ -2,8 +2,8 @@
 
 ## Resources in the documentation
 
-* [Development quickstart](https://searx.github.io/searx/dev/contribution_guide.html)
-* [Contribution guide](https://searx.github.io/searx/dev/contribution_guide.html)
+* [Development quickstart](https://searxng.github.io/searxng/dev/contribution_guide.html)
+* [Contribution guide](https://searxng.github.io/searxng/dev/contribution_guide.html)
 
 ## Submitting PRs
 

docs/admin/arch_public.dot

@@ -4,11 +4,11 @@ digraph G {
   edge [fontname="Sans"];
 
   browser [label="Browser", shape=Mdiamond];
-  rp      [label="Reverse Proxy", href="https://searx.github.io/searx/utils/filtron.sh.html#public-reverse-proxy"];
-  filtron [label="Filtron",       href="https://searx.github.io/searx/utils/filtron.sh.html"];
-  morty   [label="Morty",         href="https://searx.github.io/searx/utils/morty.sh.html"];
+  rp      [label="Reverse Proxy", href="https://searxng.github.io/searxng/utils/filtron.sh.html#public-reverse-proxy"];
+  filtron [label="Filtron",       href="https://searxng.github.io/searxng/utils/filtron.sh.html"];
+  morty   [label="Morty",         href="https://searxng.github.io/searxng/utils/morty.sh.html"];
   static  [label="Static files",  href="url to configure static files"];
-  uwsgi   [label="uwsgi",         href="https://searx.github.io/searx/utils/searx.sh.html"]
+  uwsgi   [label="uwsgi",         href="https://searxng.github.io/searxng/utils/searx.sh.html"]
   searx1  [label="Searx #1"];
   searx2  [label="Searx #2"];
   searx3  [label="Searx #3"];

docs/admin/architecture.rst

@@ -16,7 +16,7 @@ Architecture
 Herein you will find some hints and suggestions about typical architectures of
 searx infrastructures.
 
-We start with a contribution from :pull:`@dalf <1776#issuecomment-567917320>`.
+We start with a contribution from :pull-searx:`@dalf <1776#issuecomment-567917320>`.
 It shows a *reference* setup for public searx instances which can build up and
 maintained by the scripts from our :ref:`toolboxing`.
 

docs/admin/installation-searx.rst

@@ -80,7 +80,7 @@ Configuration
 To create a initial ``/etc/searx/settings.yml`` you can start with a copy of the
 file :origin:`utils/templates/etc/searx/use_default_settings.yml`.  This setup
 :ref:`use default settings <settings use_default_settings>` from
-:origin:`searx/settings.yml` and is recommended since :pull:`2291` is merged.
+:origin:`searx/settings.yml` and is recommended since :pull-searx:`2291` is merged.
 
 For a *minimal setup*, configure like shown below – replace ``searx@$(uname
 -n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit

docs/admin/installation.rst

@@ -42,7 +42,7 @@ the case if you clone into a folder below ``/root``.
 .. code:: bash
 
    $ cd ~/Downloads
-   $ git clone https://github.com/searx/searx searx
+   $ git clone https://github.com/searxng/searxng.git searx
    $ cd searx
 
 .. sidebar:: further read

docs/admin/settings.rst

@@ -43,15 +43,16 @@ Global Settings
 
    general:
        debug : False # Debug mode, only for development
-       instance_name : "searx" # displayed name
-       git_url: https://github.com/searx/searx
+       instance_name : "searxng" # displayed name
+       contact_url: False # mailto:contact@example.com
+
+   brand:
+       git_url: https://github.com/searxng/searxng
        git_branch: master
-       issue_url: https://github.com/searx/searx/issues
-       docs_url: https://searx.github.io/searx
+       issue_url: https://github.com/searxng/searxng/issues
+       docs_url: https://searxng/searxng.github.io/searxng
        public_instances: https://searx.space
-       contact_url: False # mailto:contact@example.com
-       wiki_url: https://github.com/searx/searx/wiki
-       twitter_url: https://twitter.com/Searx_engine
+       wiki_url: https://github.com/searxng/searxng/wiki
 
 ``debug`` :
   Allow a more detailed log if you run searx directly. Display *detailed* error

docs/blog/command-line-engines.rst

@@ -10,7 +10,7 @@ connecting to any networks from the same graphical user interface.
 Command line engines
 ====================
 
-In :pull:`2128` a new type of engine has been introduced called ``command``.
+In :pull-searx:`2128` a new type of engine has been introduced called ``command``.
 This engine lets administrators add engines which run arbitrary shell commands
 and show its output on the web UI of searx.
 

docs/blog/intro-offline.rst

@@ -56,7 +56,7 @@ As offline searches can return arbitrary results depending on the engine, the
 current result templates were insufficient to present such results.  Thus, a new
 template is introduced which is caplable of presenting arbitrary key value pairs
 as a table. You can check out the pull request for more details see
-:pull:`1700`.
+:pull-searx:`1700`.
 
 Next steps
 ==========

docs/blog/lxcdev-202006.rst

@@ -81,7 +81,7 @@ fork:
      .. code:: sh
 
         $ cd ~/Downloads
-        $ git clone https://github.com/searx/searx.git
+        $ git clone https://github.com/searxng/searxng.git searx
         $ cd searx
 
 The :ref:`lxc-searx.env` consists of several images, see ``export

docs/blog/private-engines.rst

@@ -12,7 +12,7 @@ would rather share engines only with their trusted friends or colleagues.
 Private engines
 ===============
 
-To solve this issue private engines were introduced in :pull:`1823`.
+To solve this issue private engines were introduced in :pull-searx:`1823`.
 A new option was added to engines named `tokens`. It expects a list
 of strings. If the user making a request presents one of the tokens
 of an engine, they can access information about the engine
@@ -29,7 +29,7 @@ Example configuration to restrict access to the Arch Linux Wiki engine:
 
 
 Unless a user has configured the right token, the engine is going
-to be hidden from him/her. It is not going to be included in the 
+to be hidden from him/her. It is not going to be included in the
 list of engines on the Preferences page and in the output of
 `/config` REST API call.
 
@@ -42,7 +42,7 @@ is not carved in stone. As providing access to such engines
 implies that the admin knows and trusts the user, we do not see
 necessary to come up with a strict process. Instead,
 we would like to add guidelines to the documentation of the feature.
- 
+
 Next steps
 ==========
 

docs/blog/python3.rst

@@ -54,7 +54,7 @@ If you found bugs
 Please open an issue on `GitHub`_.  Make sure that you mention your Python
 version in your issue, so we can investigate it properly.
 
-.. _GitHub: https://github.com/searx/searx/issues
+.. _GitHub: https://github.com/searxng/searxng/issues
 
 Acknowledgment
 ==============

docs/build-templates/searx.rst

@@ -81,7 +81,7 @@ ${fedora_build}
     .. code-block:: sh
 
        $ sudo -H -u ${SERVICE_USER} -i
-       (${SERVICE_USER})$ git clone \"https://github.com/searx/searx.git\" \"$SEARX_SRC\"
+       (${SERVICE_USER})$ git clone \"$GIT_URL\" \"$SEARX_SRC\"
 
 .. END clone searx
 

docs/conf.py

@@ -38,8 +38,9 @@ jinja_contexts = {
 extlinks = {}
 
 # upstream links
-extlinks['wiki'] = ('https://github.com/searx/searx/wiki/%s', ' ')
-extlinks['pull'] = ('https://github.com/searx/searx/pull/%s', 'PR ')
+extlinks['wiki'] = ('https://github.com/searxng/searxng/wiki/%s', ' ')
+extlinks['pull'] = ('https://github.com/searxng/searxng/pull/%s', 'PR ')
+extlinks['pull-searx'] = ('https://github.com/searx/searx/pull/%s', 'PR ')
 
 # links to custom brand
 extlinks['origin'] = (brand.GIT_URL + '/blob/' + brand.GIT_BRANCH + '/%s', 'git://')
@@ -84,7 +85,7 @@ intersphinx_mapping = {
     "sphinx" : ("https://www.sphinx-doc.org/en/master/", None),
 }
 
-issues_github_path = "searx/searx"
+issues_github_path = "searxng/searxng"
 
 # HTML -----------------------------------------------------------------
 

docs/dev/quickstart.rst

@@ -11,7 +11,7 @@ you simply by using :ref:`make <makefile>`.
 
 .. code:: sh
 
-    git clone https://github.com/searx/searx.git
+    git clone https://github.com/searxng/searxng.git searx
 
 Here is how a minimal workflow looks like:
 

docs/dev/reST.rst

@@ -288,7 +288,7 @@ content becomes smart.
    project's wiki article     :wiki:`Offline-engines`            ``:wiki:`Offline-engines```
    to docs public URL         :docs:`dev/reST.html`              ``:docs:`dev/reST.html```
    files & folders origin     :origin:`docs/dev/reST.rst`        ``:origin:`docs/dev/reST.rst```
-   pull request               :pull:`1756`                       ``:pull:`1756```
+   pull request               :pull:`4`                          ``:pull:`4```
    patch                      :patch:`af2cae6`                   ``:patch:`af2cae6```
    PyPi package               :pypi:`searx`                      ``:pypi:`searx```
    manual page man            :man:`bash`                        ``:man:`bash```
@@ -320,7 +320,7 @@ To list all anchors of the inventory (e.g. ``python``) use:
 
    $ python -m sphinx.ext.intersphinx https://docs.python.org/3/objects.inv
    ...
-   $ python -m sphinx.ext.intersphinx https://searx.github.io/searx/objects.inv
+   $ python -m sphinx.ext.intersphinx https://searxng.github.io/searxng/objects.inv
    ...
 
 Literal blocks

docs/index.rst

@@ -23,8 +23,6 @@ anyone, you can set up your own, see :ref:`installation`.
    - Easy integration with any search engine
    - Cookies are not used by default
    - Secure, encrypted connections (HTTPS/SSL)
-   - Hosted by organizations, such as *La Quadrature du Net*, which promote
-     digital rights
 
 .. toctree::
    :maxdepth: 2

searx/engines/searx_engine.py

@@ -8,9 +8,9 @@ from searx.engines import categories as searx_categories
 
 # about
 about = {
-    "website": 'https://github.com/searx/searx',
+    "website": 'https://github.com/searxng/searxng',
     "wikidata_id": 'Q17639196',
-    "official_api_documentation": 'https://searx.github.io/searx/dev/search_api.html',
+    "official_api_documentation": 'https://searxng.github.io/searxng/dev/search_api.html',
     "use_official_api": True,
     "require_api_key": False,
     "results": 'JSON',

searx/settings.yml

@@ -1,6 +1,6 @@
 general:
     debug : False # Debug mode, only for development
-    instance_name : "searx" # displayed name
+    instance_name : "searxng" # displayed name
     contact_url: False # mailto:contact@example.com
 
 brand:
@@ -89,7 +89,7 @@ outgoing: # communication with search engines
 #        - fe80::/126
 
 # External plugin configuration
-# See http://searx.github.io/searx/dev/plugins.html for more details
+# See https://searxng.github.io/searxng/dev/plugins.html for more details
 #
 # plugins:
 #   - plugin1

searx/templates/__common__/about.html

@@ -1,67 +1,66 @@
 <div{% if rtl %} dir="ltr"{% endif %}>
-  <h1>About <a href="{{ url_for('index') }}">searx</a></h1>
+  <h1>About <a href="{{ url_for('index') }}">searxng</a></h1>
 
   <p>
-    Searx is a <a href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</a>,
+    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 searx...</p>
+  <p>More about SearXNG ...</p>
 
   <ul>
-    <li><a href="https://github.com/searx/searx">github</a></li>
-    <li><a href="https://twitter.com/Searx_engine">twitter</a></li>
-    <li>IRC: #searx @ freenode (<a href="https://kiwiirc.com/client/irc.freenode.com/searx">webclient</a>)</li>
+    <li><a href="{{ brand.GIT_URL }}">github</a></li>
     <li><a href="https://www.transifex.com/projects/p/searx/">transifex</a></li>
   </ul>
 
   <hr />
 
-  <h2>Why use searx?</h2>
+  <h2>Why use it?</h2>
 
   <ul>
     <li>
-      Searx may not offer you as personalised results as Google, but it doesn't
+      SearXNG may not offer you as personalised results as Google, but it doesn't
       generate a profile about you.
     </li>
     <li>
-      Searx doesn't care about what you search for, never shares anything with a
+      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>
-      Searx is free software, the code is 100% open and you can help to make it
-      better.  See more on <a href="https://github.com/searx/searx">github</a>.
+      SearXNG is free software, the code is 100% open and you can help to make
+      it better.  See more on <a href="{{ brand.GIT_URL }}">github</a>.
     </li>
   </ul>
 
   <p>
     If you do care about privacy, want to be a conscious user, or otherwise
-    believe in digital freedom, make searx your default search engine or run it
-    on your own server
+    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>
-    Searx is a <a href="https://en.wikipedia.org/wiki/Metasearch_engine">metasearch engine</a>,
+    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 
+    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.
-    
-    Searx can be added to your browser's search bar; moreover, it can be set as
+
+    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>
-    Searx supports <a href="https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md">OpenSearch</a>.
+    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>
 
@@ -80,15 +79,14 @@
   <h2>How can I make it my own?</h2>
 
   <p>
-    Searx appreciates your concern regarding logs, so take the
-    code from the <a href="https://github.com/searx/searx">original searx project</a> and
-    run it yourself!
+    SearXNG appreciates your concern regarding logs, so take the code from
+    the <a href="{{ brand.GIT_URL }}">SearXNG project</a> and run it yourself!
   </p>
   <p>
-    Add your searx instance to this <a href="{{ brand.PUBLIC_INSTANCES }}"> list
-    of public searx 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!
+    Add your instance to this <a href="{{ 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>

tests/robot/__init__.py

@@ -20,7 +20,7 @@ def test_404(browser):
 def test_about(browser):
     browser.visit(url)
     browser.click_link_by_text('about')
-    assert browser.is_text_present('Why use searx?')
+    assert browser.is_text_present('Why use it?')
 
 
 def test_preferences(browser):

tests/unit/test_webapp.py

@@ -96,7 +96,7 @@ class ViewsTestCase(SearxTestCase):
     def test_search_empty_html(self):
         result = self.app.post('/search', data={'q': ''})
         self.assertEqual(result.status_code, 200)
-        self.assertIn(b'<span class="instance pull-left"><a href="/">searx</a></span>', result.data)
+        self.assertIn(b'<span class="instance pull-left"><a href="/">searxng</a></span>', result.data)
 
     def test_search_empty_json(self):
         result = self.app.post('/search', data={'q': '', 'format': 'json'})
@@ -186,7 +186,7 @@ class ViewsTestCase(SearxTestCase):
     def test_about(self):
         result = self.app.get('/about')
         self.assertEqual(result.status_code, 200)
-        self.assertIn(b'<h1>About <a href="/">searx</a></h1>', result.data)
+        self.assertIn(b'<h1>About <a href="/">searxng</a></h1>', result.data)
 
     def test_preferences(self):
         result = self.app.get('/preferences')

utils/lib.sh

@@ -1630,7 +1630,7 @@ git_clone() {
     #  into <path>.  If repository is allready cloned, pull from <branch> and
     #  update working tree (if needed, the caller has to stash local changes).
     #
-    #    git clone https://github.com/searx/searx searx-src origin/master searxlogin
+    #    git clone https://github.com/searxng/searxng searx-src origin/master searxlogin
     #
 
     local url="$1"