Alexandre Flament
32e8c2cf09
searx.network: add "verify" option to the networks
...
Each network can define a verify option:
* false to disable certificate verification
* a path to existing certificate.
SearXNG uses SSL_CERT_FILE and SSL_CERT_DIR when they are defined
see https://www.python-httpx.org/environment_variables/#ssl_cert_file
2022-10-14 13:59:22 +00:00
Alexandre Flament
a3148e5115
Merge pull request #1814 from return42/fix-typos
...
[fix] typos / reported by @kianmeng in searx PR-3366
2022-09-28 09:22:02 +02:00
Markus Heiser
ba8959ad7c
[fix] typos / reported by @kianmeng in searx PR-3366
...
[PR-3366] https://github.com/searx/searx/pull/3366
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-09-27 18:32:14 +02:00
Markus Heiser
52023e3d6e
[fix] doc of the paper.html template (isbn, issn)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-09-25 15:46:29 +02:00
Markus Heiser
f08165f524
[docs] add description of the field 'type' from paper.html template
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-09-24 10:56:07 +02:00
Alexandre Flament
d6446be38f
[mod] science category: various update of about PR 1705
2022-09-23 20:52:55 +02:00
Markus Heiser
08b8859705
[doc] paper.html result template
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-09-23 20:45:58 +02:00
Markus Heiser
ad8ffd222c
[mod] option 'ui: cache_url:' to configure internet cache or archive
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-09-04 09:42:20 +02:00
Markus Heiser
8df1f0c47e
[mod] add 'Accept-Language' HTTP header to online processores
...
Most engines that support languages (and regions) use the Accept-Language from
the WEB browser to build a response that fits to the language (and region).
- add new engine option: send_accept_language_header
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-08-01 17:01:59 +02:00
Markus Heiser
48968bf46a
[doc] list of changes that affect the infrastructure
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-31 13:08:06 +02:00
Markus Heiser
bded8750d5
[mod] fix minor leftovers from PR #1332
...
Related: https://github.com/searxng/searxng/pull/1332
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-30 16:13:47 +02:00
Léon Tiekötter
e5323b8aa2
[docs] corrections from @tiekoetter's review
2022-07-30 13:39:35 +02:00
Markus Heiser
6fbffe9d20
[docs] add section "Migrate and stay tuned!"
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-30 13:39:35 +02:00
Markus Heiser
ed8a169029
[doc] update documentation of the installation procedures
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-30 13:39:35 +02:00
Markus Heiser
782f73540e
[utils/searxng.sh] implement new script to install SearXNG
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-30 13:39:35 +02:00
Markus Heiser
81bba44869
[install scripts] rename SEARX_<name> variables to SEARXNG_<name>
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-30 13:39:35 +02:00
Markus Heiser
5795c1971f
[fix] update documentation of Search-API (/dev)
...
This patch fixes a leftover from [#1548 ], the list of the plugins was not
up-to-date:
- HTTPS_rewrite has been removed (247c46c6b
)
- DOAI_rewrite is named 'Open_Access_DOI_rewrite' (575159b
)
[#1548 ] https://github.com/searxng/searxng/pull/1548
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-25 17:22:31 +02:00
Markus Heiser
eb85474920
[fix] update documentation of the Search-API (/dev)
...
Closes: https://github.com/searxng/searxng/issues/1541
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-24 20:15:03 +02:00
Solirs
6d646129c3
[mod] add tor_check plugin - convenient tor checking trough searxng
2022-07-19 07:34:54 +02:00
Brock Vojković
84e2a3bd3f
Add infinite scroll as a setting in settings.yml
2022-07-09 17:33:25 +00:00
Alexandre Flament
df837d8b1b
Merge pull request #1428 from return42/fix-center_aligment
...
fix typo and document preference 'center_alignment' in the 'ui' section
2022-07-07 09:43:12 +02:00
Markus Heiser
d3226b3df5
[fix] Sphinx 5.x: will warn about missleading extlink definitions
...
This patch fixes the WARNING messages that pops up since Sphinx 5.x:
WARNING: extlinks: Sphinx-6.0 will require a caption string to contain
exactly one '%s' and all other '%' need to be escaped as '%%'.
[1] https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-05 17:10:19 +02:00
Markus Heiser
eb5bea16ff
[fix] sphinx 5.x: add `nav.contents` everywhere that `div.topic` is used
...
Previously, docutils produced `div.topic` for the contents directive, the latest
version produces `nav.contents`. This means that those tables of contents
change appearance when switching to docutils 0.18 [1][2].
[1] https://github.com/sphinx-doc/sphinx/pull/10535/commits/5806f0a
[2] https://github.com/sphinx-doc/sphinx/issues/10534
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-05 17:05:06 +02:00
Markus Heiser
d8de994e0f
[docs] document preference 'center_alignment' in the 'ui' section.
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-03 17:58:40 +02:00
Markus Heiser
faf56d4f96
[docs] add documentation about the `general.donation_url:` setting
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-02 13:50:06 +02:00
Alexandre Flament
8c7235d5db
Update docs/donate.rst
...
Co-authored-by: Émilien Devos <contact@emiliendevos.be>
2022-06-29 21:02:46 +02:00
Alexandre FLAMENT
0e503c990a
Move donation page to docs.searxng.org and link to it from instances
...
Close #1378
2022-06-29 17:26:19 +00:00
Markus Heiser
b224761a1b
[doc] intersphinx: fix https://python-babel.github.io/flask-babel
...
The URL https://flask-babel.tkte.ch/ is no longer valid [1].
[1] https://github.com/python-babel/flask-babel/commit/0847cc6284
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-06-22 09:22:21 +02:00
samsaptidev
31005595c9
Add privacypolicy_url option
2022-06-16 11:56:24 +02:00
Markus Heiser
ef4239c68a
[doc] fix some leftovers from ad964562c
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-06-14 16:31:41 +02:00
Markus Heiser
08876df7c2
[mod] collection of redis functions and lua scripts (initial)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-05-30 11:10:30 +02:00
Markus Heiser
e8541b6006
[theme] peel out oscar from SearXNG development
...
This is the first step of removing oscar theme
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-04-30 13:20:27 +02:00
Markus Heiser
44dd5a9615
[docs] document the missing server:limiter setting
...
BTW: fix some minor typos in docs/admin/engines/settings.rst
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-04-22 12:48:12 +02:00
Markus Heiser
9215281232
[mod] replace Markdown parser mistletoe by markdown-it-py
...
There are several reasons why we should prefer markdown-it-py over mistletoe:
- Get identical rendering results in SearXNG's `/info` pages and the SearXNG's
project documentation which is build by Sphinx-doc.
In the Sphinx-doc we use the MyST parser to render Markdown and the MyST
parser itself is built on top of the markdown-it-py package.
- markdown-it-py has a typographer that supports *replacements*
and *smartquotes* (e.g. em-dash, copyright, ellipsis, ...) [1]
- markdown-it-py is much more flexible compared to mistletoe [2]
- markdown-it-py is the fastest CommonMark compliant parser in python [3]
[1] https://markdown-it-py.readthedocs.io/en/latest/using.html#typographic-components
[2] https://markdown-it-py.readthedocs.io/en/latest/plugins.html
[3] https://markdown-it-py.readthedocs.io/en/latest/other.html#performance
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-04-06 15:49:50 +02:00
Alexandre Flament
dec04c0ed6
Merge pull request #999 from return42/fix-doc-settings2
...
[docs] document settings.yml: search.languages
2022-03-26 17:09:07 +01:00
Alexandre Flament
1ee5cfb01c
Merge pull request #1000 from return42/fix-703
...
[fix] add sphinx-notfound-page
2022-03-26 13:42:44 +01:00
Markus Heiser
a521d4985a
[docs] document settings.yml: search.languages
...
Requested-by: @dalf https://github.com/searxng/searxng/pull/996#discussion_r830858139
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-26 13:32:42 +01:00
Markus Heiser
37493b0a1e
[doc] add some documentation about the limiter plugin (and redis)
...
Requested-by: https://github.com/searxng/searxng/discussions/993#discussioncomment-2396914
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-25 11:26:10 +01:00
Markus Heiser
24f53276c1
[doc] add sphinx-notfound-page
...
Closes: https://github.com/searxng/searxng/issues/703
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-22 21:18:17 +01:00
Markus Heiser
32a35b4654
[docs] improve settings.yml documentation (admin/engines/settings)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-21 08:48:06 +01:00
Markus Heiser
3201aa1b3f
Merge pull request #859 from return42/fix-814
...
[mod] add i18n infrastructure for SearXNG message files (searxng.msg)
2022-03-20 08:31:07 +01:00
Alexandre Flament
bb19c7eccf
Sphinx doc: rename "User documentation" to "User Information"
2022-03-16 22:26:36 +01:00
Markus Heiser
b9cf3c82a1
[mod] add i18n infrastructure for SearXNG message files (searxng.msg)
...
With this patch ``searxng.msg`` files can be added to SearXNG. In
``searxng.msg`` files messages can be defined which are not captured by babel's
gettext, like the generic names of the categories or messages that are stored in
constants.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-16 09:55:53 +01:00
Markus Heiser
8751940169
[interim fix] of sphinx-tabs and sphinx-jinja
...
The myst-parser requires >= docutils v.0.17 what ends in a dependency hell where
plugins sphinx-tabs and sphinx-jinja we use are involved.
This patch can be reverted when [2], [3], [4] are solved and new release is
available / see [1].
[1] https://github.com/searxng/searxng/pull/954
[2] https://github.com/executablebooks/sphinx-tabs/issues/152
[3] https://github.com/executablebooks/sphinx-tabs/pull/153
[4] https://github.com/executablebooks/sphinx-tabs/pull/154
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-12 14:25:34 +01:00
Markus Heiser
b1912607ae
[mod] replace /help by /info pages and include pages in project docs
...
This patch implements a bolierplate to share content from info-pages of the
SearXNG instance (URL /info) with the project documentation (path /docs/user).
The info pages are using Markdown (CommonMark), to include them in the project
documentation (reST) the myst-parser [1] is used in the Sphinx-doc build chain.
If base_url is known (defined in settings.yml) links to the instance are also
inserted into the project documentation::
searxng_extra/docs_prebuild
[1] https://www.sphinx-doc.org/en/master/usage/markdown.html
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-03-12 11:36:31 +01:00
Martin Fischer
bb71ebc394
[docs] move own-instance.rst out of docs/user
2022-03-07 08:29:00 +01:00
Markus Heiser
24e2acf88e
Merge pull request #839 from dalf/docs_searx_utils
...
[mod] add documentation about searx.utils
2022-02-04 21:28:27 +00:00
Alexandre Flament
f79b0fce06
[enh] limiter plugin
...
can replace filtron:
* rate limite the number of request per IP and per (IP, User-Agent)
* block some bots
use Redis
data stored in Redis never contains the IP addresses, only HMAC using the secret_key
Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
2022-02-02 09:15:59 +01:00
Alexandre Flament
0eacc46ee3
[mod] add documentation about searx.utils
...
This module is a toolbox for the engines.
Is should be documented.
In addition, searx/utils.py is checked by pylint.
2022-01-29 22:49:42 +01:00
Markus Heiser
b7f74fbe42
[mod] tineye - add some documentation
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-28 09:06:44 +01:00