forked from zaclys/searxng
doc: installation.rst improve reST markup
- normalize section header markup - limit all lines to a maximum of 79 characters - add option -H to the sudo command used in code blocks - place *WARNING* lines into a '.. warning::' admonition block - make use of ``literal`` markup for monospace rendering - drop useless indentation of lists [1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser
parent
0a7479f194
commit
5b14772b20
|
|
@ -1,5 +1,6 @@
|
||||||
.. _installation:
|
.. _installation:
|
||||||
|
|
||||||
|
============
|
||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
|
|
@ -7,37 +8,44 @@ Installation
|
||||||
:depth: 3
|
:depth: 3
|
||||||
|
|
||||||
Basic installation
|
Basic installation
|
||||||
------------------
|
==================
|
||||||
|
|
||||||
Step by step installation for Debian/Ubuntu with virtualenv. For Ubuntu, be sure to have enable universe repository.
|
Step by step installation for Debian/Ubuntu with virtualenv. For Ubuntu, be sure
|
||||||
|
to have enable universe repository.
|
||||||
|
|
||||||
Install packages:
|
Install packages:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo apt-get install git build-essential libxslt-dev python-dev python-virtualenv python-babel zlib1g-dev libffi-dev libssl-dev
|
$ sudo -H apt-get install \
|
||||||
|
git build-essential libxslt-dev \
|
||||||
|
python-dev python-virtualenv python-babel \
|
||||||
|
zlib1g-dev libffi-dev libssl-dev
|
||||||
|
|
||||||
Install searx:
|
Install searx:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
cd /usr/local
|
cd /usr/local
|
||||||
sudo git clone https://github.com/asciimoo/searx.git
|
sudo -H git clone https://github.com/asciimoo/searx.git
|
||||||
sudo useradd searx -d /usr/local/searx
|
sudo -H useradd searx -d /usr/local/searx
|
||||||
sudo chown searx:searx -R /usr/local/searx
|
sudo -H chown searx:searx -R /usr/local/searx
|
||||||
|
|
||||||
Install dependencies in a virtualenv:
|
Install dependencies in a virtualenv:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo -u searx -i
|
|
||||||
cd /usr/local/searx
|
cd /usr/local/searx
|
||||||
virtualenv searx-ve
|
sudo -H -u searx -i
|
||||||
. ./searx-ve/bin/activate
|
|
||||||
./manage.sh update_packages
|
.. code:: sh
|
||||||
|
|
||||||
|
(searx)$ virtualenv searx-ve
|
||||||
|
(searx)$ . ./searx-ve/bin/activate
|
||||||
|
(searx)$ ./manage.sh update_packages
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
-------------
|
==============
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
|
|
@ -46,7 +54,7 @@ Configuration
|
||||||
Edit searx/settings.yml if necessary.
|
Edit searx/settings.yml if necessary.
|
||||||
|
|
||||||
Check
|
Check
|
||||||
-----
|
=====
|
||||||
|
|
||||||
Start searx:
|
Start searx:
|
||||||
|
|
||||||
|
|
@ -68,18 +76,19 @@ You can exit the virtualenv and the searx user bash (enter exit command
|
||||||
twice).
|
twice).
|
||||||
|
|
||||||
uwsgi
|
uwsgi
|
||||||
-----
|
=====
|
||||||
|
|
||||||
Install packages:
|
Install packages:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo apt-get install uwsgi uwsgi-plugin-python
|
sudo -H apt-get install \
|
||||||
|
uwsgi uwsgi-plugin-python
|
||||||
|
|
||||||
Create the configuration file /etc/uwsgi/apps-available/searx.ini with
|
Create the configuration file ``/etc/uwsgi/apps-available/searx.ini`` with this
|
||||||
this content:
|
content:
|
||||||
|
|
||||||
::
|
.. code:: ini
|
||||||
|
|
||||||
[uwsgi]
|
[uwsgi]
|
||||||
# Who will run the code
|
# Who will run the code
|
||||||
|
|
@ -119,22 +128,22 @@ Activate the uwsgi application and restart:
|
||||||
/etc/init.d/uwsgi restart
|
/etc/init.d/uwsgi restart
|
||||||
|
|
||||||
Web server
|
Web server
|
||||||
----------
|
==========
|
||||||
|
|
||||||
with nginx
|
with nginx
|
||||||
^^^^^^^^^^
|
----------
|
||||||
|
|
||||||
If nginx is not installed (uwsgi will not work with the package
|
If nginx is not installed (uwsgi will not work with the package
|
||||||
nginx-light):
|
nginx-light):
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo apt-get install nginx
|
sudo -H apt-get install nginx
|
||||||
|
|
||||||
Hosted at /
|
Hosted at /
|
||||||
"""""""""""
|
~~~~~~~~~~~
|
||||||
|
|
||||||
Create the configuration file /etc/nginx/sites-available/searx with this
|
Create the configuration file ``/etc/nginx/sites-available/searx`` with this
|
||||||
content:
|
content:
|
||||||
|
|
||||||
.. code:: nginx
|
.. code:: nginx
|
||||||
|
|
@ -154,20 +163,20 @@ Create a symlink to sites-enabled:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo ln -s /etc/nginx/sites-available/searx /etc/nginx/sites-enabled/searx
|
sudo -H ln -s /etc/nginx/sites-available/searx /etc/nginx/sites-enabled/searx
|
||||||
|
|
||||||
Restart service:
|
Restart service:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo service nginx restart
|
sudo -H service nginx restart
|
||||||
sudo service uwsgi restart
|
sudo -H service uwsgi restart
|
||||||
|
|
||||||
from subdirectory URL (/searx)
|
from subdirectory URL (/searx)
|
||||||
""""""""""""""""""""""""""""""
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Add this configuration in the server config file
|
Add this configuration in the server config file
|
||||||
/etc/nginx/sites-enabled/default:
|
``/etc/nginx/sites-enabled/default``:
|
||||||
|
|
||||||
.. code:: nginx
|
.. code:: nginx
|
||||||
|
|
||||||
|
|
@ -183,10 +192,8 @@ Add this configuration in the server config file
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
OR
|
**OR** using reverse proxy (Please, note that reverse proxy advised to be used
|
||||||
|
in case of single-user or low-traffic instances.)
|
||||||
using reverse proxy
|
|
||||||
(Please, note that reverse proxy advised to be used in case of single-user or low-traffic instances.)
|
|
||||||
|
|
||||||
.. code:: nginx
|
.. code:: nginx
|
||||||
|
|
||||||
|
|
@ -200,9 +207,9 @@ using reverse proxy
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
Enable base\_url in searx/settings.yml
|
Enable ``base_url`` in ``searx/settings.yml``
|
||||||
|
|
||||||
::
|
.. code:: yaml
|
||||||
|
|
||||||
base_url : http://your.domain.tld/searx/
|
base_url : http://your.domain.tld/searx/
|
||||||
|
|
||||||
|
|
@ -210,18 +217,18 @@ Restart service:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo service nginx restart
|
sudo -H service nginx restart
|
||||||
sudo service uwsgi restart
|
sudo -H service uwsgi restart
|
||||||
|
|
||||||
disable logs
|
disable logs
|
||||||
~~~~~~~~~~~~
|
^^^^^^^^^^^^
|
||||||
|
|
||||||
for better privacy you can disable nginx logs about searx.
|
for better privacy you can disable nginx logs about searx.
|
||||||
|
|
||||||
how to proceed: below ``uwsgi_pass`` in
|
how to proceed: below ``uwsgi_pass`` in ``/etc/nginx/sites-available/default``
|
||||||
/etc/nginx/sites-available/default add
|
add:
|
||||||
|
|
||||||
::
|
.. code:: nginx
|
||||||
|
|
||||||
access_log /dev/null;
|
access_log /dev/null;
|
||||||
error_log /dev/null;
|
error_log /dev/null;
|
||||||
|
|
@ -230,19 +237,19 @@ Restart service:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo service nginx restart
|
sudo -H service nginx restart
|
||||||
|
|
||||||
with apache
|
with apache
|
||||||
^^^^^^^^^^^
|
-----------
|
||||||
|
|
||||||
Add wsgi mod:
|
Add wsgi mod:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo apt-get install libapache2-mod-uwsgi
|
sudo -H apt-get install libapache2-mod-uwsgi
|
||||||
sudo a2enmod uwsgi
|
sudo -H a2enmod uwsgi
|
||||||
|
|
||||||
Add this configuration in the file /etc/apache2/apache2.conf:
|
Add this configuration in the file ``/etc/apache2/apache2.conf``:
|
||||||
|
|
||||||
.. code:: apache
|
.. code:: apache
|
||||||
|
|
||||||
|
|
@ -252,27 +259,26 @@ Add this configuration in the file /etc/apache2/apache2.conf:
|
||||||
uWSGISocket /run/uwsgi/app/searx/socket
|
uWSGISocket /run/uwsgi/app/searx/socket
|
||||||
</Location>
|
</Location>
|
||||||
|
|
||||||
Note that if your instance of searx is not at the root, you should
|
Note that if your instance of searx is not at the root, you should change
|
||||||
change ``<Location />`` by the location of your instance, like
|
``<Location />`` by the location of your instance, like ``<Location /searx>``.
|
||||||
``<Location /searx>``.
|
|
||||||
|
|
||||||
Restart Apache:
|
Restart Apache:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo /etc/init.d/apache2 restart
|
sudo -H /etc/init.d/apache2 restart
|
||||||
|
|
||||||
disable logs
|
disable logs
|
||||||
""""""""""""
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
For better privacy you can disable Apache logs.
|
For better privacy you can disable Apache logs.
|
||||||
|
|
||||||
WARNING: not tested
|
.. warning::
|
||||||
|
|
||||||
WARNING: you can only disable logs for the whole (virtual) server not
|
You can only disable logs for the whole (virtual) server not for a specific
|
||||||
for a specific path.
|
path.
|
||||||
|
|
||||||
Go back to /etc/apache2/apache2.conf and above ``<Location />`` add:
|
Go back to ``/etc/apache2/apache2.conf`` and above ``<Location />`` add:
|
||||||
|
|
||||||
.. code:: apache
|
.. code:: apache
|
||||||
|
|
||||||
|
|
@ -282,24 +288,30 @@ Restart Apache:
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
sudo /etc/init.d/apache2 restart
|
sudo -H /etc/init.d/apache2 restart
|
||||||
|
|
||||||
How to update
|
How to update
|
||||||
-------------
|
=============
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
cd /usr/local/searx
|
cd /usr/local/searx
|
||||||
sudo -u searx -i
|
sudo -H -u searx -i
|
||||||
. ./searx-ve/bin/activate
|
|
||||||
git stash
|
.. code:: sh
|
||||||
git pull origin master
|
|
||||||
git stash apply
|
(searx)$ . ./searx-ve/bin/activate
|
||||||
./manage.sh update_packages
|
(searx)$ git stash
|
||||||
sudo service uwsgi restart
|
(searx)$ git pull origin master
|
||||||
|
(searx)$ git stash apply
|
||||||
|
(searx)$ ./manage.sh update_packages
|
||||||
|
|
||||||
|
.. code:: sh
|
||||||
|
|
||||||
|
sudo -H service uwsgi restart
|
||||||
|
|
||||||
Docker
|
Docker
|
||||||
------
|
======
|
||||||
|
|
||||||
Make sure you have installed Docker. For instance, you can deploy searx like this:
|
Make sure you have installed Docker. For instance, you can deploy searx like this:
|
||||||
|
|
||||||
|
|
@ -308,11 +320,10 @@ Make sure you have installed Docker. For instance, you can deploy searx like thi
|
||||||
docker pull wonderfall/searx
|
docker pull wonderfall/searx
|
||||||
docker run -d --name searx -p $PORT:8888 wonderfall/searx
|
docker run -d --name searx -p $PORT:8888 wonderfall/searx
|
||||||
|
|
||||||
Go to http://localhost:$PORT.
|
Go to ``http://localhost:$PORT``.
|
||||||
|
|
||||||
See https://hub.docker.com/r/wonderfall/searx/ for more informations.
|
See https://hub.docker.com/r/wonderfall/searx/ for more informations. It's also
|
||||||
|
possible to build searx from the embedded Dockerfile.
|
||||||
It's also possible to build searx from the embedded Dockerfile.
|
|
||||||
|
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
|
|
@ -323,7 +334,8 @@ It's also possible to build searx from the embedded Dockerfile.
|
||||||
References
|
References
|
||||||
==========
|
==========
|
||||||
|
|
||||||
* https://about.okhin.fr/posts/Searx/ with some additions
|
* https://about.okhin.fr/posts/Searx/ with some additions
|
||||||
|
|
||||||
* How to: `Setup searx in a couple of hours with a free SSL certificate <https://www.reddit.com/r/privacytoolsIO/comments/366kvn/how_to_setup_your_own_privacy_respecting_search/>`__
|
* How to: `Setup searx in a couple of hours with a free SSL certificate
|
||||||
|
<https://www.reddit.com/r/privacytoolsIO/comments/366kvn/how_to_setup_your_own_privacy_respecting_search/>`__
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue