README.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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. |Flattr searx|
  9. Installation
  10. ~~~~~~~~~~~~
  11. - clone source:
  12. ``git clone git@github.com:asciimoo/searx.git && cd searx``
  13. - install dependencies: ``./manage.sh update_packages``
  14. - edit your
  15. `settings.yml <https://github.com/asciimoo/searx/blob/master/settings.yml>`__
  16. (set your ``secret_key``!)
  17. - run ``python searx/webapp.py`` to start the application
  18. For all the details, follow this `step by step
  19. installation <https://github.com/asciimoo/searx/wiki/Installation>`__
  20. Bugs
  21. ~~~~
  22. Bugs or suggestions? Visit the `issue
  23. tracker <https://github.com/asciimoo/searx/issues>`__.
  24. `License <https://github.com/asciimoo/searx/blob/master/LICENSE>`__
  25. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  26. More about searx
  27. ~~~~~~~~~~~~~~~~
  28. - `ohloh <https://www.ohloh.net/p/searx/>`__
  29. - `twitter <https://twitter.com/Searx_engine>`__
  30. - IRC: #searx @ freenode
  31. .. |Flattr searx| image:: http://api.flattr.com/button/flattr-badge-large.png
  32. :target: https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software