From 76cbfbbdda526edcd106965f712c7a31511b6c6d Mon Sep 17 00:00:00 2001 From: Alexandre Flament Date: Sun, 2 Jan 2022 20:54:41 +0100 Subject: [PATCH 1/2] reference docs.searxng.org --- .config.sh | 2 +- CHANGELOG.rst | 8 ++++---- CONTRIBUTING.md | 4 ++-- README.rst | 16 ++++++++-------- docs/admin/arch_public.dot | 8 ++++---- docs/admin/engines/settings.rst | 2 +- docs/dev/reST.rst | 2 +- searx/engines/searx_engine.py | 2 +- searx/settings.yml | 2 +- searx/settings_defaults.py | 2 +- setup.py | 4 ++-- tests/robot/settings_robot.yml | 2 +- utils/lxc.sh | 2 +- utils/morty.sh | 2 +- utils/templates/etc/searxng/settings.yml | 2 +- 15 files changed, 30 insertions(+), 30 deletions(-) diff --git a/.config.sh b/.config.sh index 9a3a0bbcb..cc7663648 100644 --- a/.config.sh +++ b/.config.sh @@ -26,7 +26,7 @@ # SEARXNG_SETTINGS_PATH : /etc/searxng/settings.yml # SEARX_SRC : /usr/local/searx/searx-src # -# [1] https://searxng.github.io/searxng/admin/engines/settings.html +# [1] https://docs.searxng.org/admin/engines/settings.html # utils/filtron.sh # ---------------- diff --git a/CHANGELOG.rst b/CHANGELOG.rst index c215f225e..95b4ad0e3 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://searxng.github.io/searxng/dev/engine_overview.html#settings-yml +- ``engines.*.proxies`` - Using proxy only for specific engines ( #1827 #2319 ), see https://docs.searxng.org/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://searxng.github.io/searxng/blog/private-engines.html - - Greatly improved documentation - check it at https://searxng.github.io/searxng + - Private engines introduced - more details: https://docs.searxng.org/blog/private-engines.html + - Greatly improved documentation - check it at https://docs.searxng.org - 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://searxng.github.io/searxng +New documentation page is available: https://docs.searxng.org 0.8.0 2015.09.08 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66adfb9fc..748a7b53c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,8 @@ ## Resources in the documentation -* [Development quickstart](https://searxng.github.io/searxng/dev/contribution_guide.html) -* [Contribution guide](https://searxng.github.io/searxng/dev/contribution_guide.html) +* [Development quickstart](https://docs.searxng.org/dev/contribution_guide.html) +* [Contribution guide](https://docs.searxng.org/dev/contribution_guide.html) ## Submitting PRs diff --git a/README.rst b/README.rst index e3c384019..becf7b989 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: AGPL-3.0-or-later .. figure:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng.svg - :target: https://searxng.github.io/searxng/ + :target: https://docs.searxng.org/ :alt: SearXNG :width: 100% :align: center @@ -23,21 +23,21 @@ Otherwise jump to the user_, admin_ and developer_ handbooks you will find on our homepage_. .. _searx.space: https://searx.space -.. _user: https://searxng.github.io/searxng/user -.. _admin: https://searxng.github.io/searxng/admin -.. _developer: https://searxng.github.io/searxng/dev -.. _homepage: https://searxng.github.io/searxng +.. _user: https://docs.searxng.org/user +.. _admin: https://docs.searxng.org/user/admin +.. _developer: https://docs.searxng.org/dev +.. _homepage: https://docs.searxng.org/ .. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine .. |SearXNG logo| image:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng-wordmark.svg - :target: https://searxng.github.io/searxng + :target: https://docs.searxng.org/ :width: 5% .. |SearXNG install| image:: https://img.shields.io/badge/-install-blue - :target: https://searxng.github.io/searxng/admin/installation.html + :target: https://docs.searxng.org/admin/installation.html .. |SearXNG homepage| image:: https://img.shields.io/badge/-homepage-blue - :target: https://searxng.github.io/searxng + :target: https://docs.searxng.org/ .. |SearXNG wiki| image:: https://img.shields.io/badge/-wiki-blue :target: https://github.com/searxng/searxng/wiki diff --git a/docs/admin/arch_public.dot b/docs/admin/arch_public.dot index b838685e7..c4ee5f3c1 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://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"]; + rp [label="Reverse Proxy", href="https://docs.searxng.org/utils/filtron.sh.html#public-reverse-proxy"]; + filtron [label="Filtron", href="https://docs.searxng.org/utils/filtron.sh.html"]; + morty [label="Morty", href="https://docs.searxng.org/utils/morty.sh.html"]; static [label="Static files", href="url to configure static files"]; - uwsgi [label="uwsgi", href="https://searxng.github.io/searxng/utils/searx.sh.html"] + uwsgi [label="uwsgi", href="https://docs.searxng.org/utils/searx.sh.html"] searx1 [label="Searx #1"]; searx2 [label="Searx #2"]; searx3 [label="Searx #3"]; diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index b04de7cb3..aba83aa1d 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -46,7 +46,7 @@ Global Settings brand: issue_url: https://github.com/searxng/searxng/issues - docs_url: https://searxng/searxng.github.io/searxng + docs_url: https://docs.searxng.org public_instances: https://searx.space wiki_url: https://github.com/searxng/searxng/wiki diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index 4f17b1b2f..70d08adb5 100644 --- a/docs/dev/reST.rst +++ b/docs/dev/reST.rst @@ -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://searxng.github.io/searxng/objects.inv + $ python -m sphinx.ext.intersphinx https://docs.searxng.org/objects.inv ... Literal blocks diff --git a/searx/engines/searx_engine.py b/searx/engines/searx_engine.py index 3e9035d6f..84a8e6449 100644 --- a/searx/engines/searx_engine.py +++ b/searx/engines/searx_engine.py @@ -10,7 +10,7 @@ from searx.engines import categories as searx_categories about = { "website": 'https://github.com/searxng/searxng', "wikidata_id": 'Q17639196', - "official_api_documentation": 'https://searxng.github.io/searxng/dev/search_api.html', + "official_api_documentation": 'https://docs.searxng.org/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 3227a5a55..def43a5fc 100644 --- a/searx/settings.yml +++ b/searx/settings.yml @@ -5,7 +5,7 @@ general: brand: new_issue_url: https://github.com/searxng/searxng/issues/new - docs_url: https://searxng.github.io/searxng + docs_url: https://docs.searxng.org/ public_instances: https://searx.space wiki_url: https://github.com/searxng/searxng/wiki issue_url: https://github.com/searxng/searxng/issues diff --git a/searx/settings_defaults.py b/searx/settings_defaults.py index 9c4711bfc..853d63161 100644 --- a/searx/settings_defaults.py +++ b/searx/settings_defaults.py @@ -146,7 +146,7 @@ SCHEMA = { 'brand': { 'issue_url': SettingsValue(str, 'https://github.com/searxng/searxng/issues'), 'new_issue_url': SettingsValue(str, 'https://github.com/searxng/searxng/issues/new'), - 'docs_url': SettingsValue(str, 'https://searxng.github.io/searxng'), + 'docs_url': SettingsValue(str, 'https://docs.searxng.org'), 'public_instances': SettingsValue(str, 'https://searx.space'), 'wiki_url': SettingsValue(str, 'https://github.com/searxng/searxng/wiki'), }, diff --git a/setup.py b/setup.py index 5d46fff20..f5cee28ef 100644 --- a/setup.py +++ b/setup.py @@ -36,8 +36,8 @@ setup( 'License :: OSI Approved :: GNU Affero General Public License v3' ], keywords='metasearch searchengine search web http', - author='Adam Tauber', - author_email='asciimoo@gmail.com', + author='SearXNG dev team', + author_email='contact@searxng.org', license='GNU Affero General Public License', packages=find_packages(exclude=["tests*", "searxng_extra"]), zip_safe=False, diff --git a/tests/robot/settings_robot.yml b/tests/robot/settings_robot.yml index e0d01bb37..73e8b722d 100644 --- a/tests/robot/settings_robot.yml +++ b/tests/robot/settings_robot.yml @@ -7,7 +7,7 @@ brand: git_branch: master issue_url: https://github.com/searxng/searxng/issues new_issue_url: https://github.com/searxng/searxng/issues/new - docs_url: https://searxng.github.io/searxng + docs_url: https://docs.searxng.org public_instances: https://searx.space wiki_url: https://github.com/searxng/searxng/wiki diff --git a/utils/lxc.sh b/utils/lxc.sh index 9a79606ca..ab96a99ce 100755 --- a/utils/lxc.sh +++ b/utils/lxc.sh @@ -568,7 +568,7 @@ check_connectivity() { info_msg "Most often the connectivity is blocked by a docker installation:" info_msg "Whenever docker is started (reboot) it sets the iptables policy " info_msg "for the FORWARD chain to DROP, see:" - info_msg " https://searxng.github.io/searxng/utils/lxc.sh.html#internet-connectivity-docker" + info_msg " https://docs.searxng.org/utils/lxc.sh.html#internet-connectivity-docker" iptables-save | grep ":FORWARD" fi return $ret_val diff --git a/utils/morty.sh b/utils/morty.sh index 25263a3d4..c4e7bdf52 100755 --- a/utils/morty.sh +++ b/utils/morty.sh @@ -116,7 +116,7 @@ info_searx() { # shellcheck disable=SC1117 cat < Date: Tue, 4 Jan 2022 16:04:49 +0100 Subject: [PATCH 2/2] [fix] links in comments - https://docs.searxng.org/ fixed links from https://searxng.github.io/searxng/ to https://docs.searxng.org/ --- searx/settings.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/searx/settings.yml b/searx/settings.yml index def43a5fc..a5cc6c4c1 100644 --- a/searx/settings.yml +++ b/searx/settings.yml @@ -151,7 +151,7 @@ outgoing: # - fe80::/126 # External plugin configuration, for more details see -# https://searxng.github.io/searxng/dev/plugins.html +# https://docs.searxng.org/dev/plugins.html # # plugins: # - plugin1 @@ -618,7 +618,7 @@ engines: - name: google engine: google shortcut: go - # see https://searxng.github.io/searxng/src/searx.engines.google.html#module-searx.engines.google + # see https://docs.searxng.org/src/searx.engines.google.html#module-searx.engines.google use_mobile_ui: false # additional_tests: # android: *test_android