[enh] add morty documentation

Browse Source
This commit is contained in:
Adam Tauber 2017-08-08 15:19:02 +02:00
parent eb023f18ac
commit 6cc9f56949
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/admin/morty.rst Normal file
View File

@ -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
docs/index.rst
View File

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