diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin/arch_public.dot | 8 | ||||
| -rw-r--r-- | docs/admin/engines/settings.rst | 5 | ||||
| -rw-r--r-- | docs/admin/filtron.rst | 2 | ||||
| -rw-r--r-- | docs/dev/index.rst | 1 | ||||
| -rw-r--r-- | docs/dev/makefile.rst | 19 | ||||
| -rw-r--r-- | docs/dev/quickstart.rst | 5 | ||||
| -rw-r--r-- | docs/dev/reST.rst | 2 | ||||
| -rw-r--r-- | docs/dev/searxng_extra/index.rst | 15 | ||||
| -rw-r--r-- | docs/dev/searxng_extra/standalone_searx.py.rst (renamed from docs/searxng_extra/standalone_searx.py.rst) | 0 | ||||
| -rw-r--r-- | docs/dev/searxng_extra/update.rst | 88 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/searxng_extra/index.rst | 14 |
12 files changed, 131 insertions, 29 deletions
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 2d8288ddd..71e841774 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 @@ -81,6 +81,9 @@ Global Settings ``contact_url``: Contact ``mailto:`` address or WEB form. +``enable_metrics``: + Enabled by default. Record various anonymous metrics availabled at ``/stats``, + ``/stats/errors`` and ``/preferences``. .. _settings global server: diff --git a/docs/admin/filtron.rst b/docs/admin/filtron.rst index 9587d76cb..f08149ae9 100644 --- a/docs/admin/filtron.rst +++ b/docs/admin/filtron.rst @@ -23,7 +23,7 @@ it is advised to limit the number of requests processed by SearXNG. An application firewall, filtron_ solves exactly this problem. Filtron is just a middleware between your web server (nginx, apache, ...) and searx, we describe -such infratructures in chapter: :ref:`architecture`. +such infrastructures in chapter: :ref:`architecture`. filtron & go 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/makefile.rst b/docs/dev/makefile.rst index 66def0b3a..8c9058c34 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -13,7 +13,7 @@ Makefile To install system requirements follow :ref:`buildhosts`. -All relevant build tasks are implemented in :origin:`manage.sh` and for CI or +All relevant build tasks are implemented in :origin:`manage` and for CI or IDE integration a small ``Makefile`` wrapper is available. If you are not familiar with Makefiles, we recommend to read gnu-make_ introduction. @@ -173,14 +173,19 @@ Install latest Node.js_ LTS locally (uses nvm_):: To get up a running a developer instance simply call ``make run``. This enables *debug* option in :origin:`searx/settings.yml`, starts a ``./searx/webapp.py`` -instance, disables *debug* option again and opens the URL in your favorite WEB -browser (:man:`xdg-open`):: +instance and opens the URL in your favorite WEB browser (:man:`xdg-open`):: $ make run - PYENV OK - SEARXNG_DEBUG=1 ./manage.sh pyenv.cmd python ./searx/webapp.py - ... - INFO:werkzeug: * Running on http://127.0.0.1:8888/ (Press CTRL+C to quit) + +Changes to theme's HTML templates (jinja2) are instant. Changes to the CSS & JS +sources of the theme need to be rebuild. You can do that by running:: + + $ make themes.all + +Alternatively to ``themes.all`` you can run *live builds* of the theme you are +modify:: + + $ LIVE_THEME=simple make run .. _make clean: diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst index d2b666c09..db52a2d80 100644 --- a/docs/dev/quickstart.rst +++ b/docs/dev/quickstart.rst @@ -40,10 +40,15 @@ JavaScript: Alternatively you can also compile selective the theme you have modified, e.g. the *simple* theme. + .. code:: sh make themes.simple +.. tip:: + + To get live builds while modifying CSS & JS use: ``LIVE_THEME=simple make run`` + If you finished your *tests* you can start to commit your changes. To separate the modified source code from the build products first run: 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/docs/dev/searxng_extra/index.rst b/docs/dev/searxng_extra/index.rst new file mode 100644 index 000000000..c2b5c312b --- /dev/null +++ b/docs/dev/searxng_extra/index.rst @@ -0,0 +1,15 @@ +.. _searxng_extra: + +============================= +Tooling box ``searxng_extra`` +============================= + +In the folder :origin:`searxng_extra/` we maintain some tools useful for CI and +developers. + +.. toctree:: + :maxdepth: 2 + :caption: Contents + + update + standalone_searx.py diff --git a/docs/searxng_extra/standalone_searx.py.rst b/docs/dev/searxng_extra/standalone_searx.py.rst index 7cbbccfde..7cbbccfde 100644 --- a/docs/searxng_extra/standalone_searx.py.rst +++ b/docs/dev/searxng_extra/standalone_searx.py.rst diff --git a/docs/dev/searxng_extra/update.rst b/docs/dev/searxng_extra/update.rst new file mode 100644 index 000000000..d05c81409 --- /dev/null +++ b/docs/dev/searxng_extra/update.rst @@ -0,0 +1,88 @@ +========================= +``searxng_extra/update/`` +========================= + +:origin:`[source] <searxng_extra/update/__init__.py>` + +Scripts to update static data in :origin:`searx/data/` + +.. _update_ahmia_blacklist.py: + +``update_ahmia_blacklist.py`` +============================= + +:origin:`[source] <searxng_extra/update/update_ahmia_blacklist.py>` + +.. automodule:: searxng_extra.update.update_ahmia_blacklist + :members: + + +``update_currencies.py`` +======================== + +:origin:`[source] <searxng_extra/update/update_currencies.py>` + +.. automodule:: searxng_extra.update.update_currencies + :members: + +``update_engine_descriptions.py`` +================================= + +:origin:`[source] <searxng_extra/update/update_engine_descriptions.py>` + +.. automodule:: searxng_extra.update.update_engine_descriptions + :members: + + +``update_external_bangs.py`` +============================ + +:origin:`[source] <searxng_extra/update/update_external_bangs.py>` + +.. automodule:: searxng_extra.update.update_external_bangs + :members: + + +``update_firefox_version.py`` +============================= + +:origin:`[source] <searxng_extra/update/update_firefox_version.py>` + +.. automodule:: searxng_extra.update.update_firefox_version + :members: + + +``update_languages.py`` +======================= + +:origin:`[source] <searxng_extra/update/update_languages.py>` + +.. automodule:: searxng_extra.update.update_languages + :members: + + +``update_osm_keys_tags.py`` +=========================== + +:origin:`[source] <searxng_extra/update/update_osm_keys_tags.py>` + +.. automodule:: searxng_extra.update.update_osm_keys_tags + :members: + + +``update_pygments.py`` +====================== + +:origin:`[source] <searxng_extra/update/update_pygments.py>` + +.. automodule:: searxng_extra.update.update_pygments + :members: + + +``update_wikidata_units.py`` +============================ + +:origin:`[source] <searxng_extra/update/update_wikidata_units.py>` + +.. automodule:: searxng_extra.update.update_wikidata_units + :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 |