summaryrefslogtreecommitdiff
path: root/docs/admin/morty.rst
diff options
context:
space:
mode:
authorAdam Tauber <asciimoo@gmail.com>2017-08-08 15:19:02 +0200
committerAdam Tauber <asciimoo@gmail.com>2017-08-08 15:23:17 +0200
commit6cc9f5694979956fd54a695bff6d454ca17f721d (patch)
tree98b855a67191188418ab16de08e602bb04e21c2a /docs/admin/morty.rst
parenteb023f18ac77b1bdb3848854c51e2caab94c024e (diff)
downloadsearxng-6cc9f5694979956fd54a695bff6d454ca17f721d.tar.gz
searxng-6cc9f5694979956fd54a695bff6d454ca17f721d.zip
[enh] add morty documentation
Diffstat (limited to 'docs/admin/morty.rst')
-rw-r--r--docs/admin/morty.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/admin/morty.rst b/docs/admin/morty.rst
new file mode 100644
index 000000000..49e62bba9
--- /dev/null
+++ b/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.