zaclys
/
searxng
mirror of https://github.com/searxng/searxng.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

reference docs.searxng.org

This commit is contained in:
Alexandre Flament 2022-01-02 20:54:41 +01:00
parent c2e4b95e8d
commit 76cbfbbdda
15 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.config.sh
View File

@ -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
# ----------------

8
CHANGELOG.rst
View File

@ -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 <https://nlnet.nl>`__ 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

4
CONTRIBUTING.md
View File

@ -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

16
README.rst
View File

@ -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

8
docs/admin/arch_public.dot
View File

@ -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"];

2
docs/admin/engines/settings.rst
View File

@ -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

2
docs/dev/reST.rst
View File

@ -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

2
searx/engines/searx_engine.py
View File

@ -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',

2
searx/settings.yml
View File

@ -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

2
searx/settings_defaults.py
View File

@ -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'),
},

4
setup.py
View File

@ -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,

2
tests/robot/settings_robot.yml
View File

@ -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

2
utils/lxc.sh
View File

@ -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

2
utils/morty.sh
View File

@ -116,7 +116,7 @@ info_searx() {
# shellcheck disable=SC1117
cat <<EOF
To activate result and image proxy in SearXNG read:
https://searxng.github.io/searxng/admin/morty.html
https://docs.searxng.org/admin/morty.html
Check settings in file ${SEARXNG_SETTINGS_PATH} ...
result_proxy:
url : ${PUBLIC_URL_MORTY}

2
utils/templates/etc/searxng/settings.yml
View File

@ -1,6 +1,6 @@
# SearXNG settings, before editing this file read:
#
# https://searxng.github.io/searxng/admin/engines/settings.html
# https://docs.searxng.org/admin/engines/settings.html
use_default_settings: true