diff options
| author | Adam Tauber <asciimoo@gmail.com> | 2017-08-08 15:19:02 +0200 |
|---|---|---|
| committer | Adam Tauber <asciimoo@gmail.com> | 2017-08-08 15:23:17 +0200 |
| commit | 6cc9f5694979956fd54a695bff6d454ca17f721d (patch) | |
| tree | 98b855a67191188418ab16de08e602bb04e21c2a | |
| parent | eb023f18ac77b1bdb3848854c51e2caab94c024e (diff) | |
| download | searxng-6cc9f5694979956fd54a695bff6d454ca17f721d.tar.gz searxng-6cc9f5694979956fd54a695bff6d454ca17f721d.zip | |
[enh] add morty documentation
| -rw-r--r-- | docs/admin/morty.rst | 21 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
2 files changed, 22 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. diff --git a/docs/index.rst b/docs/index.rst index abd57f08c..7854fdb01 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,6 +40,7 @@ Administrator documentation dev/install/installation admin/api admin/filtron + admin/morty Developer documentation ----------------------- |