mirror of
https://github.com/searxng/searxng.git
synced 2025-08-03 10:32:21 +02:00
docs: add some documentation about the tooling box ./utils/*
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
parent
8ca86f46d3
commit
9278f0fb45
8 changed files with 153 additions and 28 deletions
|
@ -8,6 +8,7 @@
|
|||
.. sidebar:: further reading
|
||||
|
||||
- :ref:`searx_filtron`
|
||||
- :ref:`architecture`
|
||||
|
||||
.. _Go: https://golang.org/
|
||||
.. _filtron: https://github.com/asciimoo/filtron
|
||||
|
@ -34,11 +35,42 @@ into this user account:
|
|||
<utils/templates/lib/systemd/system/filtron.service>`
|
||||
(``/lib/systemd/system/filtron.service``).
|
||||
|
||||
.. _reverse proxy:
|
||||
|
||||
Public Reverse Proxy
|
||||
====================
|
||||
|
||||
.. tabs::
|
||||
|
||||
To install searx in your public HTTP server use:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo -H ./utils/filtron.sh apache install
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: apache
|
||||
|
||||
.. literalinclude:: ../../utils/templates/etc/apache2/sites-available/searx.conf:filtron
|
||||
:language: apache
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Ubuntu / debian
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ sudo -H a2enmod headers
|
||||
$ sudo -H a2enmod proxy
|
||||
$ sudo -H a2enmod proxy_http
|
||||
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
The ``--help`` output of the script is largely self-explanatory:
|
||||
The ``--help`` output of the script is largely self-explanatory
|
||||
(:ref:`toolboxing common`):
|
||||
|
||||
.. program-output:: ../utils/filtron.sh --help
|
||||
|
||||
|
|
|
@ -1,9 +1,10 @@
|
|||
|
||||
.. _searx_utils:
|
||||
.. _toolboxing:
|
||||
|
||||
======================
|
||||
Tooling box ``utils/``
|
||||
======================
|
||||
=======================
|
||||
Tooling box ``utils/*``
|
||||
=======================
|
||||
|
||||
In the folder :origin:`utils/` we maintain some tools useful for admins and
|
||||
developers.
|
||||
|
@ -15,9 +16,37 @@ developers.
|
|||
filtron.sh
|
||||
morty.sh
|
||||
|
||||
.. hint::
|
||||
.. admonition:: Work needed!
|
||||
|
||||
ATM :ref:`filtron.sh` and :ref:`searx.sh` do supports only systemd init
|
||||
process used by debian, ubuntu and many other dists. If you have working
|
||||
init.d files to start/stop services, please contribute / thanks!
|
||||
Our scripts to maintain services do most support only systemd init process
|
||||
used by debian, ubuntu and many other dists. In general our scripts are only
|
||||
partially usable on debian systems. We are working on this limitation, if
|
||||
you have any contribution, please send us your :pull:`PR <../pulls>`, see
|
||||
:ref:`how to contribute`.
|
||||
|
||||
.. _toolboxing common:
|
||||
|
||||
Common commands
|
||||
===============
|
||||
|
||||
Scripts to maintain services often dispose of common commands and environments.
|
||||
|
||||
``shell``:
|
||||
Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for
|
||||
troubleshooting.
|
||||
|
||||
``inspect service``:
|
||||
Shows status and log of the service, most often you have a option to enable
|
||||
more verbose debug logs. Very helpful for debugging, but be careful not to
|
||||
enable debugging in a production environment!
|
||||
|
||||
.. _toolboxing setup:
|
||||
|
||||
Tooling box setup
|
||||
=================
|
||||
|
||||
The main setup is done in the :origin:`.config.sh` (read also :ref:`makefile
|
||||
setup`).
|
||||
|
||||
.. literalinclude:: ../../.config.sh
|
||||
:language: bash
|
||||
|
|
|
@ -1,13 +1,17 @@
|
|||
|
||||
.. _morty.sh:
|
||||
|
||||
.. _morty: https://github.com/asciimoo/morty
|
||||
.. _morty's README: https://github.com/asciimoo/morty
|
||||
|
||||
.. _morty.sh:
|
||||
|
||||
==================
|
||||
``utils/morty.sh``
|
||||
==================
|
||||
|
||||
.. sidebar:: further reading
|
||||
|
||||
- :ref:`architecture`
|
||||
|
||||
To simplify installation and maintenance of a morty_ instance you can use the
|
||||
script :origin:`utils/morty.sh`. In most cases you will install morty_ simply by
|
||||
running the command:
|
||||
|
@ -24,8 +28,11 @@ into this user account.
|
|||
To add morty to your searx instance read chapter :reF:`searx_morty`.
|
||||
|
||||
|
||||
The ``--help`` output of the script is largely
|
||||
self-explanatory:
|
||||
Overview
|
||||
========
|
||||
|
||||
The ``--help`` output of the script is largely self-explanatory
|
||||
(:ref:`toolboxing common`):
|
||||
|
||||
.. program-output:: ../utils/morty.sh --help
|
||||
|
||||
|
|
|
@ -5,6 +5,11 @@
|
|||
``utils/searx.sh``
|
||||
==================
|
||||
|
||||
.. sidebar:: further reading
|
||||
|
||||
- :ref:`installation`
|
||||
- :ref:`architecture`
|
||||
|
||||
To simplify installation and maintenance of a searx instance you can use the
|
||||
script :origin:`utils/searx.sh`. In most cases you will install searx simply by
|
||||
running the command:
|
||||
|
@ -14,8 +19,50 @@ running the command:
|
|||
sudo -H ./utils/searx.sh install all
|
||||
|
||||
The script adds a ``${SERVICE_USER}`` (default:``searx``) and installs searx
|
||||
into this user account. The ``--help`` output of the script is largely
|
||||
self-explanatory:
|
||||
into this user account. The installation is described in chapter
|
||||
:ref:`installation basic`.
|
||||
|
||||
.. _intranet reverse proxy:
|
||||
|
||||
Intranet Reverse Proxy
|
||||
======================
|
||||
|
||||
.. warning::
|
||||
|
||||
This setup is **not** suitable **for public instances**, go on with
|
||||
:ref:`reverse proxy`!
|
||||
|
||||
To install searx in your intranet HTTP server use:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo -H ./utils/searx.sh apache install
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: apache
|
||||
|
||||
.. literalinclude:: ../../utils/templates/etc/apache2/sites-available/searx.conf:uwsgi
|
||||
:language: apache
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Ubuntu / debian
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ sudo -H apt install libapache2-mod-uwsgi
|
||||
|
||||
.. group-tab:: Arch Linux
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ sudo pacman -S uwsgi
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
The ``--help`` output of the script is largely self-explanatory
|
||||
(:ref:`toolboxing common`):
|
||||
|
||||
.. program-output:: ../utils/searx.sh --help
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue