README.rst 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. .. SPDX-License-Identifier: AGPL-3.0-or-later
  2. Searx is no longer maintained. Thank you for your support and all your contributions.
  3. .. figure:: https://raw.githubusercontent.com/searx/searx/master/searx/static/themes/oscar/img/logo_searx_a.png
  4. :target: https://searx.github.io/searx/
  5. :alt: searX
  6. :width: 100%
  7. :align: center
  8. -------
  9. |searx install|
  10. |searx homepage|
  11. |searx wiki|
  12. |AGPL License|
  13. |Issues|
  14. |commits|
  15. |OpenCollective searx backers|
  16. |OpenCollective searx sponsors|
  17. Privacy-respecting, hackable `metasearch engine`_ / *pronunciation* **sɜːks**.
  18. .. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine
  19. .. |searx install| image:: https://img.shields.io/badge/-install-blue
  20. :target: https://searx.github.io/searx/admin/installation.html
  21. .. |searx homepage| image:: https://img.shields.io/badge/-homepage-blue
  22. :target: https://searx.github.io/searx
  23. .. |searx wiki| image:: https://img.shields.io/badge/-wiki-blue
  24. :target: https://github.com/searx/searx/wiki
  25. .. |AGPL License| image:: https://img.shields.io/badge/license-AGPL-blue.svg
  26. :target: https://github.com/searx/searx/blob/master/LICENSE
  27. .. |Issues| image:: https://img.shields.io/github/issues/searx/searx?color=yellow&label=issues
  28. :target: https://github.com/searx/searx/issues
  29. .. |PR| image:: https://img.shields.io/github/issues-pr-raw/searx/searx?color=yellow&label=PR
  30. :target: https://github.com/searx/searx/pulls
  31. .. |commits| image:: https://img.shields.io/github/commit-activity/y/searx/searx?color=yellow&label=commits
  32. :target: https://github.com/searx/searx/commits/master
  33. .. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg
  34. :target: https://opencollective.com/searx#backer
  35. .. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg
  36. :target: https://opencollective.com/searx#sponsor
  37. If you are looking for running instances, ready to use, then visit searx.space_.
  38. Otherwise jump to the user_, admin_ and developer_ handbooks you will find on
  39. our homepage_.
  40. .. _searx.space: https://searx.space
  41. .. _user: https://searx.github.io/searx/user
  42. .. _admin: https://searx.github.io/searx/admin
  43. .. _developer: https://searx.github.io/searx/dev
  44. .. _homepage: https://searx.github.io/searx
  45. contact:
  46. openhub_ // twitter_ // IRC: #searx @ Libera (irc.libera.chat)
  47. .. _openhub: https://www.openhub.net/p/searx
  48. .. _twitter: https://twitter.com/Searx_engine
  49. **************************
  50. Frequently asked questions
  51. **************************
  52. Is searx in maintenance mode?
  53. #############################
  54. No, searx is no longer maintained.
  55. What is the difference between searx and SearxNG?
  56. #################################################
  57. TL;DR: SearXNG is for users that want more features and bugs getting fixed quicker.
  58. If you prefer a minimalist software and stable experience, use searx.
  59. SearxNG is a fork of searx, created by a former maintainer of searx. The fork
  60. was created because the majority of the maintainers at the time did not find
  61. the new proposed features privacy respecting enough. The most significant issue is with
  62. engine metrics.
  63. Searx is built for privacy conscious users. It comes with a unique set of
  64. challenges. One of the problems we face is that users rather not report bugs,
  65. because they do not want to publicly share what engines they use or what search
  66. query triggered a problem. It is a challenge we accepted.
  67. The new metrics feature collects more information to make engine maintenance easier.
  68. We could have had better and more error reports to benefit searx maintainers.
  69. However, we believe that the users of searx must come first, not the
  70. software. We are willing to compromise on the lack of issue reports to avoid
  71. violating the privacy of users.
  72. Furthermore, SearxNG is under heavy refactoring and dependencies are constantly updated, even
  73. if it is unnecessary. It increases the risk of introducing regressions. In searx
  74. we strive for stability, rather than moving fast and breaking things.
  75. Is searx for me?
  76. ################
  77. Are you privacy conscious user? Then yes.
  78. In searx we decided to double down on being privacy respecting. We are picking
  79. engine changes from SearxNG, but we are not implementing engine detailed
  80. monitoring and not adding a new UI that relies on Javascript.
  81. If you are willing to give up some privacy respecting features, we encourage you to
  82. adopt SearxNG. Searx is targeted for privacy conscious users who run their
  83. instances locally, instead of using public instances.
  84. Why should I use SearxNG?
  85. #########################
  86. SearxNG has rolling releases, dependencies updated more frequently, and engines are fixed
  87. faster. It is easy to set up your own public instance, and monitor its
  88. performance and metrics. It is simple to maintain as an instance administrator.
  89. As a user, it provides a prettier user interface and nicer experience.