summaryrefslogtreecommitdiff
path: root/docs/admin/index.rst
AgeCommit message (Collapse)Author
2025-07-04[mod] container: replace uWSGI with Granian (#4820)Ivan Gabaldon
* [mod] container: replace uWSGI with Granian The configuration in Granian is handled with ENVs, much more convenient and practical for updating. The settings have been tested for over two months in a production instance, being usable on small to somewhat large instances without having to modify anything. It also removes the patch functions and ENVs abstraction from the entrypoint, this makes it possible to run the container with immutable configuration. In some setups, It may be desired to have the volumes/files under a specific uid/gid (other than searxng:searxng), if the entrypoint has root permissions it will chown automatically on every start, which may not be desired. Explicitly setting the new ENV `FORCE_OWNERSHIP=false` will prevent ownership from being modified. No manual migration is necessary **unless** the user has changed the default uWSGI configuration or has a very specific setup. Closes https://github.com/searxng/searxng/issues/4894 Closes https://github.com/searxng/searxng/issues/4818 Closes https://github.com/searxng/searxng/issues/4802 Supersedes https://github.com/searxng/searxng/pull/4596 Related https://github.com/searxng/searxng/discussions/4479 * [mod] docs: add container/granian All container documentation has been recreated. A new documentation page has been created for Granian. * [enh] misc: apply suggestions Minor documentation changes. Suggested https://github.com/searxng/searxng/pull/4820#discussion_r2134539259 Suggested https://github.com/searxng/searxng/pull/4820#discussion_r2134538610 Suggested https://github.com/searxng/searxng/pull/4820#discussion_r2134827964 Suggested https://github.com/searxng/searxng/pull/4820#discussion_r2134544300 Suggested https://github.com/searxng/searxng/pull/4820#discussion_r2149387388 --------- Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Co-authored-by: Ivan Gabaldon <igabaldon@inetol.net> Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
2024-10-05[doc] documentation of the favicons infrastructureMarkus Heiser
Run ``make docs.live`` and visit http://0.0.0.0:8000/admin/searx.favicons.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-11-01[mod] isolation of botdetection from the limiterMarkus Heiser
This patch was inspired by the discussion around PR-2882 [2]. The goals of this patch are: 1. Convert plugin searx.plugin.limiter to normal code [1] 2. isolation of botdetection from the limiter [2] 3. searx/{tools => botdetection}/config.py and drop searx.tools 4. in URL /config, 'limiter.enabled' is true only if the limiter is really enabled (Redis is available). This patch moves all the code that belongs to botdetection into namespace searx.botdetection and code that belongs to limiter is placed in namespace searx.limiter. Tthe limiter used to be a plugin at some point botdetection was added, it was not a plugin. The modularization of these two components was long overdue. With the clear modularization, the documentation could then also be organized according to the architecture. [1] https://github.com/searxng/searxng/pull/2882 [2] https://github.com/searxng/searxng/pull/2882#issuecomment-1741716891 To test: - check the app works without the limiter, check `/config` - check the app works with the limiter and with the token, check `/config` - make docs.live .. and read - http://0.0.0.0:8000/admin/searx.limiter.html - http://0.0.0.0:8000/src/searx.botdetection.html#botdetection Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-09-23[doc] move dosc of botdetection from developer to admin sectionMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-07-01[doc] rearranges Settings & Engines docs for better readabilityMarkus Heiser
We have built up detailed documentation of the *settings* and the *engines* over the past few years. However, this documentation was still spread over various chapters and was difficult to navigate in its entirety. This patch rearranges the Settings & Engines documentation for better readability. To review new ordered docs:: make docs.clean docs.live Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-05-22[doc] answer CAPTCHA from server's IPMarkus Heiser
Related: https://github.com/searxng/searxng/issues/2011#issuecomment-1553317619 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-30[docs] add section "Migrate and stay tuned!"Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-30[doc] update documentation of the installation proceduresMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-01-17[docs] Switch from searx to SearXNGMarkus Heiser
Closes: https://github.com/searxng/searxng/issues/450 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-11-18[brand] SearXNG - docs rename links and fix documentationMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] move 'settings.yml' into admin's 'Engines & Settings'Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-06-04[docs] reorder chapter "Engines & Settings"Markus Heiser
- Split chapter "Engines" and rename it into "Engines & Settings" - Move docs/admin/engines.rst -> docs/admin/engines/engine_settings.rst Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-03-02docs: generic documentation from the installation scriptsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-04docs: revision of the installation instructionsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-30docs(admin): moved settings description from wiki to docsMarkus Heiser
Move wiki entry https://github.com/asciimoo/searx/wiki/settings.yml into admin section of the docs (#1785). Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-28docs(admin): add article 'Buildhosts' with system requirementsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22doc: add plugin section to admin section (template)Markus Heiser
- Plugins configured at built time (defaults) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22doc: add 'Architecture' article to admin sectionMarkus Heiser
Herein we add some hints and suggestions about typical architectures of searx infrastructures. We start with a contribution from @dalf - https://github.com/asciimoo/searx/pull/1776#issuecomment-567917320 thanks @dalf !! Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-21doc: add reST templating // incl. generic engine tabeMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12doc: moved reST sources in the right folder (much clearer)Markus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>