From 94ac560dcc85e2e75d3b14706a65eb9488643eb4 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 3 Feb 2020 13:25:51 +0100 Subject: 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 --- docs/utils/filtron.sh.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ docs/utils/index.rst | 23 +++++++++++++++++++++++ docs/utils/morty.sh.rst | 31 +++++++++++++++++++++++++++++++ docs/utils/searx.sh.rst | 21 +++++++++++++++++++++ 4 files changed, 119 insertions(+) create mode 100644 docs/utils/filtron.sh.rst create mode 100644 docs/utils/index.rst create mode 100644 docs/utils/morty.sh.rst create mode 100644 docs/utils/searx.sh.rst (limited to 'docs/utils') diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst new file mode 100644 index 000000000..d93e38105 --- /dev/null +++ b/docs/utils/filtron.sh.rst @@ -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] + ` (``/etc/filtron/rules.json``). +#. Setup a systemd service unit :origin:`[ref] + ` + (``/lib/systemd/system/filtron.service``). + + +Overview +======== + +The ``--help`` output of the script is largely self-explanatory: + +.. program-output:: ../utils/filtron.sh --help + diff --git a/docs/utils/index.rst b/docs/utils/index.rst new file mode 100644 index 000000000..4836ac652 --- /dev/null +++ b/docs/utils/index.rst @@ -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! + diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst new file mode 100644 index 000000000..64ebda574 --- /dev/null +++ b/docs/utils/morty.sh.rst @@ -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 + diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst new file mode 100644 index 000000000..fb606c0b0 --- /dev/null +++ b/docs/utils/searx.sh.rst @@ -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 + -- cgit v1.2.3 From 9278f0fb45bab21247085a709c0e4bef743752db Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 4 Feb 2020 13:13:17 +0100 Subject: docs: add some documentation about the tooling box ./utils/* Signed-off-by: Markus Heiser --- docs/utils/filtron.sh.rst | 34 +++++++++++++++++++++++++++++- docs/utils/index.rst | 43 +++++++++++++++++++++++++++++++------- docs/utils/morty.sh.rst | 15 ++++++++++---- docs/utils/searx.sh.rst | 53 ++++++++++++++++++++++++++++++++++++++++++++--- 4 files changed, 130 insertions(+), 15 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst index d93e38105..356359753 100644 --- a/docs/utils/filtron.sh.rst +++ b/docs/utils/filtron.sh.rst @@ -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: ` (``/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 diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 4836ac652..9905d755f 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -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 diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 64ebda574..988b16935 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -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 diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst index fb606c0b0..1e3f954bb 100644 --- a/docs/utils/searx.sh.rst +++ b/docs/utils/searx.sh.rst @@ -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`. -.. program-output:: ../utils/searx.sh --help +.. _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 -- cgit v1.2.3 From eedd63ccd504099836d9f528d02daffa6bc826ad Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 4 Feb 2020 16:42:13 +0100 Subject: docs: revision of the installation instructions Signed-off-by: Markus Heiser --- docs/utils/filtron.sh.rst | 3 +-- docs/utils/index.rst | 19 ++++++++++--------- docs/utils/morty.sh.rst | 1 + docs/utils/searx.sh.rst | 19 ++++++++++++------- 4 files changed, 24 insertions(+), 18 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst index 356359753..1bba1b3e4 100644 --- a/docs/utils/filtron.sh.rst +++ b/docs/utils/filtron.sh.rst @@ -7,6 +7,7 @@ .. sidebar:: further reading + - :ref:`installation` - :ref:`searx_filtron` - :ref:`architecture` @@ -40,8 +41,6 @@ into this user account: Public Reverse Proxy ==================== -.. tabs:: - To install searx in your public HTTP server use: .. code:: bash diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 9905d755f..97e2c875f 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -6,24 +6,25 @@ Tooling box ``utils/*`` ======================= +.. sidebar:: Work needed! + + 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`. + In the folder :origin:`utils/` we maintain some tools useful for admins and developers. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: Contents searx.sh filtron.sh morty.sh -.. admonition:: Work needed! - - 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 diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 988b16935..9997ffec5 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -10,6 +10,7 @@ .. sidebar:: further reading + - :ref:`installation` - :ref:`architecture` To simplify installation and maintenance of a morty_ instance you can use the diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst index 1e3f954bb..988c08438 100644 --- a/docs/utils/searx.sh.rst +++ b/docs/utils/searx.sh.rst @@ -9,10 +9,15 @@ - :ref:`installation` - :ref:`architecture` + - :ref:`filtron.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: +script :origin:`utils/searx.sh`. + +Install +======= + +In most cases you will install searx simply by running the command: .. code:: bash @@ -27,17 +32,17 @@ into this user account. The installation is described in chapter 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 +.. warning:: + + This setup is **not** suitable **for public instances**, go on with + :ref:`reverse proxy`! + .. tabs:: .. group-tab:: apache -- cgit v1.2.3 From a99c65dd018f092a8b7adc6ff7a12961334b40f3 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 5 Feb 2020 07:37:26 +0100 Subject: docs: misc marginal fixes Signed-off-by: Markus Heiser --- docs/utils/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 97e2c875f..338914715 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -6,6 +6,9 @@ Tooling box ``utils/*`` ======================= +In the folder :origin:`utils/` we maintain some tools useful for admins and +developers. + .. sidebar:: Work needed! Our scripts to maintain services do most support only systemd init process @@ -14,9 +17,6 @@ Tooling box ``utils/*`` you have any contribution, please send us your :pull:`PR <../pulls>`, see :ref:`how to contribute`. -In the folder :origin:`utils/` we maintain some tools useful for admins and -developers. - .. toctree:: :maxdepth: 2 :caption: Contents -- cgit v1.2.3 From c3e4753ce951f759844db13d98f9ad5b226f84b6 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 2 Mar 2020 19:00:19 +0100 Subject: docs: generic documentation from the installation scripts Signed-off-by: Markus Heiser --- docs/utils/index.rst | 9 --------- 1 file changed, 9 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 338914715..1c77cbfcd 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -1,4 +1,3 @@ - .. _searx_utils: .. _toolboxing: @@ -9,14 +8,6 @@ Tooling box ``utils/*`` In the folder :origin:`utils/` we maintain some tools useful for admins and developers. -.. sidebar:: Work needed! - - 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`. - .. toctree:: :maxdepth: 2 :caption: Contents -- cgit v1.2.3 From 387c6a77691fec514704bdf178b9ab94ad4abb40 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 6 Mar 2020 14:47:00 +0100 Subject: docs: improve description of uwsgi & ngingx setup Signed-off-by: Markus Heiser --- docs/utils/filtron.sh.rst | 3 ++- docs/utils/morty.sh.rst | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst index 1bba1b3e4..e6d7d6251 100644 --- a/docs/utils/filtron.sh.rst +++ b/docs/utils/filtron.sh.rst @@ -8,7 +8,7 @@ .. sidebar:: further reading - :ref:`installation` - - :ref:`searx_filtron` + - :ref:`searx filtron` - :ref:`architecture` .. _Go: https://golang.org/ @@ -64,6 +64,7 @@ To install searx in your public HTTP server use: $ sudo -H a2enmod proxy $ sudo -H a2enmod proxy_http +.. _filtron.sh overview: Overview ======== diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 9997ffec5..5ab6ee982 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -26,7 +26,7 @@ into this user account. .. hint:: - To add morty to your searx instance read chapter :reF:`searx_morty`. + To add morty to your searx instance read chapter :ref:`searx morty`. Overview -- cgit v1.2.3 From dd53c45a2cb46f882a856869de26215942749cba Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 30 Mar 2020 18:47:01 +0200 Subject: docs: add utils/lxc.sh docs, normalize filtron, morty & searx docs Signed-off-by: Markus Heiser --- docs/utils/filtron.sh.rst | 25 +++++++-------- docs/utils/index.rst | 1 + docs/utils/lxc.sh.rst | 79 +++++++++++++++++++++++++++++++++++++++++++++++ docs/utils/morty.sh.rst | 11 ++++++- docs/utils/searx.sh.rst | 41 ++++++++++++++---------- 5 files changed, 126 insertions(+), 31 deletions(-) create mode 100644 docs/utils/lxc.sh.rst (limited to 'docs/utils') diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst index e6d7d6251..40e57aa3c 100644 --- a/docs/utils/filtron.sh.rst +++ b/docs/utils/filtron.sh.rst @@ -27,8 +27,8 @@ 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 +#. Download and install Go_ binary in user's $HOME (``~filtron``). +#. Install filtron with the package management from Go_ (``go get -v -u github.com/asciimoo/filtron``) #. Setup a proper rule configuration :origin:`[ref] ` (``/etc/filtron/rules.json``). @@ -36,6 +36,16 @@ into this user account: ` (``/lib/systemd/system/filtron.service``). +.. _filtron.sh overview: + +Overview +======== + +The ``--help`` output of the script is largely self-explanatory +(:ref:`toolboxing common`): + +.. program-output:: ../utils/filtron.sh --help + .. _reverse proxy: Public Reverse Proxy @@ -63,14 +73,3 @@ To install searx in your public HTTP server use: $ sudo -H a2enmod headers $ sudo -H a2enmod proxy $ sudo -H a2enmod proxy_http - -.. _filtron.sh overview: - -Overview -======== - -The ``--help`` output of the script is largely self-explanatory -(:ref:`toolboxing common`): - -.. program-output:: ../utils/filtron.sh --help - diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 1c77cbfcd..088586e43 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -15,6 +15,7 @@ developers. searx.sh filtron.sh morty.sh + lxc.sh .. _toolboxing common: diff --git a/docs/utils/lxc.sh.rst b/docs/utils/lxc.sh.rst new file mode 100644 index 000000000..68577ea13 --- /dev/null +++ b/docs/utils/lxc.sh.rst @@ -0,0 +1,79 @@ + + +.. _snap: https://snapcraft.io +.. _snapcraft LXD: https://snapcraft.io/lxd +.. _LXC/LXD Image Server: https://uk.images.linuxcontainers.org/ +.. _LXC: https://linuxcontainers.org/lxc/introduction/ +.. _LXD: https://linuxcontainers.org/lxd/introduction/ +.. _`LXD@github`: https://github.com/lxc/lxd + +.. _lxc.sh: + +================ +``utils/lxc.sh`` +================ + +.. sidebar:: further reading + + - snap_, `snapcraft LXD`_ + - LXC_, LXD_ + - `LXC/LXD Image Server`_ + - `LXD@github`_ + +With the use of *Linux Containers* (LXC_) we can scale our tasks over a stack of +containers, what we call the: *lxc suite*. Before you can start with +containers, you need to install and initiate LXD_ once:: + + $ snap install lxd + $ lxd init --auto + +The *searx suite* (:origin:`lxc-searx.env `) is loaded by +default, every time you start the ``lxc.sh`` script (you do not need to care +about). To make use of the containers from the *searx suite*, you have to build +the :ref:`LXC suite containers ` first. But be warned, this +might take some time:: + + $ sudo -H ./utils/lxc.sh build + +A cup of coffee later, your LXC suite is build up and you can run whatever task +you want / in a selected or even in all :ref:`LXC suite containers `. Each container shares the root folder of the repository and the +command ``utils/lxc.sh cmd`` handles relative path names *transparent*:: + + $ sudo -H ./utils/lxc.sh cmd -- ls -la Makefile + ... + [searx-ubu2004] -rw-r--r-- 1 root root 7603 Mar 30 11:54 Makefile + [searx-fedora31] -rw-r--r-- 1 root root 7603 Mar 30 11:54 Makefile + [searx-archlinux] -rw-r--r-- 1 root root 7603 Mar 30 11:54 Makefile + +With this in mind, you can run :ref:`searx.sh` and install packages, needed by +searx:: + + $ sudo -H ./utils/lxc.sh cmd -- ./utils/searx.sh install packages + +And run one of the :origin:`Makefile` targets:: + + $ sudo -H ./utils/lxc.sh cmd -- make test.sh + +You can install a *buildhost environment* into the containers (time for another +cup of coffee):: + + $ sudo -H ./utils/lxc.sh install buildhost + +If you want to get rid off all the containers, just type:: + + $ sudo -H ./utils/lxc.sh remove + +To clean up your local images use:: + + $ sudo -H ./utils/lxc.sh remove images + +.. _lxc.sh --help: + +Overview +======== + +The ``--help`` output of the script is largely self-explanatory: + +.. program-output:: ../utils/lxc.sh --help + diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 5ab6ee982..2bdc4d9c8 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -1,6 +1,7 @@ .. _morty: https://github.com/asciimoo/morty .. _morty's README: https://github.com/asciimoo/morty +.. _Go: https://golang.org/ .. _morty.sh: @@ -22,7 +23,15 @@ running the command: sudo -H ./utils/morty.sh install all The script adds a ``${SERVICE_USER}`` (default:``morty``) and installs morty_ -into this user account. +into this user account: + +#. Create a separated user account (``morty``). +#. Download and install Go_ binary in user's $HOME (``~morty``). +#. Install morty_ with the package management from Go_ (``go get -v -u + github.com/asciimoo/morty``) +#. Setup a systemd service unit :origin:`[ref] + ` + (``/lib/systemd/system/morty.service``). .. hint:: diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst index 988c08438..905f765dd 100644 --- a/docs/utils/searx.sh.rst +++ b/docs/utils/searx.sh.rst @@ -29,45 +29,52 @@ into this user account. The installation is described in chapter .. _intranet reverse proxy: -Intranet Reverse Proxy -====================== +Overview +======== -To install searx in your intranet HTTP server use: +The ``--help`` output of the script is largely self-explanatory +(:ref:`toolboxing common`): -.. code:: bash +.. program-output:: ../utils/searx.sh --help - sudo -H ./utils/searx.sh apache install + +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 + :language: apache .. tabs:: - .. group-tab:: Ubuntu / debian + .. group-tab:: Ubuntu / debian - .. code-block:: sh + .. code-block:: sh - $ sudo -H apt install libapache2-mod-uwsgi + $ sudo -H apt install libapache2-mod-uwsgi - .. group-tab:: Arch Linux + .. group-tab:: Arch Linux - .. code-block:: sh + .. code-block:: sh - $ sudo pacman -S uwsgi + $ sudo -H pacman -S uwsgi -Overview -======== + .. group-tab:: Fedora / RHEL -The ``--help`` output of the script is largely self-explanatory -(:ref:`toolboxing common`): + .. code-block:: sh -.. program-output:: ../utils/searx.sh --help + $ sudo -H dnf install uwsgi -- cgit v1.2.3 From f27f6c6c5d372b257dfe671ec26eb73f6e12ed28 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 31 Mar 2020 18:25:40 +0200 Subject: docs: use make and uitls/searx.sh in containers Signed-off-by: Markus Heiser --- docs/utils/lxc.sh.rst | 103 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 80 insertions(+), 23 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/lxc.sh.rst b/docs/utils/lxc.sh.rst index 68577ea13..20f387158 100644 --- a/docs/utils/lxc.sh.rst +++ b/docs/utils/lxc.sh.rst @@ -1,5 +1,4 @@ - .. _snap: https://snapcraft.io .. _snapcraft LXD: https://snapcraft.io/lxd .. _LXC/LXD Image Server: https://uk.images.linuxcontainers.org/ @@ -7,6 +6,8 @@ .. _LXD: https://linuxcontainers.org/lxd/introduction/ .. _`LXD@github`: https://github.com/lxc/lxd +.. _archlinux: https://www.archlinux.org/ + .. _lxc.sh: ================ @@ -21,24 +22,31 @@ - `LXD@github`_ With the use of *Linux Containers* (LXC_) we can scale our tasks over a stack of -containers, what we call the: *lxc suite*. Before you can start with -containers, you need to install and initiate LXD_ once:: +containers, what we call the: *lxc suite*. The *searx suite* +(:origin:`lxc-searx.env `) is loaded by default, every time +you start the ``lxc.sh`` script (*you do not need to care about*). + +Before you can start with containers, you need to install and initiate LXD_ +once:: $ snap install lxd $ lxd init --auto -The *searx suite* (:origin:`lxc-searx.env `) is loaded by -default, every time you start the ``lxc.sh`` script (you do not need to care -about). To make use of the containers from the *searx suite*, you have to build -the :ref:`LXC suite containers ` first. But be warned, this -might take some time:: +To make use of the containers from the *searx suite*, you have to build the +:ref:`LXC suite containers ` initial. But be warned, this might +take some time:: $ sudo -H ./utils/lxc.sh build A cup of coffee later, your LXC suite is build up and you can run whatever task you want / in a selected or even in all :ref:`LXC suite containers `. Each container shares the root folder of the repository and the -command ``utils/lxc.sh cmd`` handles relative path names *transparent*:: +help>`. + +*Good to know ...* + +Eeach container shares the root folder of the repository and the +command ``utils/lxc.sh cmd`` **handles relative path names transparent**, +compare output of:: $ sudo -H ./utils/lxc.sh cmd -- ls -la Makefile ... @@ -46,29 +54,70 @@ command ``utils/lxc.sh cmd`` handles relative path names *transparent*:: [searx-fedora31] -rw-r--r-- 1 root root 7603 Mar 30 11:54 Makefile [searx-archlinux] -rw-r--r-- 1 root root 7603 Mar 30 11:54 Makefile -With this in mind, you can run :ref:`searx.sh` and install packages, needed by -searx:: +If there comes the time you want to **get rid off all** the containers and +**clean up local images** just type:: - $ sudo -H ./utils/lxc.sh cmd -- ./utils/searx.sh install packages + $ sudo -H ./utils/lxc.sh remove + $ sudo -H ./utils/lxc.sh remove images -And run one of the :origin:`Makefile` targets:: - $ sudo -H ./utils/lxc.sh cmd -- make test.sh +Install suite +============= -You can install a *buildhost environment* into the containers (time for another -cup of coffee):: +To install the complete :ref:`searx suite (includes searx, morty & filtron) +` into all LXC_ use:: - $ sudo -H ./utils/lxc.sh install buildhost + $ sudo -H ./utils/lxc.sh install suite -If you want to get rid off all the containers, just type:: +The command above installs a searx suite (see :ref:`installation scripts`). To +get the IP (URL) of the filtron service in the containers use ``show suite`` +command. To test instances from containers just open the URLs in your +WEB-Browser:: - $ sudo -H ./utils/lxc.sh remove + $ sudo ./utils/lxc.sh show suite | grep filtron + [searx-ubu1604] INFO: (eth0) filtron: http://n.n.n.135:4004/ + [searx-ubu1804] INFO: (eth0) filtron: http://n.n.n.141:4004/ + [searx-ubu1910] INFO: (eth0) filtron: http://n.n.n.137:4004/ + [searx-ubu2004] INFO: (eth0) filtron: http://n.n.n.127:4004/ + [searx-fedora31] INFO: (eth0) filtron: http://n.n.n.18:4004/ + [searx-archlinux] INFO: (eth0) filtron: http://n.n.n.12:4004/ -To clean up your local images use:: + +Running commands +================ - $ sudo -H ./utils/lxc.sh remove images +**Inside containers, you can use make or run scripts** from the +:ref:`toolboxing`. By example: to setup a :ref:`buildhosts` and run the +Makefile target ``test`` in the archlinux_ container:: + + sudo -H ./utils/lxc.sh cmd searx-archlinux ./utils/searx.sh buildhost + sudo -H ./utils/lxc.sh cmd searx-archlinux make test + + +Setup searx buildhost +===================== -.. _lxc.sh --help: +You can **install the searx buildhost environment** into one or all containers. +The installation procedure to set up a :ref:`build host` takes its +time. Installation in all containers will take more time (time for another cup +of coffee).:: + + sudo -H ./utils/lxc.sh cmd -- ./utils/searx.sh buildhost + +To build (live) documentation inside a archlinux_ container:: + + sudo -H ./utils/lxc.sh cmd searx-archlinux make docs-clean docs-live + ... + [I 200331 15:00:42 server:296] Serving on http://0.0.0.0:8080 + +To get IP of the container and the port number *live docs* is listening:: + + $ sudo ./utils/lxc.sh show suite | grep docs-live + ... + [searx-archlinux] INFO: (eth0) docs-live: http://n.n.n.12:8080/ + + +.. _lxc.sh help: Overview ======== @@ -77,3 +126,11 @@ The ``--help`` output of the script is largely self-explanatory: .. program-output:: ../utils/lxc.sh --help + +.. _lxc-searx.env: + +searx suite +=========== + +.. literalinclude:: ../../utils/lxc-searx.env + :language: bash -- cgit v1.2.3 From af988dbf71ce4b14d2056676d7d9691335266d83 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 3 Apr 2020 17:08:42 +0200 Subject: utils/lxc.sh: support build of selected containers $ sudo -H ./utils/lxc.sh build $ sudo -H ./utils/lxc.sh show [images|suite|info|config []] Signed-off-by: Markus Heiser --- docs/utils/lxc.sh.rst | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/lxc.sh.rst b/docs/utils/lxc.sh.rst index 20f387158..fcddfb340 100644 --- a/docs/utils/lxc.sh.rst +++ b/docs/utils/lxc.sh.rst @@ -33,14 +33,17 @@ once:: $ lxd init --auto To make use of the containers from the *searx suite*, you have to build the -:ref:`LXC suite containers ` initial. But be warned, this might -take some time:: +:ref:`LXC suite containers ` initial. But be warned, **this might +take some time**:: $ sudo -H ./utils/lxc.sh build A cup of coffee later, your LXC suite is build up and you can run whatever task you want / in a selected or even in all :ref:`LXC suite containers `. +help>`. If you do not want to build all containers, **you can build just +one**:: + + $ sudo -H ./utils/lxc.sh build searx-ubu1804 *Good to know ...* @@ -50,9 +53,12 @@ compare output of:: $ sudo -H ./utils/lxc.sh cmd -- ls -la Makefile ... - [searx-ubu2004] -rw-r--r-- 1 root root 7603 Mar 30 11:54 Makefile - [searx-fedora31] -rw-r--r-- 1 root root 7603 Mar 30 11:54 Makefile - [searx-archlinux] -rw-r--r-- 1 root root 7603 Mar 30 11:54 Makefile + +In the containers, you can run what ever you want, e.g. to start a bash use:: + + $ sudo -H ./utils/lxc.sh cmd searx-ubu1804 bash + INFO: [searx-ubu1804] bash + root@searx-ubu1804:/share/searx# If there comes the time you want to **get rid off all** the containers and **clean up local images** just type:: -- cgit v1.2.3 From 853be4e11cd8a82b6b08f04db1717329907a5aaf Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 3 Apr 2020 20:24:40 +0200 Subject: utils/filtron.sh: add generic documentation Signed-off-by: Markus Heiser --- docs/utils/filtron.sh.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) (limited to 'docs/utils') diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst index 40e57aa3c..a3c1aed41 100644 --- a/docs/utils/filtron.sh.rst +++ b/docs/utils/filtron.sh.rst @@ -36,6 +36,38 @@ into this user account: ` (``/lib/systemd/system/filtron.service``). + +Create user +=========== + +.. include:: ../../build/docs/includes/filtron.rst + :start-after: START create user + :end-before: END create user + + +Install go +========== + +.. include:: ../../build/docs/includes/filtron.rst + :start-after: START install go + :end-before: END install go + + +Install filtron +=============== + +Install :origin:`rules.json ` at +``/etc/filtron/rules.json`` (see :ref:`Sample configuration of filtron`) and +install filtron software and systemd unit: + +.. include:: ../../build/docs/includes/filtron.rst + :start-after: START install filtron + :end-before: END install filtron + +.. include:: ../../build/docs/includes/filtron.rst + :start-after: START install systemd unit + :end-before: END install systemd unit + .. _filtron.sh overview: Overview -- cgit v1.2.3 From e32b08f61681da42104bc94b7b3266e41a79c58b Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 3 Apr 2020 20:26:20 +0200 Subject: utils/morty.sh: add generic documentation Signed-off-by: Markus Heiser --- docs/utils/morty.sh.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'docs/utils') diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 2bdc4d9c8..34f0c9b5e 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -13,6 +13,7 @@ - :ref:`installation` - :ref:`architecture` + - :ref:`searx morty` 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 @@ -37,6 +38,34 @@ into this user account: To add morty to your searx instance read chapter :ref:`searx morty`. +Create user +=========== + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START create user + :end-before: END create user + + +Install go +========== + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START install go + :end-before: END install go + + +Install morty +============= + +Install morty software and systemd unit: + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START install morty + :end-before: END install morty + +.. include:: ../../build/docs/includes/morty.rst + :start-after: START install systemd unit + :end-before: END install systemd unit Overview ======== -- cgit v1.2.3 From f693149cded4f783380f8f02154bd9288b72cdd5 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 8 Apr 2020 18:38:36 +0200 Subject: Changes from the installation tests on (all) LXC containers. Tested and fixed HTTP & uWSGI installation on: ubu1604 ubu1804 ubu1910 ubu2004 fedora31 archlinux Signed-off-by: Markus Heiser --- docs/utils/index.rst | 16 ++++++++++++---- docs/utils/lxc.sh.rst | 6 +++++- 2 files changed, 17 insertions(+), 5 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 088586e43..13914af28 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -19,20 +19,28 @@ developers. .. _toolboxing common: -Common commands -=============== +Common commands & environment +============================= Scripts to maintain services often dispose of common commands and environments. -``shell``: +``shell`` : command Opens a shell from the service user ``${SERVICE_USSR}``, very helpful for troubleshooting. -``inspect service``: +``inspect service`` : command 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! +``FORCE_TIMEOUT`` : environment + Sets timeout for interactive prompts. If you want to run a script in batch + job, with defaults choices, set ``FORCE_TIMEOUT=0``. By example; to install a + reverse proxy for filtron on all containers of the :ref:`searx suite + ` use :: + + sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install + .. _toolboxing setup: Tooling box setup diff --git a/docs/utils/lxc.sh.rst b/docs/utils/lxc.sh.rst index fcddfb340..44ab79030 100644 --- a/docs/utils/lxc.sh.rst +++ b/docs/utils/lxc.sh.rst @@ -88,7 +88,11 @@ WEB-Browser:: [searx-fedora31] INFO: (eth0) filtron: http://n.n.n.18:4004/ [searx-archlinux] INFO: (eth0) filtron: http://n.n.n.12:4004/ - +To install a reverse proxy for filtron and morty use:: + + sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install + sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/morty.sh apache install + Running commands ================ -- cgit v1.2.3 From ebde9d10fd84de74ea99385dae4d95bcf932bcf3 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 9 Apr 2020 15:04:23 +0200 Subject: docs: proofreading of all the installation topics Signed-off-by: Markus Heiser --- docs/utils/filtron.sh.rst | 31 ++----------------------------- docs/utils/morty.sh.rst | 5 ++++- docs/utils/searx.sh.rst | 47 +++-------------------------------------------- 3 files changed, 9 insertions(+), 74 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst index a3c1aed41..6c83bdf78 100644 --- a/docs/utils/filtron.sh.rst +++ b/docs/utils/filtron.sh.rst @@ -7,9 +7,10 @@ .. sidebar:: further reading - - :ref:`installation` - :ref:`searx filtron` - :ref:`architecture` + - :ref:`installation` (:ref:`nginx ` & :ref:`apache + `) .. _Go: https://golang.org/ .. _filtron: https://github.com/asciimoo/filtron @@ -77,31 +78,3 @@ The ``--help`` output of the script is largely self-explanatory (:ref:`toolboxing common`): .. program-output:: ../utils/filtron.sh --help - -.. _reverse proxy: - -Public Reverse Proxy -==================== - -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 diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 34f0c9b5e..89629bea0 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -11,8 +11,9 @@ .. sidebar:: further reading - - :ref:`installation` - :ref:`architecture` + - :ref:`installation` (:ref:`nginx ` & :ref:`apache + `) - :ref:`searx morty` To simplify installation and maintenance of a morty_ instance you can use the @@ -67,6 +68,8 @@ Install morty software and systemd unit: :start-after: START install systemd unit :end-before: END install systemd unit +.. _morty.sh overview: + Overview ======== diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst index 905f765dd..dd4442f94 100644 --- a/docs/utils/searx.sh.rst +++ b/docs/utils/searx.sh.rst @@ -7,9 +7,10 @@ .. sidebar:: further reading - - :ref:`installation` - :ref:`architecture` - - :ref:`filtron.sh` + - :ref:`installation` + - :ref:`installation nginx` + - :ref:`installation apache` To simplify installation and maintenance of a searx instance you can use the script :origin:`utils/searx.sh`. @@ -36,45 +37,3 @@ The ``--help`` output of the script is largely self-explanatory (:ref:`toolboxing common`): .. program-output:: ../utils/searx.sh --help - - -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 -H pacman -S uwsgi - - .. group-tab:: Fedora / RHEL - - .. code-block:: sh - - $ sudo -H dnf install uwsgi -- cgit v1.2.3 From 5fc17de8617d0d5771578f38f62a9d4714054747 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 19 Apr 2020 12:34:37 +0200 Subject: docs: marginal fix of command's './utils/lxc.sh show suite' output Signed-off-by: Markus Heiser --- docs/utils/lxc.sh.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/lxc.sh.rst b/docs/utils/lxc.sh.rst index 44ab79030..9ca9b6bc0 100644 --- a/docs/utils/lxc.sh.rst +++ b/docs/utils/lxc.sh.rst @@ -81,17 +81,19 @@ command. To test instances from containers just open the URLs in your WEB-Browser:: $ sudo ./utils/lxc.sh show suite | grep filtron - [searx-ubu1604] INFO: (eth0) filtron: http://n.n.n.135:4004/ - [searx-ubu1804] INFO: (eth0) filtron: http://n.n.n.141:4004/ - [searx-ubu1910] INFO: (eth0) filtron: http://n.n.n.137:4004/ - [searx-ubu2004] INFO: (eth0) filtron: http://n.n.n.127:4004/ - [searx-fedora31] INFO: (eth0) filtron: http://n.n.n.18:4004/ - [searx-archlinux] INFO: (eth0) filtron: http://n.n.n.12:4004/ + [searx-ubu1604] INFO: (eth0) filtron: http://n.n.n.246:4004/ http://n.n.n.246/searx + [searx-ubu1804] INFO: (eth0) filtron: http://n.n.n.147:4004/ http://n.n.n.147/searx + [searx-ubu1910] INFO: (eth0) filtron: http://n.n.n.140:4004/ http://n.n.n.140/searx + [searx-ubu2004] INFO: (eth0) filtron: http://n.n.n.18:4004/ http://n.n.n.18/searx + [searx-fedora31] INFO: (eth0) filtron: http://n.n.n.46:4004/ http://n.n.n.46/searx + [searx-archlinux] INFO: (eth0) filtron: http://n.n.n.32:4004/ http://n.n.n.32/searx -To install a reverse proxy for filtron and morty use:: +To :ref:`install a nginx ` reverse proxy for filtron and +morty use (or alternatively use :ref:`apache `):: + + sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh nginx install + sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/morty.sh nginx install - sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install - sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/morty.sh apache install Running commands ================ -- cgit v1.2.3 From 4f7a6c09dd1b799a53a25166b49d23adceccea7d Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 18 Jun 2020 18:39:56 +0200 Subject: [fix] buildhosts documentation Signed-off-by: Markus Heiser --- docs/utils/lxc.sh.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/lxc.sh.rst b/docs/utils/lxc.sh.rst index 9ca9b6bc0..ae1412870 100644 --- a/docs/utils/lxc.sh.rst +++ b/docs/utils/lxc.sh.rst @@ -102,7 +102,7 @@ Running commands :ref:`toolboxing`. By example: to setup a :ref:`buildhosts` and run the Makefile target ``test`` in the archlinux_ container:: - sudo -H ./utils/lxc.sh cmd searx-archlinux ./utils/searx.sh buildhost + sudo -H ./utils/lxc.sh cmd searx-archlinux ./utils/searx.sh install buildhost sudo -H ./utils/lxc.sh cmd searx-archlinux make test @@ -114,7 +114,7 @@ The installation procedure to set up a :ref:`build host` takes its time. Installation in all containers will take more time (time for another cup of coffee).:: - sudo -H ./utils/lxc.sh cmd -- ./utils/searx.sh buildhost + sudo -H ./utils/lxc.sh cmd -- ./utils/searx.sh install buildhost To build (live) documentation inside a archlinux_ container:: -- cgit v1.2.3 From bfef2c3b65aea8dd3485e0959e068d460577a841 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 18 Jun 2020 18:52:45 +0200 Subject: [fix] buildprocess of docs in LXC (containers) The $DOCS_BUILD variable (like all BUILD variables) in the lxc environment:: sudo -H ./utils/lxc.sh cmd searx-archlinux make docs is different from running build process in the HOST:: make docs with kernel-include directive we can use the environment variables in the reST documents to address the correct file location of the include. Signed-off-by: Markus Heiser --- docs/utils/filtron.sh.rst | 8 ++++---- docs/utils/morty.sh.rst | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'docs/utils') diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst index 6c83bdf78..86e3fa88a 100644 --- a/docs/utils/filtron.sh.rst +++ b/docs/utils/filtron.sh.rst @@ -41,7 +41,7 @@ into this user account: Create user =========== -.. include:: ../../build/docs/includes/filtron.rst +.. kernel-include:: $DOCS_BUILD/includes/filtron.rst :start-after: START create user :end-before: END create user @@ -49,7 +49,7 @@ Create user Install go ========== -.. include:: ../../build/docs/includes/filtron.rst +.. kernel-include:: $DOCS_BUILD/includes/filtron.rst :start-after: START install go :end-before: END install go @@ -61,11 +61,11 @@ Install :origin:`rules.json ` at ``/etc/filtron/rules.json`` (see :ref:`Sample configuration of filtron`) and install filtron software and systemd unit: -.. include:: ../../build/docs/includes/filtron.rst +.. kernel-include:: $DOCS_BUILD/includes/filtron.rst :start-after: START install filtron :end-before: END install filtron -.. include:: ../../build/docs/includes/filtron.rst +.. kernel-include:: $DOCS_BUILD/includes/filtron.rst :start-after: START install systemd unit :end-before: END install systemd unit diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst index 89629bea0..3bdf9bdd3 100644 --- a/docs/utils/morty.sh.rst +++ b/docs/utils/morty.sh.rst @@ -42,7 +42,7 @@ into this user account: Create user =========== -.. include:: ../../build/docs/includes/morty.rst +.. kernel-include:: $DOCS_BUILD/includes/morty.rst :start-after: START create user :end-before: END create user @@ -50,7 +50,7 @@ Create user Install go ========== -.. include:: ../../build/docs/includes/morty.rst +.. kernel-include:: $DOCS_BUILD/includes/morty.rst :start-after: START install go :end-before: END install go @@ -60,11 +60,11 @@ Install morty Install morty software and systemd unit: -.. include:: ../../build/docs/includes/morty.rst +.. kernel-include:: $DOCS_BUILD/includes/morty.rst :start-after: START install morty :end-before: END install morty -.. include:: ../../build/docs/includes/morty.rst +.. kernel-include:: $DOCS_BUILD/includes/morty.rst :start-after: START install systemd unit :end-before: END install systemd unit -- cgit v1.2.3