zaclys/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng synced 2024-01-01 19:24:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

[doc] switch from sphinx-tabs extension to sphinx-design

Browse source 
A sphinx extension for designing beautiful, view size responsive web components
[2].  Supports fure theme [3].

[1] https://github.com/djungelorm/sphinx-tabs
[2] https://github.com/executablebooks/sphinx-design
[3] https://sphinx-design.readthedocs.io/en/furo-theme/

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2021-12-23 10:59:44 +01:00
parent 139554989c
commit 870bf312d8
13 changed files with 152 additions and 159 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/admin/buildhosts.rst
View file

@ -75,21 +75,21 @@ If your docs build (``make docs.html``) shows warnings like this::
you need to install additional packages on your build host, to get better HTML you need to install additional packages on your build host, to get better HTML
output. output.
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code-block:: sh .. code-block:: sh
$ sudo apt install graphviz imagemagick texlive-xetex librsvg2-bin $ sudo apt install graphviz imagemagick texlive-xetex librsvg2-bin
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code-block:: sh .. code-block:: sh
$ sudo pacman -S graphviz imagemagick texlive-bin extra/librsvg $ sudo pacman -S graphviz imagemagick texlive-bin extra/librsvg
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code-block:: sh .. code-block:: sh
@ -98,21 +98,21 @@ output.
For PDF output you also need: For PDF output you also need:
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code:: sh .. code:: sh
$ sudo apt texlive-latex-recommended texlive-extra-utils ttf-dejavu $ sudo apt texlive-latex-recommended texlive-extra-utils ttf-dejavu
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code:: sh .. code:: sh
$ sudo pacman -S texlive-core texlive-latexextra ttf-dejavu $ sudo pacman -S texlive-core texlive-latexextra ttf-dejavu
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code:: sh .. code:: sh
@ -132,21 +132,21 @@ To lint shell scripts, we use ShellCheck_ - A shell script static analysis tool.
.. SNIP sh lint requirements .. SNIP sh lint requirements
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code-block:: sh .. code-block:: sh
$ sudo apt install shellcheck $ sudo apt install shellcheck
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code-block:: sh .. code-block:: sh
$ sudo pacman -S shellcheck $ sudo pacman -S shellcheck
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code-block:: sh .. code-block:: sh

54
docs/admin/installation-apache.rst
View file

@ -69,15 +69,15 @@ If Apache_ is not installed, install it now. If apache_ is new to you, the
Directives`_ documentation gives first orientation. There is also a list of Directives`_ documentation gives first orientation. There is also a list of
`Apache directives`_ *to keep in the pocket*. `Apache directives`_ *to keep in the pocket*.
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code:: sh .. code:: sh
sudo -H apt-get install apache2 sudo -H apt-get install apache2
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code:: sh .. code:: sh
@ -85,7 +85,7 @@ Directives`_ documentation gives first orientation. There is also a list of
sudo -H systemctl enable httpd sudo -H systemctl enable httpd
sudo -H systemctl start http sudo -H systemctl start http
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code:: sh .. code:: sh
@ -97,9 +97,9 @@ Now at http://localhost you should see any kind of *Welcome* or *Test* page.
How this default intro site is configured, depends on the linux distribution How this default intro site is configured, depends on the linux distribution
(compare `Apache directives`_). (compare `Apache directives`_).
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code:: sh .. code:: sh
@ -113,7 +113,7 @@ How this default intro site is configured, depends on the linux distribution
And the *welcome* page is the HTML file at ``/var/www/html/index.html``. And the *welcome* page is the HTML file at ``/var/www/html/index.html``.
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code:: sh .. code:: sh
@ -140,7 +140,7 @@ How this default intro site is configured, depends on the linux distribution
... ...
Include conf/extra/httpd-autoindex.conf Include conf/extra/httpd-autoindex.conf
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code:: sh .. code:: sh
@ -180,9 +180,9 @@ modules and create a `Location`_ configuration for the SearXNG site. In most
distributions you have to un-comment the lines in the main configuration file, distributions you have to un-comment the lines in the main configuration file,
except in :ref:`The Debian Layout`. except in :ref:`The Debian Layout`.
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
In the Apache setup, enable headers and proxy modules: In the Apache setup, enable headers and proxy modules:
@ -201,7 +201,7 @@ except in :ref:`The Debian Layout`.
sudo -H a2ensite searxng.conf sudo -H a2ensite searxng.conf
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
In the ``/etc/httpd/conf/httpd.conf`` file, activate headers and proxy In the ``/etc/httpd/conf/httpd.conf`` file, activate headers and proxy
modules (LoadModule_): modules (LoadModule_):
@ -214,7 +214,7 @@ except in :ref:`The Debian Layout`.
LoadModule proxy_module modules/mod_proxy.so LoadModule proxy_module modules/mod_proxy.so
LoadModule proxy_http_module modules/mod_proxy_http.so LoadModule proxy_http_module modules/mod_proxy_http.so
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
In the ``/etc/httpd/conf/httpd.conf`` file, activate headers and proxy In the ``/etc/httpd/conf/httpd.conf`` file, activate headers and proxy
modules (LoadModule_): modules (LoadModule_):
@ -232,9 +232,9 @@ proxied host.
.. _apache searxng via filtron plus morty: .. _apache searxng via filtron plus morty:
.. tabs:: .. tab-set::
.. group-tab:: SearXNG via filtron plus morty .. tab-item:: SearXNG via filtron plus morty
Use this setup, if your instance is public to the internet, compare Use this setup, if your instance is public to the internet, compare
figure: :ref:`architecture <arch public>` and :ref:`installation scripts`. figure: :ref:`architecture <arch public>` and :ref:`installation scripts`.
@ -307,9 +307,9 @@ filtron>`, nevertheless it is good enough for intranet usage. In modern Linux
distributions, the `mod_proxy_uwsgi`_ is compiled into the *normal* apache distributions, the `mod_proxy_uwsgi`_ is compiled into the *normal* apache
package and you need to install only the :ref:`uWSGI <searxng uwsgi>` package: package and you need to install only the :ref:`uWSGI <searxng uwsgi>` package:
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code:: sh .. code:: sh
@ -318,13 +318,13 @@ package and you need to install only the :ref:`uWSGI <searxng uwsgi>` package:
# Ubuntu =< 18.04 # Ubuntu =< 18.04
sudo -H apt-get install libapache2-mod-proxy-uwsgi sudo -H apt-get install libapache2-mod-proxy-uwsgi
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code:: sh .. code:: sh
sudo -H pacman -S uwsgi sudo -H pacman -S uwsgi
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code:: sh .. code:: sh
@ -347,9 +347,9 @@ SearXNG account (see :ref:`create searxng user`):
If the server is public; to limit access to your intranet replace ``Allow from If the server is public; to limit access to your intranet replace ``Allow from
all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class. all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class.
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code:: apache .. code:: apache
@ -373,7 +373,7 @@ all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class.
</Location> </Location>
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code:: apache .. code:: apache
@ -398,7 +398,7 @@ all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class.
</Location> </Location>
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code:: apache .. code:: apache
@ -426,7 +426,7 @@ all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class.
</IfModule> </IfModule>
.. group-tab:: old mod_wsgi .. tab-item:: old mod_wsgi
We show this only for historical reasons, DON'T USE `mod_uwsgi We show this only for historical reasons, DON'T USE `mod_uwsgi
<https://uwsgi-docs.readthedocs.io/en/latest/Apache.html#mod-uwsgi>`_. <https://uwsgi-docs.readthedocs.io/en/latest/Apache.html#mod-uwsgi>`_.
@ -461,23 +461,23 @@ all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class.
Restart service Restart service
=============== ===============
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code:: sh .. code:: sh
sudo -H systemctl restart apache2 sudo -H systemctl restart apache2
sudo -H service uwsgi restart searx sudo -H service uwsgi restart searx
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code:: sh .. code:: sh
sudo -H systemctl restart httpd sudo -H systemctl restart httpd
sudo -H systemctl restart uwsgi@searx sudo -H systemctl restart uwsgi@searx
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code:: sh .. code:: sh

40
docs/admin/installation-nginx.rst
View file

@ -55,15 +55,15 @@ The nginx HTTP server
If nginx_ is not installed (uwsgi will not work with the package nginx-light), If nginx_ is not installed (uwsgi will not work with the package nginx-light),
install it now. install it now.
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code:: sh .. code:: sh
sudo -H apt-get install nginx sudo -H apt-get install nginx
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code-block:: sh .. code-block:: sh
@ -71,7 +71,7 @@ install it now.
sudo -H systemctl enable nginx sudo -H systemctl enable nginx
sudo -H systemctl start nginx sudo -H systemctl start nginx
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code-block:: sh .. code-block:: sh
@ -84,9 +84,9 @@ see a *Fedora Webserver - Test Page*. The test page comes from the default
`nginx server configuration`_. How this default intro site is configured, `nginx server configuration`_. How this default intro site is configured,
depends on the linux distribution: depends on the linux distribution:
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code:: sh .. code:: sh
@ -98,7 +98,7 @@ depends on the linux distribution:
include /etc/nginx/sites-enabled/*; include /etc/nginx/sites-enabled/*;
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code-block:: sh .. code-block:: sh
@ -114,7 +114,7 @@ depends on the linux distribution:
# ... # ...
} }
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code-block:: sh .. code-block:: sh
@ -142,9 +142,9 @@ Now you have to create a configuration for the SearXNG site. If nginx_ is new t
you, the `nginx beginners guide`_ is a good starting point and the `Getting you, the `nginx beginners guide`_ is a good starting point and the `Getting
Started wiki`_ is always a good resource *to keep in the pocket*. Started wiki`_ is always a good resource *to keep in the pocket*.
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
Create configuration at ``/etc/nginx/sites-available/searxng`` and place a Create configuration at ``/etc/nginx/sites-available/searxng`` and place a
symlink to sites-enabled: symlink to sites-enabled:
@ -153,21 +153,21 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
sudo -H ln -s /etc/nginx/sites-available/searxng /etc/nginx/sites-enabled/searxng sudo -H ln -s /etc/nginx/sites-available/searxng /etc/nginx/sites-enabled/searxng
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
In the ``/etc/nginx/nginx.conf`` file, replace the configuration section In the ``/etc/nginx/nginx.conf`` file, replace the configuration section
named ``server``. named ``server``.
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
Create configuration at ``/etc/nginx/conf.d/searxng`` and place a Create configuration at ``/etc/nginx/conf.d/searxng`` and place a
symlink to sites-enabled: symlink to sites-enabled:
.. _nginx searxng via filtron plus morty: .. _nginx searxng via filtron plus morty:
.. tabs:: .. tab-set::
.. group-tab:: SearXNG via filtron plus morty .. tab-item:: SearXNG via filtron plus morty
Use this setup, if your instance is public to the internet, compare Use this setup, if your instance is public to the internet, compare
figure: :ref:`architecture <arch public>` and :ref:`installation scripts`. figure: :ref:`architecture <arch public>` and :ref:`installation scripts`.
@ -226,7 +226,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
image_proxy : True image_proxy : True
.. group-tab:: proxy or uWSGI .. tab-item:: proxy or uWSGI
Be warned, with this setup, your instance isn't :ref:`protected <searxng Be warned, with this setup, your instance isn't :ref:`protected <searxng
filtron>`. Nevertheless it is good enough for intranet usage and it is a filtron>`. Nevertheless it is good enough for intranet usage and it is a
@ -288,7 +288,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
mkdir -p /run/uwsgi/app/searx/ mkdir -p /run/uwsgi/app/searx/
sudo -H chown -R searx:searx /run/uwsgi/app/searx/ sudo -H chown -R searx:searx /run/uwsgi/app/searx/
.. group-tab:: \.\. at subdir URL .. tab-item:: \.\. at subdir URL
Be warned, with these setups, your instance isn't :ref:`protected <searxng Be warned, with these setups, your instance isn't :ref:`protected <searxng
filtron>`. The examples are just here to demonstrate how to export the filtron>`. The examples are just here to demonstrate how to export the
@ -344,23 +344,23 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
Restart service: Restart service:
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code:: sh .. code:: sh
sudo -H systemctl restart nginx sudo -H systemctl restart nginx
sudo -H service uwsgi restart searx sudo -H service uwsgi restart searx
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code:: sh .. code:: sh
sudo -H systemctl restart nginx sudo -H systemctl restart nginx
sudo -H systemctl restart uwsgi@searx sudo -H systemctl restart uwsgi@searx
.. group-tab:: Fedora .. tab-item:: Fedora
.. code:: sh .. code:: sh

6
docs/admin/installation-searxng.rst
View file

@ -90,14 +90,14 @@ For a *minimal setup*, configure like shown below – replace ``searx@$(uname
:start-after: START searxng config :start-after: START searxng config
:end-before: END searxng config :end-before: END searxng config
.. tabs:: .. tab-set::
.. group-tab:: Use default settings .. tab-item:: Use default settings
.. literalinclude:: ../../utils/templates/etc/searxng/settings.yml .. literalinclude:: ../../utils/templates/etc/searxng/settings.yml
:language: yaml :language: yaml
.. group-tab:: searx/settings.yml .. tab-item:: searx/settings.yml
.. literalinclude:: ../../searx/settings.yml .. literalinclude:: ../../searx/settings.yml
:language: yaml :language: yaml

24
docs/admin/installation-uwsgi.rst
View file

@ -100,50 +100,42 @@ Alltogether
Create the configuration ini-file according to your distribution (see below) and Create the configuration ini-file according to your distribution (see below) and
restart the uwsgi application. restart the uwsgi application.
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. kernel-include:: $DOCS_BUILD/includes/searx.rst .. kernel-include:: $DOCS_BUILD/includes/searx.rst
:start-after: START searxng uwsgi-description ubuntu-20.04 :start-after: START searxng uwsgi-description ubuntu-20.04
:end-before: END searxng uwsgi-description ubuntu-20.04 :end-before: END searxng uwsgi-description ubuntu-20.04
.. hotfix: a bug group-tab need this comment .. tab-item:: Arch Linux
.. group-tab:: Arch Linux
.. kernel-include:: $DOCS_BUILD/includes/searx.rst .. kernel-include:: $DOCS_BUILD/includes/searx.rst
:start-after: START searxng uwsgi-description arch :start-after: START searxng uwsgi-description arch
:end-before: END searxng uwsgi-description arch :end-before: END searxng uwsgi-description arch
.. hotfix: a bug group-tab need this comment .. tab-item:: Fedora / RHEL
.. group-tab:: Fedora / RHEL
.. kernel-include:: $DOCS_BUILD/includes/searx.rst .. kernel-include:: $DOCS_BUILD/includes/searx.rst
:start-after: START searxng uwsgi-description fedora :start-after: START searxng uwsgi-description fedora
:end-before: END searxng uwsgi-description fedora :end-before: END searxng uwsgi-description fedora
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. kernel-include:: $DOCS_BUILD/includes/searx.rst .. kernel-include:: $DOCS_BUILD/includes/searx.rst
:start-after: START searxng uwsgi-appini ubuntu-20.04 :start-after: START searxng uwsgi-appini ubuntu-20.04
:end-before: END searxng uwsgi-appini ubuntu-20.04 :end-before: END searxng uwsgi-appini ubuntu-20.04
.. hotfix: a bug group-tab need this comment .. tab-item:: Arch Linux
.. group-tab:: Arch Linux
.. kernel-include:: $DOCS_BUILD/includes/searx.rst .. kernel-include:: $DOCS_BUILD/includes/searx.rst
:start-after: START searxng uwsgi-appini arch :start-after: START searxng uwsgi-appini arch
:end-before: END searxng uwsgi-appini arch :end-before: END searxng uwsgi-appini arch
.. hotfix: a bug group-tab need this comment .. tab-item:: Fedora / RHEL
.. group-tab:: Fedora / RHEL
.. kernel-include:: $DOCS_BUILD/includes/searx.rst .. kernel-include:: $DOCS_BUILD/includes/searx.rst
:start-after: START searxng uwsgi-appini fedora :start-after: START searxng uwsgi-appini fedora

12
docs/build-templates/filtron.rst
View file

@ -1,8 +1,8 @@
.. START create user .. START create user
.. tabs:: .. tab-set::
.. group-tab:: bash .. tab-item:: bash
.. code-block:: sh .. code-block:: sh
@ -17,9 +17,9 @@
.. START install go .. START install go
.. tabs:: .. tab-set::
.. group-tab:: os: linux / arch: amd64 .. tab-item:: os: linux / arch: amd64
.. code-block:: bash .. code-block:: bash
@ -41,9 +41,9 @@
.. START install filtron .. START install filtron
.. tabs:: .. tab-set::
.. group-tab:: bash .. tab-item:: bash
.. code-block:: bash .. code-block:: bash

12
docs/build-templates/morty.rst
View file

@ -1,8 +1,8 @@
.. START create user .. START create user
.. tabs:: .. tab-set::
.. group-tab:: bash .. tab-item:: bash
.. code-block:: sh .. code-block:: sh
@ -17,9 +17,9 @@
.. START install go .. START install go
.. tabs:: .. tab-set::
.. group-tab:: os: linux / arch: amd64 .. tab-item:: os: linux / arch: amd64
.. code-block:: bash .. code-block:: bash
@ -41,9 +41,9 @@
.. START install morty .. START install morty
.. tabs:: .. tab-set::
.. group-tab:: bash .. tab-item:: bash
.. code-block:: bash .. code-block:: bash

52
docs/build-templates/searx.rst
View file

@ -3,23 +3,23 @@
.. START distro-packages .. START distro-packages
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code-block:: sh .. code-block:: sh
$ sudo -H apt-get install -y \\ $ sudo -H apt-get install -y \\
${debian} ${debian}
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code-block:: sh .. code-block:: sh
$ sudo -H pacman -S --noconfirm \\ $ sudo -H pacman -S --noconfirm \\
${arch} ${arch}
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code-block:: sh .. code-block:: sh
@ -30,23 +30,23 @@ ${fedora}
.. START build-packages .. START build-packages
.. tabs:: .. tab-set::
.. group-tab:: Ubuntu / debian .. tab-item:: Ubuntu / debian
.. code-block:: sh .. code-block:: sh
$ sudo -H apt-get install -y \\ $ sudo -H apt-get install -y \\
${debian_build} ${debian_build}
.. group-tab:: Arch Linux .. tab-item:: Arch Linux
.. code-block:: sh .. code-block:: sh
$ sudo -H pacman -S --noconfirm \\ $ sudo -H pacman -S --noconfirm \\
${arch_build} ${arch_build}
.. group-tab:: Fedora / RHEL .. tab-item:: Fedora / RHEL
.. code-block:: sh .. code-block:: sh
@ -57,9 +57,9 @@ ${fedora_build}
.. START create user .. START create user
.. tabs:: .. tab-set::
.. group-tab:: bash .. tab-item:: bash
.. code-block:: sh .. code-block:: sh
@ -74,9 +74,9 @@ ${fedora_build}
.. START clone searxng .. START clone searxng
.. tabs:: .. tab-set::
.. group-tab:: bash .. tab-item:: bash
.. code-block:: sh .. code-block:: sh
@ -87,9 +87,9 @@ ${fedora_build}
.. START create virtualenv .. START create virtualenv
.. tabs:: .. tab-set::
.. group-tab:: bash .. tab-item:: bash
.. code-block:: sh .. code-block:: sh
@ -100,9 +100,9 @@ ${fedora_build}
.. START manage.sh update_packages .. START manage.sh update_packages
.. tabs:: .. tab-set::
.. group-tab:: bash .. tab-item:: bash
.. code-block:: sh .. code-block:: sh
@ -127,9 +127,9 @@ ${fedora_build}
.. START searxng config .. START searxng config
.. tabs:: .. tab-set::
.. group-tab:: Use default settings .. tab-item:: Use default settings
.. code-block:: sh .. code-block:: sh
@ -137,7 +137,7 @@ ${fedora_build}
$ sudo -H cp \"$SEARX_SRC/utils/templates/etc/searxng/settings.yml\" \\ $ sudo -H cp \"$SEARX_SRC/utils/templates/etc/searxng/settings.yml\" \\
\"${SEARXNG_SETTINGS_PATH}\" \"${SEARXNG_SETTINGS_PATH}\"
.. group-tab:: searx/settings.yml .. tab-item:: searx/settings.yml
.. code-block:: sh .. code-block:: sh
@ -145,9 +145,9 @@ ${fedora_build}
$ sudo -H cp \"$SEARX_SRC/searx/settings.yml\" \\ $ sudo -H cp \"$SEARX_SRC/searx/settings.yml\" \\
\"${SEARXNG_SETTINGS_PATH}\" \"${SEARXNG_SETTINGS_PATH}\"
.. tabs:: .. tab-set::
.. group-tab:: minimal setup .. tab-item:: minimal setup
.. code-block:: sh .. code-block:: sh
@ -157,9 +157,9 @@ ${fedora_build}
.. START check searxng installation .. START check searxng installation
.. tabs:: .. tab-set::
.. group-tab:: bash .. tab-item:: bash
.. code-block:: sh .. code-block:: sh
@ -178,15 +178,15 @@ ${fedora_build}
Open WEB browser and visit http://$SEARX_INTERNAL_HTTP . If you are inside a Open WEB browser and visit http://$SEARX_INTERNAL_HTTP . If you are inside a
container or in a script, test with curl: container or in a script, test with curl:
.. tabs:: .. tab-set::
.. group-tab:: WEB browser .. tab-item:: WEB browser
.. code-block:: sh .. code-block:: sh
$ xdg-open http://$SEARX_INTERNAL_HTTP $ xdg-open http://$SEARX_INTERNAL_HTTP
.. group-tab:: curl .. tab-item:: curl
.. code-block:: none .. code-block:: none

2
docs/conf.py
View file

@ -113,7 +113,7 @@ extensions = [
'linuxdoc.kernel_include', # Implementation of the 'kernel-include' reST-directive. 'linuxdoc.kernel_include', # Implementation of the 'kernel-include' reST-directive.
'linuxdoc.rstFlatTable', # Implementation of the 'flat-table' reST-directive. 'linuxdoc.rstFlatTable', # Implementation of the 'flat-table' reST-directive.
'linuxdoc.kfigure', # Sphinx extension which implements scalable image handling. 'linuxdoc.kfigure', # Sphinx extension which implements scalable image handling.
"sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs 'sphinx_design', # https://github.com/executablebooks/sphinx-design
] ]
intersphinx_mapping = { intersphinx_mapping = {

76
docs/dev/lxcdev.rst
View file

@ -69,9 +69,9 @@ Gentlemen, start your engines!
Before you can start with containers, you need to install and initiate LXD_ Before you can start with containers, you need to install and initiate LXD_
once: once:
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -81,9 +81,9 @@ once:
And you need to clone from origin or if you have your own fork, clone from your And you need to clone from origin or if you have your own fork, clone from your
fork: fork:
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -97,9 +97,9 @@ we exercise on a archlinux_ image. The container of this image is named
``searx-archlinux``. Lets build the container, but be sure that this container ``searx-archlinux``. Lets build the container, but be sure that this container
does not already exists, so first lets remove possible old one: does not already exists, so first lets remove possible old one:
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -113,9 +113,9 @@ does not already exists, so first lets remove possible old one:
In this container we install all services :ref:`including searx, morty & filtron In this container we install all services :ref:`including searx, morty & filtron
<lxc.sh install suite>` in once: <lxc.sh install suite>` in once:
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -124,9 +124,9 @@ In this container we install all services :ref:`including searx, morty & filtron
To proxy HTTP from filtron and morty in the container to the outside of the To proxy HTTP from filtron and morty in the container to the outside of the
container, install nginx into the container. Once for the bot blocker filtron: container, install nginx into the container. Once for the bot blocker filtron:
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -137,9 +137,9 @@ container, install nginx into the container. Once for the bot blocker filtron:
and once for the content sanitizer (content proxy morty): and once for the content sanitizer (content proxy morty):
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -171,9 +171,9 @@ Usually you open a root-bash using ``sudo -H bash``. In case of LXC containers
open the root-bash in the container using ``./utils/lxc.sh cmd open the root-bash in the container using ``./utils/lxc.sh cmd
searx-archlinux``: searx-archlinux``:
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -185,9 +185,9 @@ searx-archlinux``:
The prompt ``[root@searx-archlinux ...]`` signals, that you are the root user in The prompt ``[root@searx-archlinux ...]`` signals, that you are the root user in
the searx-container. To debug the running SearXNG instance use: the searx-container. To debug the running SearXNG instance use:
.. tabs:: .. tab-set::
.. group-tab:: root@searx-archlinux .. tab-item:: root@searx-archlinux
.. code:: sh .. code:: sh
@ -202,9 +202,9 @@ above. You can stop monitoring using ``CTRL-C``, this also disables the *"debug
option"* in SearXNG's settings file and restarts the SearXNG uwsgi application. option"* in SearXNG's settings file and restarts the SearXNG uwsgi application.
To debug services from filtron and morty analogous use: To debug services from filtron and morty analogous use:
.. tabs:: .. tab-set::
.. group-tab:: root@searx-archlinux .. tab-item:: root@searx-archlinux
.. code:: sh .. code:: sh
@ -216,9 +216,9 @@ Another point we have to notice is that each service (:ref:`SearXNG <searx.sh>`,
system user account with the same name (compare :ref:`create searxng 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: get a shell from theses accounts, simply call one of the scripts:
.. tabs:: .. tab-set::
.. group-tab:: root@searx-archlinux .. tab-item:: root@searx-archlinux
.. code:: sh .. code:: sh
@ -228,9 +228,9 @@ get a shell from theses accounts, simply call one of the scripts:
To get in touch, open a shell from the service user (searx@searx-archlinux): To get in touch, open a shell from the service user (searx@searx-archlinux):
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -243,9 +243,9 @@ The prompt ``[searx@searx-archlinux]`` signals that you are logged in as system
user ``searx`` in the ``searx-archlinux`` container and the python *virtualenv* user ``searx`` in the ``searx-archlinux`` container and the python *virtualenv*
``(searx-pyenv)`` environment is activated. ``(searx-pyenv)`` environment is activated.
.. tabs:: .. tab-set::
.. group-tab:: searx@searx-archlinux .. tab-item:: searx@searx-archlinux
.. code:: sh .. code:: sh
@ -271,9 +271,9 @@ With the use of the :ref:`searx.sh` the SearXNG service was installed as
``systemctl`` (compare :ref:`service architectures on distributions <uwsgi ``systemctl`` (compare :ref:`service architectures on distributions <uwsgi
configuration>`). configuration>`).
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -303,9 +303,9 @@ the **transparent** reposetory from the desktop. Now lets replace the
repository at ``searx-src`` in the container with the working tree from outside repository at ``searx-src`` in the container with the working tree from outside
of the container: of the container:
.. tabs:: .. tab-set::
.. group-tab:: container becomes a developer suite .. tab-item:: container becomes a developer suite
.. code:: sh .. code:: sh
@ -319,9 +319,9 @@ Now we can develop as usual in the working tree of our desktop system. Every
time the software was changed, you have to restart the SearXNG service (in the time the software was changed, you have to restart the SearXNG service (in the
conatiner): conatiner):
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh
@ -332,9 +332,9 @@ conatiner):
Remember: :ref:`working in containers` .. here are just some examples from my Remember: :ref:`working in containers` .. here are just some examples from my
daily usage: daily usage:
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
To *inspect* the SearXNG instance (already described above): To *inspect* the SearXNG instance (already described above):
@ -378,9 +378,9 @@ We build up a fully functional SearXNG suite in a archlinux container:
To access HTTP from the desktop we installed nginx for the services inside the To access HTTP from the desktop we installed nginx for the services inside the
conatiner: conatiner:
.. tabs:: .. tab-set::
.. group-tab:: [root@searx-archlinux] .. tab-item:: [root@searx-archlinux]
.. code:: sh .. code:: sh
@ -391,9 +391,9 @@ To wrap the suite into a developer one, we created a symbolic link to the
repository which is shared **transparent** from the desktop's file system into repository which is shared **transparent** from the desktop's file system into
the container : the container :
.. tabs:: .. tab-set::
.. group-tab:: [root@searx-archlinux] .. tab-item:: [root@searx-archlinux]
.. code:: sh .. code:: sh
@ -404,9 +404,9 @@ the container :
To get information about the searxNG suite in the archlinux container we can To get information about the searxNG suite in the archlinux container we can
use: use:
.. tabs:: .. tab-set::
.. group-tab:: desktop .. tab-item:: desktop
.. code:: sh .. code:: sh

1
requirements-dev.txt
View file

@ -7,6 +7,7 @@ splinter==0.16.0
selenium==3.141.0 selenium==3.141.0
twine==3.7.1 twine==3.7.1
furo==2021.11.23 furo==2021.11.23
sphinx-design==0.0.13
Sphinx==4.3.1 Sphinx==4.3.1
sphinx-issues==1.2.0 sphinx-issues==1.2.0
sphinx-jinja==1.2.1 sphinx-jinja==1.2.1

4
utils/filtron.sh
View file

@ -604,9 +604,9 @@ rst-doc() {
echo -e "\n.. START install systemd unit" echo -e "\n.. START install systemd unit"
cat <<EOF cat <<EOF
.. tabs:: .. tab-set::
.. group-tab:: systemd .. tab-item:: systemd
.. code:: bash .. code:: bash

4
utils/morty.sh
View file

@ -536,9 +536,9 @@ rst-doc() {
echo -e "\n.. START install systemd unit" echo -e "\n.. START install systemd unit"
cat <<EOF cat <<EOF
.. tabs:: .. tab-set::
.. group-tab:: systemd .. tab-item:: systemd
.. code:: bash .. code:: bash