diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin/buildhosts.rst | 6 | ||||
| -rw-r--r-- | docs/admin/engines/index.rst | 7 | ||||
| -rw-r--r-- | docs/admin/installation-docker.rst | 2 | ||||
| -rw-r--r-- | docs/admin/installation-scripts.rst | 4 | ||||
| -rw-r--r-- | docs/admin/installation.rst | 2 | ||||
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/dev/reST.rst | 2 | ||||
| -rw-r--r-- | docs/donate.rst | 2 | ||||
| -rw-r--r-- | docs/index.rst | 34 | ||||
| -rw-r--r-- | docs/own-instance.rst | 13 | ||||
| -rw-r--r-- | docs/user/about.rst | 4 | ||||
| -rw-r--r-- | docs/user/configured_engines.rst (renamed from docs/admin/engines/configured_engines.rst) | 0 | ||||
| -rw-r--r-- | docs/user/index.rst | 10 | ||||
| -rw-r--r-- | docs/user/search-syntax.rst | 4 |
14 files changed, 64 insertions, 28 deletions
diff --git a/docs/admin/buildhosts.rst b/docs/admin/buildhosts.rst index 6926469ef..d4d5ecb91 100644 --- a/docs/admin/buildhosts.rst +++ b/docs/admin/buildhosts.rst @@ -14,7 +14,7 @@ Buildhosts :local: :backlinks: entry -To get best results from build, its recommend to install additional packages +To get best results from build, it's recommend to install additional packages on build hosts (see :ref:`searxng.sh`).:: sudo -H ./utils/searxng.sh install buildhost @@ -51,7 +51,7 @@ Build docs Most of the sphinx requirements are installed from :origin:`setup.py` and the docs can be build from scratch with ``make docs.html``. For better math and image processing additional packages are needed. The XeTeX_ needed not only for -PDF creation, its also needed for :ref:`math` when HTML output is build. +PDF creation, it's also needed for :ref:`math` when HTML output is build. To be able to do :ref:`sphinx:math-support` without CDNs, the math are rendered as images (``sphinx.ext.imgmath`` extension). @@ -128,7 +128,7 @@ Lint shell scripts .. _ShellCheck: https://github.com/koalaman/shellcheck -To lint shell scripts, we use ShellCheck_ - A shell script static analysis tool. +To lint shell scripts, we use ShellCheck_ - a shell script static analysis tool. .. SNIP sh lint requirements diff --git a/docs/admin/engines/index.rst b/docs/admin/engines/index.rst index f488731ea..92c723817 100644 --- a/docs/admin/engines/index.rst +++ b/docs/admin/engines/index.rst @@ -10,10 +10,13 @@ Engines & Settings - :ref:`engine settings` & :ref:`engine file` .. toctree:: - :maxdepth: 1 + :maxdepth: 3 settings - configured_engines + +.. toctree:: + :maxdepth: 1 + private-engines recoll sql-engines diff --git a/docs/admin/installation-docker.rst b/docs/admin/installation-docker.rst index 1457d6a6b..eb52c5828 100644 --- a/docs/admin/installation-docker.rst +++ b/docs/admin/installation-docker.rst @@ -123,7 +123,7 @@ stoped. To get rid of a container use ``container rm``: This might remove all docker items, not only those from SearXNG. -If you won't use docker anymore and want to get rid of all conatiners & images +If you won't use docker anymore and want to get rid of all containers & images use the following *prune* command: .. code:: sh diff --git a/docs/admin/installation-scripts.rst b/docs/admin/installation-scripts.rst index e256a2461..2d43f5e37 100644 --- a/docs/admin/installation-scripts.rst +++ b/docs/admin/installation-scripts.rst @@ -42,7 +42,7 @@ including a :ref:`uWSGI setup <architecture uWSGI>` as described in the For the installation procedure, use a *sudoer* login to run the scripts. If you install from ``root``, take into account that the scripts are creating a ``searxng`` user. In the installation procedure this new created user does - need read access to the cloned SearXNG repository, which is not the case if you clone + need to have read access to the cloned SearXNG repository, which is not the case if you clone it into a folder below ``/root``! .. sidebar:: further read @@ -52,7 +52,7 @@ including a :ref:`uWSGI setup <architecture uWSGI>` as described in the .. _caddy: https://hub.docker.com/_/caddy When all services are installed and running fine, you can add SearXNG to your -HTTP server. We do not have any preferences for the HTTP server, you can use +HTTP server. We do not have any preferences regarding the HTTP server, you can use whatever you prefer. We use caddy in our :ref:`docker image <installation docker>` and we have diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index cae51be63..54d901f76 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -12,7 +12,7 @@ Installation The :ref:`installation basic` is an excellent illustration of *how a SearXNG instance is build up* (see :ref:`architecture uWSGI`). If you do not have any -special preferences, its recommend to use the :ref:`installation docker` or the +special preferences, it's recommended to use the :ref:`installation docker` or the :ref:`installation scripts`. .. attention:: diff --git a/docs/conf.py b/docs/conf.py index 1d71b7f8a..88a9db958 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -68,7 +68,7 @@ jinja_filters = { # Let the Jinja template in configured_engines.rst access documented_modules # to automatically link documentation for modules if it exists. def setup(app): - ENGINES_DOCNAME = 'admin/engines/configured_engines' + ENGINES_DOCNAME = 'user/configured_engines' def before_read_docs(app, env, docnames): assert ENGINES_DOCNAME in docnames diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index e5d49f672..10f6531f2 100644 --- a/docs/dev/reST.rst +++ b/docs/dev/reST.rst @@ -1284,7 +1284,7 @@ install` (with SearXNG modules installed). We use this e.g. to build chapter: :ref:`configured engines`. Below the jinja directive from the :origin:`docs/admin/engines.rst` is shown: -.. literalinclude:: ../admin/engines/configured_engines.rst +.. literalinclude:: ../user/configured_engines.rst :language: reST :start-after: .. _configured engines: diff --git a/docs/donate.rst b/docs/donate.rst index b68ed807b..072243262 100644 --- a/docs/donate.rst +++ b/docs/donate.rst @@ -1,3 +1,5 @@ +.. _donate: + Donate to searxng.org ===================== diff --git a/docs/index.rst b/docs/index.rst index f331e3211..564fa7dba 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,21 +11,37 @@ SearXNG can be used over Tor for online anonymity. Get started with SearXNG by using one of the instances listed at searx.space_. If you don't trust anyone, you can set up your own, see :ref:`installation`. -.. sidebar:: Features +.. sidebar:: features - - Self hosted - - No user tracking - - No user profiling - - About 70 supported search engines - - Easy integration with any search engine - - Cookies are not used by default - - Secure, encrypted connections (HTTPS/SSL) + - :ref:`self hosted <installation>` + - :ref:`no user tracking / no profiling <SearXNG protect privacy>` + - script & cookies are optional + - secure, encrypted connections + - :ref:`about 130 search engines <configured engines>` + - `about 60 translations <https://translate.codeberg.org/projects/searxng/searxng/>`_ + - about 100 `well maintained <https://uptime.searxng.org/>`__ instances on searx.space_ + - :ref:`easy integration of search engines <demo online engine>` + - professional development: `CI <https://github.com/searxng/searxng/actions>`_, + `quality assurance <https://dev.searxng.org/>`_ & + `automated tested UI <https://dev.searxng.org/screenshots.html>`_ -.. sidebar:: info +.. sidebar:: be a part + + SearXNG is driven by an open community, come join us! You can :ref:`donate + <donate>`, but much more we appreciate contributions. Don't hesitate, no + need to be an *expert*, everyone can contribute: + + - `help to improve translations <https://translate.codeberg.org/projects/searxng/searxng/>`_ + - `discuss with the community <https://matrix.to/#/#searxng:matrix.org>`_ + - report bugs & suggestions + - ... + +.. sidebar:: the origin SearXNG development has been started in the middle of 2021 as a fork of the searx project. + .. toctree:: :maxdepth: 2 :caption: Contents diff --git a/docs/own-instance.rst b/docs/own-instance.rst index c53f28307..d1124c389 100644 --- a/docs/own-instance.rst +++ b/docs/own-instance.rst @@ -2,10 +2,15 @@ Why use a private instance? =========================== - *"Is it worth to run my own instance?"* +.. sidebar:: Is it worth to run my own instance? -\.\. is a common question among SearXNG users. Before answering this question, -see what options a SearXNG user has. + \.\. is a common question among SearXNG users. Before answering this + question, see what options a SearXNG user has. + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry Public instances are open to everyone who has access to its URL. Usually, these are operated by unknown parties (from the users' point of view). Private @@ -16,6 +21,8 @@ single user one which runs on the user's laptop. To gain more insight on how these instances work let's dive into how SearXNG protects its users. +.. _SearXNG protect privacy: + How does SearXNG protect privacy? ================================= diff --git a/docs/user/about.rst b/docs/user/about.rst new file mode 100644 index 000000000..08f1a068e --- /dev/null +++ b/docs/user/about.rst @@ -0,0 +1,4 @@ +.. _about SearXNG: + +.. include:: about.md + :parser: myst_parser.sphinx_ diff --git a/docs/admin/engines/configured_engines.rst b/docs/user/configured_engines.rst index 9507c77df..9507c77df 100644 --- a/docs/admin/engines/configured_engines.rst +++ b/docs/user/configured_engines.rst diff --git a/docs/user/index.rst b/docs/user/index.rst index af2051f01..4603b4716 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -7,9 +7,9 @@ User information :local: :backlinks: entry +.. toctree:: + :maxdepth: 2 -.. _search-syntax: - -.. include:: search-syntax.md - :parser: myst_parser.sphinx_ - + search-syntax + configured_engines + about diff --git a/docs/user/search-syntax.rst b/docs/user/search-syntax.rst new file mode 100644 index 000000000..3acddd6e3 --- /dev/null +++ b/docs/user/search-syntax.rst @@ -0,0 +1,4 @@ +.. _search-syntax: + +.. include:: search-syntax.md + :parser: myst_parser.sphinx_ |