Browse Source

[enh] add morty documentation

Adam Tauber 7 years ago
parent
commit
6cc9f56949
2 changed files with 22 additions and 0 deletions
  1. 21 0
      docs/admin/morty.rst
  2. 1 0
      docs/index.rst

+ 21 - 0
docs/admin/morty.rst

@@ -0,0 +1,21 @@
+How to setup result proxy
+=========================
+
+By default searx can only act as an image proxy for result images,
+but it is possible to proxify all the result URLs with an external service,
+`morty <https://github.com/asciimoo/morty>`__.
+
+To use this feature, morty has to be installed and activated in searx's ``settings.yml``.
+
+Add the following snippet to your ``settings.yml`` and restart searx:
+
+
+.. code:: yaml
+
+    result_proxy:
+        url : http://127.0.0.1:3000/
+        key : your_morty_proxy_key
+
+``url`` is the address of the running morty service
+
+``key`` is an optional argument, see `morty's README <https://github.com/asciimoo/morty>`__ for more information.

+ 1 - 0
docs/index.rst

@@ -40,6 +40,7 @@ Administrator documentation
    dev/install/installation
    dev/install/installation
    admin/api
    admin/api
    admin/filtron
    admin/filtron
+   admin/morty
 
 
 Developer documentation
 Developer documentation
 -----------------------
 -----------------------