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/searx.sh.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 docs/utils/searx.sh.rst (limited to 'docs/utils/searx.sh.rst') 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/searx.sh.rst | 53 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 50 insertions(+), 3 deletions(-) (limited to 'docs/utils/searx.sh.rst') 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/searx.sh.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) (limited to 'docs/utils/searx.sh.rst') 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 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/searx.sh.rst | 41 ++++++++++++++++++++++++----------------- 1 file changed, 24 insertions(+), 17 deletions(-) (limited to 'docs/utils/searx.sh.rst') 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 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/searx.sh.rst | 47 +++-------------------------------------------- 1 file changed, 3 insertions(+), 44 deletions(-) (limited to 'docs/utils/searx.sh.rst') 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