SearXNG is a free internet metasearch engine which aggregates results from various search services and databases. Users are neither tracked nor profiled.
Go to file
Noémi Ványi cdc2f33972
Merge pull request #2074 from asciimoo/external-plugins
This is a second proposal to accomplish plugin decoupling. I think #1938 is highly complicated and does much more than this feature requires, so here is an alternative implementation for the same feature. Please review it and let me know your opinion.

This solution supports the use of any kind of standard python modules which implements the required attributes of a plugin, so new plugins can be installed by standard python tools (pip/setup.py).

Downsides:
 - Localization of plugins name/description isn't possible
 - Plugins have to be updated manually

## What does this PR do?

Implements external plugin extensibility.

## Why is this change important?

Makes us able to decouple plugins from searx.

## Related issues

#1938 #1716 #1878
2020-07-28 21:28:55 +02:00
dockerfiles [enh] update documentation about docker 2020-07-22 14:58:04 +02:00
docs [enh] add external plugin support 2020-07-28 13:10:40 +02:00
examples Fix whitespaces 2016-07-11 18:52:37 +07:00
searx [enh] copy atime_ns and mtime_ns of external plugin resources 2020-07-28 13:57:57 +02:00
tests Created new plugin type custom_results. Added new plugin bang_redirect (#2027) 2020-07-03 13:25:04 +00:00
utils [fix] external_bang - UnicodeDecodeError: 'ascii' codec can't decode (#2043) 2020-07-11 12:17:06 +02:00
.codecov.yml codecov : update the commit status 2017-09-28 19:43:58 +02:00
.config.sh tooling box: added nginx + polished bash scripts and environment 2020-04-13 11:34:28 +02:00
.coveragerc Cover searx.utils 2014-07-12 15:46:55 +02:00
.dir-locals.el .dir-locals.el: add some comments about jedi & EPC 2019-11-29 13:15:15 +01:00
.dockerignore [enh] update documentation about docker 2020-07-22 14:58:04 +02:00
.gitattributes [enh] add simple theme (WIP) 2017-08-06 16:04:21 +02:00
.gitignore Merge PR #1900 of https://github.com/asciimoo/searx into filtron 2020-03-29 13:03:27 +02:00
.landscape.yaml Add landscape.io configuration 2014-07-09 22:49:38 +02:00
.pylintrc boilerplate: add pylint / WIP: balance linting with pylint 2019-11-28 20:07:10 +01:00
.travis.yml [mod] remove py2 from travis tests 2020-07-09 17:42:54 +02:00
AUTHORS.rst [fix] typo 2020-07-09 23:52:56 +02:00
CHANGELOG.rst [enh] release v0.17.0 2020-07-09 17:31:28 +02:00
CONTRIBUTING.md Add PR template and contribution guidelines 2020-07-10 17:10:02 +02:00
Dockerfile Dockerfile: upgrade base to alpine 3.12 (#1983) 2020-07-11 12:07:51 +02:00
LICENSE [fix] full AGPLv3+ license according to #382 2015-07-04 18:23:54 +02:00
Makefile Merge branch 'master' of https://github.com/asciimoo/searx into csp-oscar-theme 2020-06-30 15:37:39 +02:00
PULL_REQUEST_TEMPLATE.md Add PR template and contribution guidelines 2020-07-10 17:10:02 +02:00
README.rst [README] searx, world's first gluten free search engine ;) 2020-05-12 15:02:53 +02:00
babel.cfg [enh] babel.cfg added 2014-01-22 00:15:42 +01:00
manage.sh Merge branch 'master' into fix/manage.sh 2020-04-29 12:55:13 +00:00
requirements-dev.txt Merge branch 'master' of https://github.com/asciimoo/searx into filtron 2020-03-04 12:11:58 +01:00
requirements.txt [mod] requirements.txt: upgrade dependency versions. 2020-04-08 15:58:26 +02:00
setup.py brands: add ISSUE_URL 2020-03-25 17:48:34 +01:00
tox.ini [enh] tox.ini added to rewrite standard pep8 rules 2015-01-02 12:26:21 +01:00

README.rst

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. SPDX-License-Identifier: AGPL-3.0-or-later

.. figure:: https://raw.githubusercontent.com/asciimoo/searx/master/searx/static/themes/oscar/img/logo_searx_a.png
   :target: https://asciimoo.github.io/searx/
   :alt: searX
   :width: 100%
   :align: center

-------

|searx install|
|searx homepage|
|searx wiki|
|AGPL License|
|Issues|
|commits|
|OpenCollective searx backers|
|OpenCollective searx sponsors|

Privacy-respecting, hackable `metasearch engine`_ / *pronunciation* **səːks**.

.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine

.. |searx install| image:: https://img.shields.io/badge/-install-blue
   :target: https://asciimoo.github.io/searx/admin/installation.html

.. |searx homepage| image:: https://img.shields.io/badge/-homepage-blue
   :target: https://asciimoo.github.io/searx

.. |searx wiki| image:: https://img.shields.io/badge/-wiki-blue
   :target: https://github.com/asciimoo/searx/wiki

.. |AGPL License|  image:: https://img.shields.io/badge/license-AGPL-blue.svg
   :target: https://github.com/asciimoo/searx/blob/master/LICENSE

.. |Issues| image:: https://img.shields.io/github/issues/asciimoo/searx?color=yellow&label=issues
   :target: https://github.com/asciimoo/searx/issues

.. |PR| image:: https://img.shields.io/github/issues-pr-raw/asciimoo/searx?color=yellow&label=PR
   :target: https://github.com/asciimoo/searx/pulls

.. |commits| image:: https://img.shields.io/github/commit-activity/y/asciimoo/searx?color=yellow&label=commits
   :target: https://github.com/asciimoo/searx/commits/master

.. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg
   :target: https://opencollective.com/searx#backer

.. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg
   :target: https://opencollective.com/searx#sponsor


If you are looking for running instances, ready to use, then visit searx.space_.

Otherwise jump to the user_, admin_ and developer_ handbooks you will find on
our homepage_.

.. _searx.space: https://searx.space
.. _user: https://asciimoo.github.io/searx/user
.. _admin: https://asciimoo.github.io/searx/admin
.. _developer: https://asciimoo.github.io/searx/dev
.. _homepage: https://asciimoo.github.io/searx

contact:
  openhub_ // twitter_ // IRC: #searx @ freenode

.. _openhub: https://www.openhub.net/p/searx
.. _twitter: https://twitter.com/Searx_engine

-------

|gluten free|

.. |gluten free| image:: https://forthebadge.com/images/featured/featured-gluten-free.svg