README.rst 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. searx
  2. =====
  3. A privacy-respecting, hackable `metasearch
  4. engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__.
  5. Pronunciation: səːks
  6. List of `running
  7. instances <https://searx.space/>`__.
  8. See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information.
  9. |OpenCollective searx backers|
  10. |OpenCollective searx sponsors|
  11. Installation
  12. ~~~~~~~~~~~~
  13. With Docker
  14. -----------
  15. Go to the `searx-docker <https://github.com/searx/searx-docker>`__ project.
  16. Without Docker
  17. --------------
  18. For all of the details, follow this `step by step installation <https://asciimoo.github.io/searx/admin/installation.html>`__.
  19. Note: the documentation needs to be updated.
  20. If you are in a hurry
  21. ---------------------
  22. - clone the source:
  23. ``git clone https://github.com/asciimoo/searx.git && cd searx``
  24. - install dependencies: ``./manage.sh update_packages``
  25. - edit your
  26. `settings.yml <https://github.com/asciimoo/searx/blob/master/searx/settings.yml>`__
  27. (set your ``secret_key``!)
  28. - run ``python searx/webapp.py`` to start the application
  29. Bugs
  30. ~~~~
  31. Bugs or suggestions? Visit the `issue
  32. tracker <https://github.com/asciimoo/searx/issues>`__.
  33. `License <https://github.com/asciimoo/searx/blob/master/LICENSE>`__
  34. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35. More about searx
  36. ~~~~~~~~~~~~~~~~
  37. - `openhub <https://www.openhub.net/p/searx/>`__
  38. - `twitter <https://twitter.com/Searx_engine>`__
  39. - IRC: #searx @ freenode
  40. .. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg
  41. :target: https://opencollective.com/searx#backer
  42. .. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg
  43. :target: https://opencollective.com/searx#sponsor