on master help sign in
[enh] add morty documentation
commit6cc9f5694979956fd54a695bff6d454ca17f721d authorAdam Tauber <asciimoo@gmail.com> dateTue 8 Aug 2017, 15:19 (9 years ago) parenteb023f1
2 files changed+22
docs/admin/morty.rst+21 docs/index.rst+1
docs/admin/morty.rstnew file+21
@@ -0,0 +1,21 @@
1+How to setup result proxy
2+=========================
3+
4+By default searx can only act as an image proxy for result images,
5+but it is possible to proxify all the result URLs with an external service,
6+`morty <https://github.com/asciimoo/morty>`__.
7+
8+To use this feature, morty has to be installed and activated in searx's ``settings.yml``.
9+
10+Add the following snippet to your ``settings.yml`` and restart searx:
11+
12+
13+.. code:: yaml
14+
15+ result_proxy:
16+ url : http://127.0.0.1:3000/
17+ key : your_morty_proxy_key
18+
19+``url`` is the address of the running morty service
20+
21+``key`` is an optional argument, see `morty's README <https://github.com/asciimoo/morty>`__ for more information.
docs/index.rst+1
@@ -40,6 +40,7 @@ Administrator documentation
4040 dev/install/installation
4141 admin/api
4242 admin/filtron
43+ admin/morty
4344
4445Developer documentation
4546-----------------------