README.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. searx
  2. =====
  3. A privacy-respecting, hackable `metasearch
  4. engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__.
  5. List of `running
  6. instances <https://github.com/asciimoo/searx/wiki/Searx-instances>`__.
  7. See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information.
  8. |OpenCollective searx backers|
  9. |OpenCollective searx sponsors|
  10. Installation
  11. ~~~~~~~~~~~~
  12. - clone source:
  13. ``git clone https://github.com/asciimoo/searx.git && cd searx``
  14. - install dependencies: ``./manage.sh update_packages``
  15. - edit your
  16. `settings.yml <https://github.com/asciimoo/searx/blob/master/searx/settings.yml>`__
  17. (set your ``secret_key``!)
  18. - run ``python searx/webapp.py`` to start the application
  19. For all the details, follow this `step by step
  20. installation <https://github.com/asciimoo/searx/wiki/Installation>`__
  21. Bugs
  22. ~~~~
  23. Bugs or suggestions? Visit the `issue
  24. tracker <https://github.com/asciimoo/searx/issues>`__.
  25. `License <https://github.com/asciimoo/searx/blob/master/LICENSE>`__
  26. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  27. More about searx
  28. ~~~~~~~~~~~~~~~~
  29. - `ohloh <https://www.ohloh.net/p/searx/>`__
  30. - `twitter <https://twitter.com/Searx_engine>`__
  31. - IRC: #searx @ freenode
  32. .. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg
  33. :target: https://opencollective.com/searx#backer
  34. .. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg
  35. :target: https://opencollective.com/searx#sponsor