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 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/utils/filtron.sh.rst (limited to 'docs/utils/filtron.sh.rst') 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 + -- 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 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) (limited to 'docs/utils/filtron.sh.rst') 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 -- 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 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/utils/filtron.sh.rst') 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 -- 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 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/utils/filtron.sh.rst') 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 ======== -- 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 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) (limited to 'docs/utils/filtron.sh.rst') 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 - -- 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/filtron.sh.rst') 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 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 ++----------------------------- 1 file changed, 2 insertions(+), 29 deletions(-) (limited to 'docs/utils/filtron.sh.rst') 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 -- 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 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/utils/filtron.sh.rst') 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 -- cgit v1.2.3