forked from Icycoide/searxng
doc: add descriptions of our tooling box in ./utils
Initial started with the scripts for searx, filtron and morty installations. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
parent
e7401796f6
commit
94ac560dcc
11 changed files with 141 additions and 26 deletions
44
docs/utils/filtron.sh.rst
Normal file
44
docs/utils/filtron.sh.rst
Normal file
|
@ -0,0 +1,44 @@
|
|||
|
||||
.. _filtron.sh:
|
||||
|
||||
====================
|
||||
``utils/filtron.sh``
|
||||
====================
|
||||
|
||||
.. sidebar:: further reading
|
||||
|
||||
- :ref:`searx_filtron`
|
||||
|
||||
.. _Go: https://golang.org/
|
||||
.. _filtron: https://github.com/asciimoo/filtron
|
||||
.. _filtron README: https://github.com/asciimoo/filtron/blob/master/README.md
|
||||
|
||||
To simplify installation and maintenance of a filtron instance you can use the
|
||||
script :origin:`utils/filtron.sh`. In most cases you will install filtron_
|
||||
simply by running the command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo -H ./utils/filtron.sh install all
|
||||
|
||||
The script adds a ``${SERVICE_USER}`` (default:``filtron``) and installs filtron_
|
||||
into this user account:
|
||||
|
||||
#. Create a separated user account (``filtron``).
|
||||
#. Download and install Go_ binary in users $HOME (``~filtron``).
|
||||
#. Install filtron with the package management of Go_ (``go get -v -u
|
||||
github.com/asciimoo/filtron``)
|
||||
#. Setup a proper rule configuration :origin:`[ref]
|
||||
<utils/templates/etc/filtron/rules.json>` (``/etc/filtron/rules.json``).
|
||||
#. Setup a systemd service unit :origin:`[ref]
|
||||
<utils/templates/lib/systemd/system/filtron.service>`
|
||||
(``/lib/systemd/system/filtron.service``).
|
||||
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
The ``--help`` output of the script is largely self-explanatory:
|
||||
|
||||
.. program-output:: ../utils/filtron.sh --help
|
||||
|
23
docs/utils/index.rst
Normal file
23
docs/utils/index.rst
Normal file
|
@ -0,0 +1,23 @@
|
|||
|
||||
.. _searx_utils:
|
||||
|
||||
======================
|
||||
Tooling box ``utils/``
|
||||
======================
|
||||
|
||||
In the folder :origin:`utils/` we maintain some tools useful for admins and
|
||||
developers.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
searx.sh
|
||||
filtron.sh
|
||||
morty.sh
|
||||
|
||||
.. hint::
|
||||
|
||||
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!
|
||||
|
31
docs/utils/morty.sh.rst
Normal file
31
docs/utils/morty.sh.rst
Normal file
|
@ -0,0 +1,31 @@
|
|||
|
||||
.. _morty.sh:
|
||||
|
||||
.. _morty: https://github.com/asciimoo/morty
|
||||
.. _morty's README: https://github.com/asciimoo/morty
|
||||
|
||||
==================
|
||||
``utils/morty.sh``
|
||||
==================
|
||||
|
||||
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:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
sudo -H ./utils/morty.sh install all
|
||||
|
||||
The script adds a ``${SERVICE_USER}`` (default:``morty``) and installs morty_
|
||||
into this user account.
|
||||
|
||||
.. hint::
|
||||
|
||||
To add morty to your searx instance read chapter :reF:`searx_morty`.
|
||||
|
||||
|
||||
The ``--help`` output of the script is largely
|
||||
self-explanatory:
|
||||
|
||||
.. program-output:: ../utils/morty.sh --help
|
||||
|
21
docs/utils/searx.sh.rst
Normal file
21
docs/utils/searx.sh.rst
Normal file
|
@ -0,0 +1,21 @@
|
|||
|
||||
.. _searx.sh:
|
||||
|
||||
==================
|
||||
``utils/searx.sh``
|
||||
==================
|
||||
|
||||
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:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
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:
|
||||
|
||||
.. program-output:: ../utils/searx.sh --help
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue