diff options
Diffstat (limited to 'docs/dev/plugins.rst')
| -rw-r--r-- | docs/dev/plugins.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/dev/plugins.rst b/docs/dev/plugins.rst index 2bf44f1..16262ea 100644 --- a/docs/dev/plugins.rst +++ b/docs/dev/plugins.rst @@ -30,6 +30,21 @@ Example plugin ctx['search'].suggestions.add('example') return True +External plugins +================ + +External plugins are standard python modules implementing all the requirements of the standard plugins. +Plugins can be enabled by adding them to :ref:`settings.yml`'s ``plugins`` section. +Example external plugin can be found `here <https://github.com/asciimoo/searx_external_plugin_example>`_. + +Register your plugin +==================== + +To enable your plugin register your plugin in +searx > plugin > __init__.py. +And at the bottom of the file add your plugin like. +``plugins.register(name_of_python_file)`` + Plugin entry points =================== |