From de819bb1f5be4e5f9e26d09ab40585684f284c4a Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 29 Dec 2021 17:38:13 +0100 Subject: [docs] move searxng_extra/ stuff to the developer section. Stuff in folder searxng_extra/ is not suitable for normal users and should only be used by developers. The script searxng_extra/standalone_searx.py must not give the impression that it improves privacy. [1] [1] https://github.com/searxng/searxng/pull/651#issuecomment-1001389726 Signed-off-by: Markus Heiser --- docs/dev/index.rst | 1 + docs/dev/searxng_extra/index.rst | 14 ++++++++++++++ docs/dev/searxng_extra/standalone_searx.py.rst | 9 +++++++++ docs/index.rst | 1 - docs/searxng_extra/index.rst | 14 -------------- docs/searxng_extra/standalone_searx.py.rst | 9 --------- searxng_extra/standalone_searx.py | 9 +++++++++ 7 files changed, 33 insertions(+), 24 deletions(-) create mode 100644 docs/dev/searxng_extra/index.rst create mode 100644 docs/dev/searxng_extra/standalone_searx.py.rst delete mode 100644 docs/searxng_extra/index.rst delete mode 100644 docs/searxng_extra/standalone_searx.py.rst diff --git a/docs/dev/index.rst b/docs/dev/index.rst index 93c914bbb..39be0885c 100644 --- a/docs/dev/index.rst +++ b/docs/dev/index.rst @@ -16,3 +16,4 @@ Developer documentation lxcdev makefile reST + searxng_extra/index diff --git a/docs/dev/searxng_extra/index.rst b/docs/dev/searxng_extra/index.rst new file mode 100644 index 000000000..f38bb3154 --- /dev/null +++ b/docs/dev/searxng_extra/index.rst @@ -0,0 +1,14 @@ +.. _searxng_extra: + +====================================================== +Tooling box ``searxng_extra`` for developers and users +====================================================== + +In the folder :origin:`searxng_extra/` we maintain some tools useful for +developers. + +.. toctree:: + :maxdepth: 2 + :caption: Contents + + standalone_searx.py diff --git a/docs/dev/searxng_extra/standalone_searx.py.rst b/docs/dev/searxng_extra/standalone_searx.py.rst new file mode 100644 index 000000000..7cbbccfde --- /dev/null +++ b/docs/dev/searxng_extra/standalone_searx.py.rst @@ -0,0 +1,9 @@ + +.. _standalone_searx.py: + +===================================== +``searxng_extra/standalone_searx.py`` +===================================== + +.. automodule:: searxng_extra.standalone_searx + :members: diff --git a/docs/index.rst b/docs/index.rst index 7100d4ed1..f9800f95b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,6 @@ If you don't trust anyone, you can set up your own, see :ref:`installation`. user/index admin/index dev/index - searxng_extra/index utils/index src/index diff --git a/docs/searxng_extra/index.rst b/docs/searxng_extra/index.rst deleted file mode 100644 index a98c358f2..000000000 --- a/docs/searxng_extra/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _searxng_extra: - -====================================================== -Tooling box ``searxng_extra`` for developers and users -====================================================== - -In the folder :origin:`searxng_extra/` we maintain some tools useful for -developers and users. - -.. toctree:: - :maxdepth: 2 - :caption: Contents - - standalone_searx.py diff --git a/docs/searxng_extra/standalone_searx.py.rst b/docs/searxng_extra/standalone_searx.py.rst deleted file mode 100644 index 7cbbccfde..000000000 --- a/docs/searxng_extra/standalone_searx.py.rst +++ /dev/null @@ -1,9 +0,0 @@ - -.. _standalone_searx.py: - -===================================== -``searxng_extra/standalone_searx.py`` -===================================== - -.. automodule:: searxng_extra.standalone_searx - :members: diff --git a/searxng_extra/standalone_searx.py b/searxng_extra/standalone_searx.py index 9ac8c8af2..baf8db0b4 100755 --- a/searxng_extra/standalone_searx.py +++ b/searxng_extra/standalone_searx.py @@ -23,6 +23,14 @@ Example to use this script: $ python3 searxng_extra/standalone_searx.py rain +.. danger:: + + Be warned, using the ``standalone_searx.py`` won't give you privacy! + + On the contrary, this script behaves like a SearXNG server: your IP is + exposed and tracked by all active engines (google, bing, qwant, ... ), with + every query! + Example to run it from python: >>> import importlib @@ -62,6 +70,7 @@ Example to run it from python: }, "suggestions": [...] } + """ # pylint: disable=line-too-long import argparse -- cgit v1.2.3