git.iko.soy/searx
on master help sign in
[doc] improve admin-docs about result proxy (morty) configuration
a69a8a3Markus Heiser
docs/admin/installation-apache.rst+8−7
compare with master
unifiedsplit
@@ -180,10 +180,6 @@ modules and create a `Location`_ configuration for the searx site. In most
180distributions you have to un-comment the lines in the main configuration file,
180distributions you have to un-comment the lines in the main configuration file,
181except in :ref:`The Debian Layout`.
181except in :ref:`The Debian Layout`.
182
182
183−To pass the HTTP HOST header
184−With ProxyPreserveHost_ the incoming Host HTTP request header is passed to the
185−proxied host.
186−
187.. tabs::
183.. tabs::
188
184
189 .. group-tab:: Ubuntu / debian
185 .. group-tab:: Ubuntu / debian
@@ -231,6 +227,11 @@ proxied host.
231 LoadModule proxy_module modules/mod_proxy.so
227 LoadModule proxy_module modules/mod_proxy.so
232 LoadModule proxy_http_module modules/mod_proxy_http.so
228 LoadModule proxy_http_module modules/mod_proxy_http.so
233
229
230+With ProxyPreserveHost_ the incoming Host HTTP request header is passed to the
231+proxied host.
232+
233+.. _apache searx via filtron plus morty:
234+
234.. tabs::
235.. tabs::
235
236
236 .. group-tab:: searx via filtron plus morty
237 .. group-tab:: searx via filtron plus morty
@@ -285,15 +286,15 @@ proxied host.
285
286
286 </Location>
287 </Location>
287
288
288− Note that reverse proxy advised to be used in case of single-user or
289− low-traffic instances. For a fully result proxification add :ref:`morty's
289+ For a fully result proxification add :ref:`morty's <searx morty>` **public
290− <searx morty>` **public URL** to your :origin:`searx/settings.yml`:
290+ URL** to your :origin:`searx/settings.yml`:
291
291
292 .. code:: yaml
292 .. code:: yaml
293
293
294 result_proxy:
294 result_proxy:
295 # replace example.org with your server's public name
295 # replace example.org with your server's public name
296 url : https://example.org/morty
296 url : https://example.org/morty
297+ key : !!binary "insert_your_morty_proxy_key_here"
297
298
298 server:
299 server:
299 image_proxy : True
300 image_proxy : True
docs/admin/installation-nginx.rst+6−4
@@ -163,6 +163,8 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
163 Create configuration at ``/etc/nginx/conf.d/searx`` and place a
163 Create configuration at ``/etc/nginx/conf.d/searx`` and place a
164 symlink to sites-enabled:
164 symlink to sites-enabled:
165
165
166+.. _nginx searx via filtron plus morty:
167+
166.. tabs::
168.. tabs::
167
169
168 .. group-tab:: searx via filtron plus morty
170 .. group-tab:: searx via filtron plus morty
@@ -210,21 +212,21 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
210 proxy_set_header X-Scheme $scheme;
212 proxy_set_header X-Scheme $scheme;
211 }
213 }
212
214
213− Note that reverse proxy advised to be used in case of single-user or
214− low-traffic instances. For a fully result proxification add :ref:`morty's
215+ For a fully result proxification add :ref:`morty's <searx morty>` **public
215− <searx morty>` **public URL** to your :origin:`searx/settings.yml`:
216+ URL** to your :origin:`searx/settings.yml`:
216
217
217 .. code:: yaml
218 .. code:: yaml
218
219
219 result_proxy:
220 result_proxy:
220 # replace example.org with your server's public name
221 # replace example.org with your server's public name
221 url : https://example.org/morty
222 url : https://example.org/morty
223+ key : !!binary "insert_your_morty_proxy_key_here"
222
224
223 server:
225 server:
224 image_proxy : True
226 image_proxy : True
225
227
226
228
227− .. group-tab:: proxy or uWSGI
229+ .. group-tab:: proxy or uWSGI
228
230
229 Be warned, with this setup, your instance isn't :ref:`protected <searx
231 Be warned, with this setup, your instance isn't :ref:`protected <searx
230 filtron>`. Nevertheless it is good enough for intranet usage and it is a
232 filtron>`. Nevertheless it is good enough for intranet usage and it is a
docs/admin/morty.rst+11−4
@@ -16,15 +16,22 @@ By default searx can only act as an image proxy for result images, but it is
16possible to proxify all the result URLs with an external service, morty_.
16possible to proxify all the result URLs with an external service, morty_.
17
17
18To use this feature, morty has to be installed and activated in searx's
18To use this feature, morty has to be installed and activated in searx's
19−``settings.yml``.
20−
21−Add the following snippet to your ``settings.yml`` and restart searx:
19+``settings.yml``. Add the following snippet to your ``settings.yml`` and
20+restart searx:
22
21
23.. code:: yaml
22.. code:: yaml
24
23
25 result_proxy:
24 result_proxy:
26 url : http://127.0.0.1:3000/
25 url : http://127.0.0.1:3000/
27− key : your_morty_proxy_key
26+ key : !!binary "insert_your_morty_proxy_key_here"
27+
28+Note that the example above (``http://127.0.0.1:3000``) is only for single-user
29+instances without a HTTP proxy. If your morty service is public, the url is the
30+address of the reverse proxy (e.g ``https://example.org/morty``).
31+
32+For more information about *result proxy* have a look at *"searx via filtron
33+plus morty"* in the :ref:`nginx <nginx searx via filtron plus morty>` and
34+:ref:`apache <apache searx via filtron plus morty>` sections.
28
35
29``url``
36``url``
30 Is the address of the running morty service.
37 Is the address of the running morty service.