From c6a5cc019ae27b1892b38afd33090653d07f33be Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 25 Apr 2021 11:42:42 +0200 Subject: [PATCH 1/2] [brand] searxng is a fork from searx Signed-off-by: Markus Heiser --- AUTHORS.rst | 27 +++++++++++---------------- searx/settings.yml | 2 +- searx/templates/__common__/about.html | 25 ++++++++++++------------- tests/robot/__init__.py | 2 +- tests/unit/test_webapp.py | 4 ++-- 5 files changed, 27 insertions(+), 33 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 57834514b..f3234d809 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -1,21 +1,16 @@ -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 `_ and is +maintained by Alexandre Flament (`@dalf `_) and Markus +Heiser (`@return42 `_) -Major contributing authors: +People who have submitted patches/translations, reported bugs, consulted +features or generally made searx better: -- Adam Tauber `@asciimoo `_ -- Matej Cotman -- Thomas Pointhuber -- Alexandre Flament `@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 `_ +- Émilien Devos `@unixfox `_ +- Thomas Pointhuber `pointhi `_ +- Noémi Ványi `@kvch `_ +- `@Cqoicebordel `_ +- Marc Abonce Seguin `@MarcAbonce `_ - Laszlo Hammerl - Stefan Marsiske diff --git a/searx/settings.yml b/searx/settings.yml index 6e106a462..907f92a0f 100644 --- a/searx/settings.yml +++ b/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: diff --git a/searx/templates/__common__/about.html b/searx/templates/__common__/about.html index 649e66163..3fec8d116 100644 --- a/searx/templates/__common__/about.html +++ b/searx/templates/__common__/about.html @@ -1,24 +1,23 @@ -

About searx

+

About searxng

- Searx is a metasearch engine, + SearxNG is a fork from the well-known searx + metasearch engine, aggregating the results of other search engines while not storing information about its users.

-

More about searx...

+

More about searxng ...

-

Why use searx?

+

Why use it?

  • @@ -31,7 +30,7 @@
  • Searx is free software, the code is 100% open and you can help to make it - better. See more on github. + better. See more on github.
@@ -49,11 +48,11 @@ 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 the default search engine.

@@ -80,9 +79,9 @@

How can I make it my own?

- Searx appreciates your concern regarding logs, so take the - code from the original searx project and - run it yourself! + Searx appreciates your concern regarding logs, so take the code from + the original searx project and run it + yourself!

Add your searx instance to this list diff --git a/tests/robot/__init__.py b/tests/robot/__init__.py index 038a3196f..6e7897118 100644 --- a/tests/robot/__init__.py +++ b/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): diff --git a/tests/unit/test_webapp.py b/tests/unit/test_webapp.py index d3498f51a..9d83b7596 100644 --- a/tests/unit/test_webapp.py +++ b/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'searx', result.data) + self.assertIn(b'searxng', 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'

About searx

', result.data) + self.assertIn(b'

About searxng

', result.data) def test_preferences(self): result = self.app.get('/preferences') From 28b25185c51d320c8124292a6194e4c34fa9c3e8 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 25 Apr 2021 12:03:54 +0200 Subject: [PATCH 2/2] [brand] searxng -- fix links to issue tracker & WEB-GUI Signed-off-by: Markus Heiser --- AUTHORS.rst | 2 ++ CHANGELOG.rst | 8 +++--- CONTRIBUTING.md | 4 +-- docs/admin/arch_public.dot | 8 +++--- docs/admin/architecture.rst | 2 +- docs/admin/installation-searx.rst | 2 +- docs/admin/installation.rst | 2 +- docs/admin/settings.rst | 17 +++++++------ docs/blog/command-line-engines.rst | 2 +- docs/blog/intro-offline.rst | 2 +- docs/blog/lxcdev-202006.rst | 2 +- docs/blog/private-engines.rst | 6 ++--- docs/blog/python3.rst | 2 +- docs/build-templates/searx.rst | 2 +- docs/conf.py | 7 +++--- docs/dev/quickstart.rst | 2 +- docs/dev/reST.rst | 4 +-- docs/index.rst | 2 -- searx/engines/searx_engine.py | 4 +-- searx/settings.yml | 2 +- searx/templates/__common__/about.html | 35 +++++++++++++-------------- utils/lib.sh | 2 +- 22 files changed, 60 insertions(+), 59 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index f3234d809..0c97790e4 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -6,11 +6,13 @@ People who have submitted patches/translations, reported bugs, consulted features or generally made searx better: - Adam Tauber `@asciimoo `_ +- Matej Cotman `@matejc `_ - Émilien Devos `@unixfox `_ - Thomas Pointhuber `pointhi `_ - Noémi Ványi `@kvch `_ - `@Cqoicebordel `_ - Marc Abonce Seguin `@MarcAbonce `_ +- `@pofilo `_ - Laszlo Hammerl - Stefan Marsiske diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 90756b511..c319be8e9 100644 --- a/CHANGELOG.rst +++ b/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 `__ 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 300349f3b..66adfb9fc 100644 --- a/CONTRIBUTING.md +++ b/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 diff --git a/docs/admin/arch_public.dot b/docs/admin/arch_public.dot index 0d826078d..b838685e7 100644 --- a/docs/admin/arch_public.dot +++ b/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"]; diff --git a/docs/admin/architecture.rst b/docs/admin/architecture.rst index 464e765eb..edc518ab1 100644 --- a/docs/admin/architecture.rst +++ b/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`. diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst index adea0166f..5c9985e8b 100644 --- a/docs/admin/installation-searx.rst +++ b/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 ` 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 diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 9bb102c42..722458152 100644 --- a/docs/admin/installation.rst +++ b/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 diff --git a/docs/admin/settings.rst b/docs/admin/settings.rst index 622218279..d0773467d 100644 --- a/docs/admin/settings.rst +++ b/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 - git_branch: master - issue_url: https://github.com/searx/searx/issues - docs_url: https://searx.github.io/searx - public_instances: https://searx.space + instance_name : "searxng" # displayed name contact_url: False # mailto:contact@example.com - wiki_url: https://github.com/searx/searx/wiki - twitter_url: https://twitter.com/Searx_engine + + brand: + git_url: https://github.com/searxng/searxng + git_branch: master + issue_url: https://github.com/searxng/searxng/issues + docs_url: https://searxng/searxng.github.io/searxng + public_instances: https://searx.space + wiki_url: https://github.com/searxng/searxng/wiki ``debug`` : Allow a more detailed log if you run searx directly. Display *detailed* error diff --git a/docs/blog/command-line-engines.rst b/docs/blog/command-line-engines.rst index 746c9e4ae..09eb84fb4 100644 --- a/docs/blog/command-line-engines.rst +++ b/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. diff --git a/docs/blog/intro-offline.rst b/docs/blog/intro-offline.rst index f6e90de3a..3a706d038 100644 --- a/docs/blog/intro-offline.rst +++ b/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 ========== diff --git a/docs/blog/lxcdev-202006.rst b/docs/blog/lxcdev-202006.rst index b53501dab..24d9028c2 100644 --- a/docs/blog/lxcdev-202006.rst +++ b/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 diff --git a/docs/blog/private-engines.rst b/docs/blog/private-engines.rst index 027cc3dd3..37b1d4cc5 100644 --- a/docs/blog/private-engines.rst +++ b/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 ========== diff --git a/docs/blog/python3.rst b/docs/blog/python3.rst index 1d2cfc813..7e770c193 100644 --- a/docs/blog/python3.rst +++ b/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 ============== diff --git a/docs/build-templates/searx.rst b/docs/build-templates/searx.rst index e06bc2c6a..ead096ed8 100644 --- a/docs/build-templates/searx.rst +++ b/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 diff --git a/docs/conf.py b/docs/conf.py index e3379ec8e..998b07ff1 100644 --- a/docs/conf.py +++ b/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 ----------------------------------------------------------------- diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst index bb9f4d67c..74bb52960 100644 --- a/docs/dev/quickstart.rst +++ b/docs/dev/quickstart.rst @@ -11,7 +11,7 @@ you simply by using :ref:`make `. .. 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: diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index 1817504c6..181d9829d 100644 --- a/docs/dev/reST.rst +++ b/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 diff --git a/docs/index.rst b/docs/index.rst index 35a2e0a5f..862106ebe 100644 --- a/docs/index.rst +++ b/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 diff --git a/searx/engines/searx_engine.py b/searx/engines/searx_engine.py index c4f016adc..98ef0fb79 100644 --- a/searx/engines/searx_engine.py +++ b/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', diff --git a/searx/settings.yml b/searx/settings.yml index 907f92a0f..dda03781c 100644 --- a/searx/settings.yml +++ b/searx/settings.yml @@ -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 diff --git a/searx/templates/__common__/about.html b/searx/templates/__common__/about.html index 3fec8d116..72c7b133f 100644 --- a/searx/templates/__common__/about.html +++ b/searx/templates/__common__/about.html @@ -2,13 +2,13 @@

About searxng

- SearxNG is a fork from the well-known searx + SearXNG is a fork from the well-known searx metasearch engine, aggregating the results of other search engines while not storing information about its users.

-

More about searxng ...

+

More about SearXNG ...

  • github
    • @@ -21,29 +21,29 @@
    • - 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.
    • - 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.
    • - Searx is free software, the code is 100% open and you can help to make it - better. See more on github. + SearXNG is free software, the code is 100% open and you can help to make + it better. See more on github.

    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

    Technical details - How does it work?

    - Searx is a metasearch engine, + SearXNG is a metasearch engine, inspired by the seeks project. It provides basic privacy by mixing your queries with searches on other @@ -53,14 +53,14 @@ 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.

    How to set as the default search engine?

    - Searx supports OpenSearch. + SearXNG supports OpenSearch. For more information on changing your default search engine, see your browser's documentation:

    @@ -79,15 +79,14 @@

    How can I make it my own?

    - Searx appreciates your concern regarding logs, so take the code from - the original searx project and run it - yourself! + SearXNG appreciates your concern regarding logs, so take the code from + the SearXNG project and run it yourself!

    - Add your searx instance to this list - of public searx instances 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 list of + public instances to help other people reclaim their privacy and make the + Internet freer! The more decentralized the Internet is, the more freedom we + have!

    Where are the docs & code of this instance?

    diff --git a/utils/lib.sh b/utils/lib.sh index f2a879743..d1781a71f 100755 --- a/utils/lib.sh +++ b/utils/lib.sh @@ -1630,7 +1630,7 @@ git_clone() { # into . If repository is allready cloned, pull from 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"