git.iko.soy/searx
on master help sign in
[doc] improve admin-docs about result proxy (morty) configuration

[1] https://github.com/searx/searx/pull/1872#issuecomment-768107138 Suggested-by @dalf [1] Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

commita69a8a3ed5c2ecc714ba41ea95b3a4af6eee23d4 authorMarkus Heiser <markus.heiser@darmarit.de> dateWed 27 Jan 2021, 09:58 (6 years ago) parentf4a17ac
3 files changed+25−15
compare with master
unifiedsplit
docs/admin/installation-apache.rst+8−7 docs/admin/installation-nginx.rst+6−4 docs/admin/morty.rst+11−4
docs/admin/installation-apache.rst+8−7
@@ -180,10 +180,6 @@ modules and create a `Location`_ configuration for the searx site. In most
180180distributions you have to un-comment the lines in the main configuration file,
181181except in :ref:`The Debian Layout`.
182182
183−To pass the HTTP HOST header
184−With ProxyPreserveHost_ the incoming Host HTTP request header is passed to the
185−proxied host.
186−
187183.. tabs::
188184
189185 .. group-tab:: Ubuntu / debian
@@ -231,6 +227,11 @@ proxied host.
231227 LoadModule proxy_module modules/mod_proxy.so
232228 LoadModule proxy_http_module modules/mod_proxy_http.so
233229
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+
234235.. tabs::
235236
236237 .. group-tab:: searx via filtron plus morty
@@ -285,15 +286,15 @@ proxied host.
285286
286287 </Location>
287288
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
290− <searx morty>` **public URL** to your :origin:`searx/settings.yml`:
289+ For a fully result proxification add :ref:`morty's <searx morty>` **public
290+ URL** to your :origin:`searx/settings.yml`:
291291
292292 .. code:: yaml
293293
294294 result_proxy:
295295 # replace example.org with your server's public name
296296 url : https://example.org/morty
297+ key : !!binary "insert_your_morty_proxy_key_here"
297298
298299 server:
299300 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*.
163163 Create configuration at ``/etc/nginx/conf.d/searx`` and place a
164164 symlink to sites-enabled:
165165
166+.. _nginx searx via filtron plus morty:
167+
166168.. tabs::
167169
168170 .. group-tab:: searx via filtron plus morty
@@ -210,21 +212,21 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
210212 proxy_set_header X-Scheme $scheme;
211213 }
212214
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− <searx morty>` **public URL** to your :origin:`searx/settings.yml`:
215+ For a fully result proxification add :ref:`morty's <searx morty>` **public
216+ URL** to your :origin:`searx/settings.yml`:
216217
217218 .. code:: yaml
218219
219220 result_proxy:
220221 # replace example.org with your server's public name
221222 url : https://example.org/morty
223+ key : !!binary "insert_your_morty_proxy_key_here"
222224
223225 server:
224226 image_proxy : True
225227
226228
227− .. group-tab:: proxy or uWSGI
229+ .. group-tab:: proxy or uWSGI
228230
229231 Be warned, with this setup, your instance isn't :ref:`protected <searx
230232 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
1616possible to proxify all the result URLs with an external service, morty_.
1717
1818To 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:
2221
2322.. code:: yaml
2423
2524 result_proxy:
2625 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.
2835
2936``url``
3037 Is the address of the running morty service.