git.iko.soy/searx
on master help sign in
docs: revision of the installation instructions
eedd63cMarkus Heiser
docs/admin/buildhosts.rst+7−2
compare with master
unifiedsplit
@@ -4,13 +4,18 @@
4Buildhosts
4Buildhosts
5==========
5==========
6
6
7+To get best results from build, its recommend to install additional packages
8+on build hosts.
9+
7.. sidebar:: This article needs some work
10.. sidebar:: This article needs some work
8
11
9 If you have any contribution send us your :pull:`PR <../pulls>`, see
12 If you have any contribution send us your :pull:`PR <../pulls>`, see
10 :ref:`how to contribute`.
13 :ref:`how to contribute`.
11
14
12−To get best results from build, its recommend to install additional packages
15+.. contents:: Contents
13−on build hosts.
16+ :depth: 2
17+ :local:
18+ :backlinks: entry
14
19
15.. _docs build:
20.. _docs build:
16
21
docs/admin/filtron.rst+5
@@ -9,6 +9,11 @@ How to protect an instance
9
9
10 - :ref:`filtron.sh`
10 - :ref:`filtron.sh`
11
11
12+.. contents:: Contents
13+ :depth: 2
14+ :local:
15+ :backlinks: entry
16+
12.. _filtron: https://github.com/asciimoo/filtron
17.. _filtron: https://github.com/asciimoo/filtron
13
18
14Searx depens on external search services. To avoid the abuse of these services
19Searx depens on external search services. To avoid the abuse of these services
docs/admin/index.rst+4−1
@@ -3,9 +3,12 @@ Administrator documentation
3===========================
3===========================
4
4
5.. toctree::
5.. toctree::
6− :maxdepth: 1
6+ :maxdepth: 2
7+ :caption: Contents
7
8
8 installation
9 installation
10+ installation-nginx
11+ installation-apache
9 settings
12 settings
10 api
13 api
11 architecture
14 architecture
docs/admin/installation-apache.rstnew file+94
@@ -0,0 +1,94 @@
1+.. _installation apache:
2+
3+===================
4+Install with apache
5+===================
6+
7+.. sidebar:: public HTTP servers
8+
9+ On public searx instances use an application firewall (:ref:`filtron
10+ <filtron.sh>`).
11+
12+.. contents:: Contents
13+ :depth: 2
14+ :local:
15+ :backlinks: entry
16+
17+Add wsgi mod
18+============
19+
20+.. tabs::
21+
22+ .. group-tab:: Ubuntu / debian
23+
24+ .. code:: sh
25+
26+ sudo -H apt-get install libapache2-mod-uwsgi
27+ sudo -H a2enmod uwsgi
28+
29+Add this configuration in the file ``/etc/apache2/apache2.conf``. To limit
30+acces to your intranet replace ``Allow from all`` directive and replace
31+``192.168.0.0/16`` with your subnet IP/class.
32+
33+.. _inranet apache site:
34+
35+Note that if your instance of searx is not at the root, you should change
36+``<Location />`` by the location of your instance, like ``<Location /searx>``:
37+
38+.. code:: apache
39+
40+ # CustomLog /dev/null combined
41+
42+ <IfModule mod_uwsgi.c>
43+
44+ <Location />
45+
46+ Options FollowSymLinks Indexes
47+ SetHandler uwsgi-handler
48+ uWSGISocket /run/uwsgi/app/searx/socket
49+
50+ Order deny,allow
51+ Deny from all
52+ # Allow from fd00::/8 192.168.0.0/16 fe80::/10 127.0.0.0/8 ::1
53+ Allow from all
54+
55+ </Location>
56+
57+ </IfModule>
58+
59+Enable apache mod_uwsgi and restart apache:
60+
61+.. tabs::
62+
63+ .. group-tab:: Ubuntu / debian
64+
65+ .. code:: sh
66+
67+ a2enmod uwsgi
68+ sudo -H systemctl restart apache2
69+
70+disable logs
71+============
72+
73+For better privacy you can disable Apache logs. Go back to
74+``/etc/apache2/apache2.conf`` :ref:`[example] <inranet apache site>` and above
75+``<Location />`` activate directive:
76+
77+.. code:: apache
78+
79+ CustomLog /dev/null combined
80+
81+Restart apache:
82+
83+.. tabs::
84+
85+ .. group-tab:: Ubuntu / debian
86+
87+ .. code:: sh
88+
89+ sudo -H systemctl restart apache2
90+
91+.. warning::
92+
93+ You can only disable logs for the whole (virtual) server not for a specific
94+ path.
docs/admin/installation-nginx.rstnew file+141
@@ -0,0 +1,141 @@
1+.. _installation nginx:
2+
3+==================
4+Install with nginx
5+==================
6+
7+.. sidebar:: public HTTP servers
8+
9+ On public searx instances use an application firewall (:ref:`filtron
10+ <filtron.sh>`).
11+
12+.. contents:: Contents
13+ :depth: 2
14+ :local:
15+ :backlinks: entry
16+
17+If nginx is not installed (uwsgi will not work with the package
18+nginx-light):
19+
20+.. tabs::
21+
22+ .. group-tab:: Ubuntu / debian
23+
24+ .. code:: sh
25+
26+ sudo -H apt-get install nginx
27+
28+Hosted at ``/``
29+===============
30+
31+Create the configuration file ``/etc/nginx/sites-available/searx`` with this
32+content:
33+
34+.. code:: nginx
35+
36+ server {
37+ listen 80;
38+ server_name searx.example.com;
39+ root /usr/local/searx/searx;
40+
41+ location /static {
42+ }
43+
44+ location / {
45+ include uwsgi_params;
46+ uwsgi_pass unix:/run/uwsgi/app/searx/socket;
47+ }
48+ }
49+
50+Create a symlink to sites-enabled:
51+
52+.. code:: sh
53+
54+ sudo -H ln -s /etc/nginx/sites-available/searx /etc/nginx/sites-enabled/searx
55+
56+Restart service:
57+
58+.. tabs::
59+
60+ .. group-tab:: Ubuntu / debian
61+
62+ .. code:: sh
63+
64+ sudo -H systemctl restart nginx
65+ sudo -H systemctl restart uwsgi
66+
67+from subdirectory URL (``/searx``)
68+==================================
69+
70+Add this configuration in the server config file
71+``/etc/nginx/sites-enabled/default``:
72+
73+.. code:: nginx
74+
75+ location /searx/static {
76+ alias /usr/local/searx/searx/static;
77+ }
78+
79+ location /searx {
80+ uwsgi_param SCRIPT_NAME /searx;
81+ include uwsgi_params;
82+ uwsgi_pass unix:/run/uwsgi/app/searx/socket;
83+ }
84+
85+
86+**OR** using reverse proxy (Please, note that reverse proxy advised to be used
87+in case of single-user or low-traffic instances.)
88+
89+.. code:: nginx
90+
91+ location /searx/static {
92+ alias /usr/local/searx/searx/static;
93+ }
94+
95+ location /searx {
96+ proxy_pass http://127.0.0.1:8888;
97+ proxy_set_header Host $host;
98+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
99+ proxy_set_header X-Scheme $scheme;
100+ proxy_set_header X-Script-Name /searx;
101+ proxy_buffering off;
102+ }
103+
104+Enable ``base_url`` in ``searx/settings.yml``
105+
106+.. code:: yaml
107+
108+ base_url : http://your.domain.tld/searx/
109+
110+Restart service:
111+
112+.. tabs::
113+
114+ .. group-tab:: Ubuntu / debian
115+
116+ .. code:: sh
117+
118+ sudo -H systemctl restart nginx
119+ sudo -H systemctl restart uwsgi
120+
121+
122+disable logs
123+============
124+
125+For better privacy you can disable nginx logs about searx. How to proceed:
126+below ``uwsgi_pass`` in ``/etc/nginx/sites-available/default`` add:
127+
128+.. code:: nginx
129+
130+ access_log /dev/null;
131+ error_log /dev/null;
132+
133+Restart service:
134+
135+.. tabs::
136+
137+ .. group-tab:: Ubuntu / debian
138+
139+ .. code:: sh
140+
141+ sudo -H systemctl restart nginx
docs/admin/installation.rst+103−221
@@ -4,50 +4,64 @@
4Installation
4Installation
5============
5============
6
6
7+.. sidebar:: Searx server setup
8+
9+ - :ref:`installation nginx`
10+ - :ref:`installation apache`
11+
12+ If you do not have any special preferences, it is recommend to use
13+ :ref:`searx.sh`.
14+
7−.. contents::
15+.. contents:: Contents
8− :depth: 3
16+ :depth: 2
17+ :local:
18+ :backlinks: entry
9
19
10.. _installation basic:
20.. _installation basic:
11
21
12Basic installation
22Basic installation
13==================
23==================
14
24
15−.. sidebar:: further reading
25+Step by step installation with virtualenv. For Ubuntu, be sure to have enable
26+universe repository.
16
27
17− - :ref:`searx.sh`
28+Install packages:
18
29
19−Step by step installation for Debian/Ubuntu with virtualenv. For Ubuntu, be sure
30+.. tabs::
20−to have enable universe repository.
21
31
22−Install packages:
32+ .. group-tab:: Ubuntu / debian
23
33
24−.. code:: sh
34+ .. code-block:: sh
25
35
26− $ sudo -H apt-get install \
36+ $ sudo -H apt-get install \
27− git build-essential libxslt-dev \
37+ git build-essential
28− python-dev python-virtualenv python-babel \
38+ libxslt-dev python3-dev python3-babel \
29− zlib1g-dev libffi-dev libssl-dev
39+ zlib1g-dev libffi-dev libssl-dev
30
40
31Install searx:
41Install searx:
32
42
33.. code:: sh
43.. code:: sh
34
44
45+ sudo -H useradd searx --system --disabled-password -d /usr/local/searx
46+ sudo -H usermod -a -G shadow $SERVICE_USER
35− cd /usr/local
47+ cd /usr/local/searx
36− sudo -H git clone https://github.com/asciimoo/searx.git
48+ sudo -H git clone https://github.com/asciimoo/searx.git searx-src
37− sudo -H useradd searx -d /usr/local/searx
38 sudo -H chown searx:searx -R /usr/local/searx
49 sudo -H chown searx:searx -R /usr/local/searx
39
50
40−Install dependencies in a virtualenv:
51+Install virtualenv:
41
52
42.. code:: sh
53.. code:: sh
43
54
44− cd /usr/local/searx
45 sudo -H -u searx -i
55 sudo -H -u searx -i
56+ (searx)$ python3 -m venv searx-pyenv
57+ (searx)$ echo 'source ~/searx-pyenv/bin/activate' > ~/.profile
58+
59+Exit the searx bash and restart a new to install the searx dependencies:
46
60
47.. code:: sh
61.. code:: sh
48
62
49− (searx)$ virtualenv searx-ve
63+ sudo -H -u searx -i
50− (searx)$ . ./searx-ve/bin/activate
64+ (searx)$ cd searx-src
51 (searx)$ ./manage.sh update_packages
65 (searx)$ ./manage.sh update_packages
52
66
53Configuration
67Configuration
@@ -55,7 +69,9 @@ Configuration
55
69
56.. code:: sh
70.. code:: sh
57
71
72+ sudo -H -u searx -i
73+ (searx)$ cd searx-src
58− sed -i -e "s/ultrasecretkey/`openssl rand -hex 16`/g" searx/settings.yml
74+ (searx)$ sed -i -e "s/ultrasecretkey/`openssl rand -hex 16`/g" searx/settings.yml
59
75
60Edit searx/settings.yml if necessary.
76Edit searx/settings.yml if necessary.
61
77
@@ -66,7 +82,9 @@ Start searx:
66
82
67.. code:: sh
83.. code:: sh
68
84
85+ sudo -H -u searx -i
86+ (searx)$ cd searx-src
69− python searx/webapp.py
87+ (searx)$ python3 searx/webapp.py
70
88
71Go to http://localhost:8888
89Go to http://localhost:8888
72
90
@@ -76,254 +94,118 @@ If everything works fine, disable the debug option in settings.yml:
76
94
77 sed -i -e "s/debug : True/debug : False/g" searx/settings.yml
95 sed -i -e "s/debug : True/debug : False/g" searx/settings.yml
78
96
79−At this point searx is not demonized ; uwsgi allows this.
97+At this point searx is not demonized ; uwsgi allows this. You can exit the
80−
81−You can exit the virtualenv and the searx user bash (enter exit command
98+virtualenv and the searx user bash (enter exit command twice).
82−twice).
83
99
84uwsgi
100uwsgi
85=====
101=====
86
102
87Install packages:
103Install packages:
88
104
89−.. code:: sh
105+.. tabs::
90−
91− sudo -H apt-get install \
92− uwsgi uwsgi-plugin-python
93−
94−Create the configuration file ``/etc/uwsgi/apps-available/searx.ini`` with this
95−content:
96−
97−.. code:: ini
98−
99− [uwsgi]
100− # Who will run the code
101− uid = searx
102− gid = searx
103−
104− # disable logging for privacy
105− disable-logging = true
106−
107− # Number of workers (usually CPU count)
108− workers = 4
109−
110− # The right granted on the created socket
111− chmod-socket = 666
112
106
113− # Plugin to use and interpretor config
107+ .. group-tab:: Ubuntu / debian
114− single-interpreter = true
115− master = true
116− plugin = python
117− lazy-apps = true
118− enable-threads = true
119
108
120− # Module to import
109+ .. code-block:: bash
121− module = searx.webapp
122
110
123− # Support running the module from a webserver subdirectory.
111+ sudo -H apt-get install uwsgi uwsgi-plugin-python3
124− route-run = fixpathinfo:
125
112
126− # Virtualenv and python path
127− virtualenv = /usr/local/searx/searx-ve/
128− pythonpath = /usr/local/searx/
129− chdir = /usr/local/searx/searx/
130−
131−Activate the uwsgi application and restart:
132−
133−.. code:: sh
134−
135− cd /etc/uwsgi/apps-enabled
136− ln -s ../apps-available/searx.ini
137− /etc/init.d/uwsgi restart
138−
139−Web server
140−==========
141−
142−with nginx
143−----------
144−
145−If nginx is not installed (uwsgi will not work with the package
146−nginx-light):
147−
148−.. code:: sh
149−
150− sudo -H apt-get install nginx
151−
152−Hosted at /
153−~~~~~~~~~~~
154−
155−Create the configuration file ``/etc/nginx/sites-available/searx`` with this
113+Create the configuration file ``/etc/uwsgi/apps-available/searx.ini`` with this
156content:
114content:
157
115
158−.. code:: nginx
116+.. code:: ini
159−
160− server {
161− listen 80;
162− server_name searx.example.com;
163− root /usr/local/searx/searx;
164−
165− location /static {
166− }
167−
168− location / {
169− include uwsgi_params;
170− uwsgi_pass unix:/run/uwsgi/app/searx/socket;
171− }
172− }
173−
174−Create a symlink to sites-enabled:
175−
176−.. code:: sh
177−
178− sudo -H ln -s /etc/nginx/sites-available/searx /etc/nginx/sites-enabled/searx
179−
180−Restart service:
181−
182−.. code:: sh
183−
184− sudo -H service nginx restart
185− sudo -H service uwsgi restart
186−
187−from subdirectory URL (/searx)
188−~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
189−
190−Add this configuration in the server config file
191−``/etc/nginx/sites-enabled/default``:
192−
193−.. code:: nginx
194−
195− location /searx/static {
196− alias /usr/local/searx/searx/static;
197− }
198−
199− location /searx {
200− uwsgi_param SCRIPT_NAME /searx;
201− include uwsgi_params;
202− uwsgi_pass unix:/run/uwsgi/app/searx/socket;
203− }
204−
205−
206−**OR** using reverse proxy (Please, note that reverse proxy advised to be used
207−in case of single-user or low-traffic instances.)
208−
209−.. code:: nginx
210−
211− location /searx/static {
212− alias /usr/local/searx/searx/static;
213− }
214−
215− location /searx {
216− proxy_pass http://127.0.0.1:8888;
217− proxy_set_header Host $host;
218− proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
219− proxy_set_header X-Scheme $scheme;
220− proxy_set_header X-Script-Name /searx;
221− proxy_buffering off;
222− }
223−
224−
225−Enable ``base_url`` in ``searx/settings.yml``
226−
227−.. code:: yaml
228−
229− base_url : http://your.domain.tld/searx/
230
117
231−Restart service:
118+ [uwsgi]
232
119
233−.. code:: sh
120+ # uWSGI core
121+ # ----------
122+ #
123+ # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#uwsgi-core
234
124
235− sudo -H service nginx restart
125+ # Who will run the code
236− sudo -H service uwsgi restart
126+ uid = searx
127+ gid = searx
237
128
238−disable logs
129+ # chdir to specified directory before apps loading
239−^^^^^^^^^^^^
130+ chdir = /usr/local/searx/searx-src/searx
240
131
241−for better privacy you can disable nginx logs about searx.
132+ # disable logging for privacy
133+ disable-logging = true
242
134
243−how to proceed: below ``uwsgi_pass`` in ``/etc/nginx/sites-available/default``
135+ # The right granted on the created socket
244−add:
136+ chmod-socket = 666
245
137
246−.. code:: nginx
138+ # Plugin to use and interpretor config
139+ single-interpreter = true
247
140
248− access_log /dev/null;
141+ # enable master process
249− error_log /dev/null;
142+ master = true
250
143
251−Restart service:
144+ # load apps in each worker instead of the master
145+ lazy-apps = true
252
146
253−.. code:: sh
147+ # load uWSGI plugins
148+ plugin = python3,http
254
149
255− sudo -H service nginx restart
150+ # By default the Python plugin does not initialize the GIL. This means your
151+ # app-generated threads will not run. If you need threads, remember to enable
152+ # them with enable-threads. Running uWSGI in multithreading mode (with the
153+ # threads options) will automatically enable threading support. This *strange*
154+ # default behaviour is for performance reasons.
155+ enable-threads = true
256
156
257−with apache
157+ # plugin: python
258−-----------
158+ # --------------
159+ #
160+ # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-python
259
161
260−Add wsgi mod:
162+ # load a WSGI module
163+ module = searx.webapp
261
164
262−.. code:: sh
165+ # set PYTHONHOME/virtualenv
166+ virtualenv = /usr/local/searx/searx-pyenv
263
167
264− sudo -H apt-get install libapache2-mod-uwsgi
168+ # add directory (or glob) to pythonpath
265− sudo -H a2enmod uwsgi
169+ pythonpath = /usr/local/searx/searx-src
266
170
267−Add this configuration in the file ``/etc/apache2/apache2.conf``:
268
171
269−.. code:: apache
172+ # plugin http
173+ # -----------
174+ #
175+ # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-http
270
176
271− <Location />
177+ # Native HTTP support: https://uwsgi-docs.readthedocs.io/en/latest/HTTP.html
272− Options FollowSymLinks Indexes
178+ http = 127.0.0.1:8888
273− SetHandler uwsgi-handler
274− uWSGISocket /run/uwsgi/app/searx/socket
275− </Location>
276
179
277−Note that if your instance of searx is not at the root, you should change
180+Activate the uwsgi application and restart:
278−``<Location />`` by the location of your instance, like ``<Location /searx>``.
279−
280−Restart Apache:
281
181
282.. code:: sh
182.. code:: sh
283
183
184+ cd /etc/uwsgi/apps-enabled
185+ ln -s ../apps-available/searx.ini
284− sudo -H /etc/init.d/apache2 restart
186+ /etc/init.d/uwsgi restart
285−
286−disable logs
287−~~~~~~~~~~~~
288−
289−For better privacy you can disable Apache logs.
290−
291−.. warning::
292−
293− You can only disable logs for the whole (virtual) server not for a specific
294− path.
295−
296−Go back to ``/etc/apache2/apache2.conf`` and above ``<Location />`` add:
297−
298−.. code:: apache
299−
300− CustomLog /dev/null combined
301−
302−Restart Apache:
303−
304−.. code:: sh
305
187
306− sudo -H /etc/init.d/apache2 restart
307
188
308How to update
189How to update
309=============
190=============
310
191
311.. code:: sh
192.. code:: sh
312
193
313− cd /usr/local/searx
314 sudo -H -u searx -i
194 sudo -H -u searx -i
315−
316−.. code:: sh
317−
318− (searx)$ . ./searx-ve/bin/activate
319 (searx)$ git stash
195 (searx)$ git stash
320 (searx)$ git pull origin master
196 (searx)$ git pull origin master
321 (searx)$ git stash apply
197 (searx)$ git stash apply
322 (searx)$ ./manage.sh update_packages
198 (searx)$ ./manage.sh update_packages
323
199
200+Restart uwsgi:
201+
202+.. tabs::
203+
204+ .. group-tab:: Ubuntu / debian
205+
324−.. code:: sh
206+ .. code:: sh
325
207
326− sudo -H service uwsgi restart
208+ sudo -H systemctl restart uwsgi
327
209
328Docker
210Docker
329======
211======
docs/admin/settings.rst+7−1
@@ -4,11 +4,17 @@
4``settings.yml``
4``settings.yml``
5================
5================
6
6
7+This page describe the options possibilities of the :origin:`searx/settings.yml`
8+file.
9+
7.. sidebar:: Further reading ..
10.. sidebar:: Further reading ..
8
11
9 - :ref:`search API`
12 - :ref:`search API`
10
13
11−This page describe the options possibilities of the settings.yml file.
14+.. contents:: Contents
15+ :depth: 2
16+ :local:
17+ :backlinks: entry
12
18
13.. _settings global:
19.. _settings global:
14
20
docs/blog/index.rst+2−1
@@ -3,7 +3,8 @@ Blog
3====
3====
4
4
5.. toctree::
5.. toctree::
6− :maxdepth: 1
6+ :maxdepth: 2
7+ :caption: Contents
7
8
8 python3
9 python3
9 admin
10 admin
docs/dev/contribution_guide.rst+5
@@ -4,6 +4,11 @@
4How to contribute
4How to contribute
5=================
5=================
6
6
7+.. contents:: Contents
8+ :depth: 2
9+ :local:
10+ :backlinks: entry
11+
7Prime directives: Privacy, Hackability
12Prime directives: Privacy, Hackability
8======================================
13======================================
9
14
docs/dev/index.rst+2−1
@@ -3,7 +3,8 @@ Developer documentation
3=======================
3=======================
4
4
5.. toctree::
5.. toctree::
6− :maxdepth: 1
6+ :maxdepth: 2
7+ :caption: Contents
7
8
8 quickstart
9 quickstart
9 contribution_guide
10 contribution_guide
docs/index.rst+9−8
@@ -2,7 +2,14 @@
2Welcome to searx
2Welcome to searx
3================
3================
4
4
5−Search without being tracked.
5+ *Search without being tracked.*
6+
7+Searx is a free internet metasearch engine which aggregates results from more
8+than 70 search services. Users are neither tracked nor profiled. Additionally,
9+searx can be used over Tor for online anonymity.
10+
11+Get started with searx by using one of the :wiki:`Searx-instances`. If you
12+don't trust anyone, you can set up your own, see :ref:`installation`.
6
13
7.. sidebar:: Features
14.. sidebar:: Features
8
15
@@ -16,15 +23,9 @@ Search without being tracked.
16 - Hosted by organizations, such as *La Quadrature du Net*, which promote
23 - Hosted by organizations, such as *La Quadrature du Net*, which promote
17 digital rights
24 digital rights
18
25
19−Searx is a free internet metasearch engine which aggregates results from more
20−than 70 search services. Users are neither tracked nor profiled. Additionally,
21−searx can be used over Tor for online anonymity.
22−
23−Get started with searx by using one of the :wiki:`Searx-instances`. If you
24−don't trust anyone, you can set up your own, see :ref:`installation`.
25−
26.. toctree::
26.. toctree::
27 :maxdepth: 2
27 :maxdepth: 2
28+ :caption: Contents
28
29
29 user/index
30 user/index
30 admin/index
31 admin/index
docs/user/index.rst+2−1
@@ -3,7 +3,8 @@ User documentation
3==================
3==================
4
4
5.. toctree::
5.. toctree::
6− :maxdepth: 1
6+ :maxdepth: 2
7+ :caption: Contents
7
8
8 public_instances
9 public_instances
9 search_syntax
10 search_syntax
docs/user/own-instance.rst+4−2
@@ -2,8 +2,10 @@
2Why use a private instance?
2Why use a private instance?
3===========================
3===========================
4
4
5−"Is it worth to run my own instance?" is a common question among searx users.
5+ *"Is it worth to run my own instance?"*
6+
7+\.\. is a common question among searx users. Before answering this question,
6−Before answering this question, see what options a searx user has.
8+see what options a searx user has.
7
9
8Public instances are open to everyone who has access to its URL. Usually, these
10Public instances are open to everyone who has access to its URL. Usually, these
9are operated by unknown parties (from the users' point of view). Private
11are operated by unknown parties (from the users' point of view). Private
docs/user/public_instances.rst+6−2
@@ -1,16 +1,20 @@
1−.. _public instances:
2−
3..
1..
4 links has been ported from markdown to reST by::
2 links has been ported from markdown to reST by::
5
3
6 regexpr: \[([^\]]*)\]\(([^)]*)\)
4 regexpr: \[([^\]]*)\]\(([^)]*)\)
7 substitution: `\1 <\2>`__
5 substitution: `\1 <\2>`__
8
6
7+.. _public instances:
9
8
10======================
9======================
11Public Searx instances
10Public Searx instances
12======================
11======================
13
12
13+.. contents:: Contents
14+ :depth: 2
15+ :local:
16+ :backlinks: entry
17+
14.. _mailing list: mailto:searx-instances@autistici.org
18.. _mailing list: mailto:searx-instances@autistici.org
15.. _subscription page: https://www.autistici.org/mailman/listinfo/searx-instances
19.. _subscription page: https://www.autistici.org/mailman/listinfo/searx-instances
16
20
docs/utils/filtron.sh.rst+1−2
@@ -7,6 +7,7 @@
7
7
8.. sidebar:: further reading
8.. sidebar:: further reading
9
9
10+ - :ref:`installation`
10 - :ref:`searx_filtron`
11 - :ref:`searx_filtron`
11 - :ref:`architecture`
12 - :ref:`architecture`
12
13
@@ -40,8 +41,6 @@ into this user account:
40Public Reverse Proxy
41Public Reverse Proxy
41====================
42====================
42
43
43−.. tabs::
44−
45To install searx in your public HTTP server use:
44To install searx in your public HTTP server use:
46
45
47.. code:: bash
46.. code:: bash
docs/utils/index.rst+10−9
@@ -6,24 +6,25 @@
6Tooling box ``utils/*``
6Tooling box ``utils/*``
7=======================
7=======================
8
8
9+.. sidebar:: Work needed!
10+
11+ Our scripts to maintain services do most support only systemd init process
12+ used by debian, ubuntu and many other dists. In general our scripts are only
13+ partially usable on debian systems. We are working on this limitation, if
14+ you have any contribution, please send us your :pull:`PR <../pulls>`, see
15+ :ref:`how to contribute`.
16+
9In the folder :origin:`utils/` we maintain some tools useful for admins and
17In the folder :origin:`utils/` we maintain some tools useful for admins and
10developers.
18developers.
11
19
12.. toctree::
20.. toctree::
13− :maxdepth: 1
21+ :maxdepth: 2
22+ :caption: Contents
14
23
15 searx.sh
24 searx.sh
16 filtron.sh
25 filtron.sh
17 morty.sh
26 morty.sh
18
27
19−.. admonition:: Work needed!
20−
21− Our scripts to maintain services do most support only systemd init process
22− used by debian, ubuntu and many other dists. In general our scripts are only
23− partially usable on debian systems. We are working on this limitation, if
24− you have any contribution, please send us your :pull:`PR <../pulls>`, see
25− :ref:`how to contribute`.
26−
27.. _toolboxing common:
28.. _toolboxing common:
28
29
29Common commands
30Common commands
docs/utils/morty.sh.rst+1
@@ -10,6 +10,7 @@
10
10
11.. sidebar:: further reading
11.. sidebar:: further reading
12
12
13+ - :ref:`installation`
13 - :ref:`architecture`
14 - :ref:`architecture`
14
15
15To simplify installation and maintenance of a morty_ instance you can use the
16To simplify installation and maintenance of a morty_ instance you can use the
docs/utils/searx.sh.rst+12−7
@@ -9,10 +9,15 @@
9
9
10 - :ref:`installation`
10 - :ref:`installation`
11 - :ref:`architecture`
11 - :ref:`architecture`
12+ - :ref:`filtron.sh`
12
13
13To simplify installation and maintenance of a searx instance you can use the
14To simplify installation and maintenance of a searx instance you can use the
15+script :origin:`utils/searx.sh`.
16+
17+Install
18+=======
19+
14−script :origin:`utils/searx.sh`. In most cases you will install searx simply by
20+In most cases you will install searx simply by running the command:
15−running the command:
16
21
17.. code:: bash
22.. code:: bash
18
23
@@ -27,17 +32,17 @@ into this user account. The installation is described in chapter
27Intranet Reverse Proxy
32Intranet Reverse Proxy
28======================
33======================
29
34
30−.. warning::
31−
32− This setup is **not** suitable **for public instances**, go on with
33− :ref:`reverse proxy`!
34−
35To install searx in your intranet HTTP server use:
35To install searx in your intranet HTTP server use:
36
36
37.. code:: bash
37.. code:: bash
38
38
39 sudo -H ./utils/searx.sh apache install
39 sudo -H ./utils/searx.sh apache install
40
40
41+.. warning::
42+
43+ This setup is **not** suitable **for public instances**, go on with
44+ :ref:`reverse proxy`!
45+
41.. tabs::
46.. tabs::
42
47
43 .. group-tab:: apache
48 .. group-tab:: apache
utils/searx.sh+3−2
@@ -39,8 +39,9 @@ SEARX_UWSGI_SOCKET="/run/uwsgi/app/searx/socket"
39
39
40SEARX_APT_PACKAGES="\
40SEARX_APT_PACKAGES="\
41 uwsgi uwsgi-plugin-python3 \
41 uwsgi uwsgi-plugin-python3 \
42+ git build-essential \
42− git build-essential libxslt-dev python3-dev python3-babel zlib1g-dev \
43+ libxslt-dev python3-dev python3-babel\
43− libffi-dev libssl-dev \
44+ zlib1g-dev libffi-dev libssl-dev \
44"
45"
45
46
46# Apache Settings
47# Apache Settings