diff options
author | Markus Heiser <markus.heiser@darmarit.de> | 2021-11-18 18:27:26 +0100 |
---|---|---|
committer | Markus Heiser <markus.heiser@darmarit.de> | 2021-11-18 18:27:26 +0100 |
commit | 1dae0c0be09d5c9e287bdea6aa5bf7ec4f4782ec (patch) | |
tree | 979a544e2853918f8a887480abe940e6880ae84c /docs/dev | |
parent | 27bb55ab0729fe0531440362f6aa5eb1142e42fb (diff) | |
download | searxng-1dae0c0be09d5c9e287bdea6aa5bf7ec4f4782ec.tar.gz searxng-1dae0c0be09d5c9e287bdea6aa5bf7ec4f4782ec.zip |
[brand] SearXNG - docs rename links and fix documentation
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev')
-rw-r--r-- | docs/dev/lxcdev.rst | 10 | ||||
-rw-r--r-- | docs/dev/quickstart.rst | 2 | ||||
-rw-r--r-- | docs/dev/search_api.rst | 4 |
3 files changed, 8 insertions, 8 deletions
diff --git a/docs/dev/lxcdev.rst b/docs/dev/lxcdev.rst index e13667c0b..597f99925 100644 --- a/docs/dev/lxcdev.rst +++ b/docs/dev/lxcdev.rst @@ -88,8 +88,8 @@ fork: .. code:: sh $ cd ~/Downloads - $ git clone https://github.com/searxng/searxng.git searx - $ cd searx + $ git clone https://github.com/searxng/searxng.git searxng + $ cd searxng The :ref:`lxc-searx.env` consists of several images, see ``export LXC_SUITE=(...`` near by :origin:`utils/lxc-searx.env#L19`. For this blog post @@ -180,7 +180,7 @@ searx-archlinux``: $ sudo -H ./utils/lxc.sh cmd searx-archlinux bash INFO: [searx-archlinux] bash [root@searx-archlinux searx]# pwd - /share/searx + /share/searxng The prompt ``[root@searx-archlinux ...]`` signals, that you are the root user in the searx-container. To debug the running SearXNG instance use: @@ -213,7 +213,7 @@ To debug services from filtron and morty analogous use: Another point we have to notice is that each service (:ref:`SearXNG <searx.sh>`, :ref:`filtron <filtron.sh>` and :ref:`morty <morty.sh>`) runs under dedicated -system user account with the same name (compare :ref:`create searx user`). To +system user account with the same name (compare :ref:`create searxng user`). To get a shell from theses accounts, simply call one of the scripts: .. tabs:: @@ -267,7 +267,7 @@ suite. For this, we have to keep an eye on the :ref:`installation basic`: - SearXNG software in: ``/usr/local/searx/searx-src`` With the use of the :ref:`searx.sh` the SearXNG service was installed as -:ref:`uWSGI application <searx uwsgi>`. To maintain this service, we can use +:ref:`uWSGI application <searxng uwsgi>`. To maintain this service, we can use ``systemctl`` (compare :ref:`service architectures on distributions <uwsgi configuration>`). diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst index 7e4ce8b68..d2b666c09 100644 --- a/docs/dev/quickstart.rst +++ b/docs/dev/quickstart.rst @@ -12,7 +12,7 @@ you simply by using :ref:`make <makefile>`. .. code:: sh - git clone https://github.com/searxng/searxng.git searx + git clone https://github.com/searxng/searxng.git searxng Here is how a minimal workflow looks like: diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst index 552b0ff84..ce7237677 100644 --- a/docs/dev/search_api.rst +++ b/docs/dev/search_api.rst @@ -25,7 +25,7 @@ Parameters ``q`` : required The search query. This string is passed to external search services. Thus, SearXNG supports syntax of each search service. For example, ``site:github.com - searx`` is a valid query for Google. However, if simply the query above is + SearXNG`` is a valid query for Google. However, if simply the query above is passed to any search engine which does not filter its results based on this syntax, you might not get the results you wanted. @@ -62,7 +62,7 @@ Parameters ``image_proxy`` : default ``False`` [ ``True``, ``False`` ] - Proxy image results through searx. + Proxy image results through SearXNG. ``autocomplete`` : default *empty* [ ``google``, ``dbpedia``, ``duckduckgo``, ``startpage``, ``wikipedia`` ] |