README.rst 1.78 KB
Newer Older
1 2 3 4 5 6
searx
=====

A privacy-respecting, hackable `metasearch
engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__.

7 8
Pronunciation: səːks

9 10 11
List of `running
instances <https://github.com/asciimoo/searx/wiki/Searx-instances>`__.

12
See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information.
13

14 15
|OpenCollective searx backers|
|OpenCollective searx sponsors|
16 17 18 19

Installation
~~~~~~~~~~~~

20 21 22 23 24 25
With Docker
------
Go to the `searx-docker <https://github.com/searx/searx-docker>`__ project.

Without Docker
------
CaffeinatedTech's avatar
CaffeinatedTech committed
26
For all of the details, follow this `step by step installation <https://asciimoo.github.io/searx/dev/install/installation.html>`__.
27 28 29

Note: the documentation needs to be updated.

CaffeinatedTech's avatar
CaffeinatedTech committed
30
If you are in a hurry
31
------
CaffeinatedTech's avatar
CaffeinatedTech committed
32
-  clone the source:
33
   ``git clone https://github.com/asciimoo/searx.git && cd searx``
34
-  install dependencies: ``./manage.sh update_packages``
35
-  edit your
Ashutosh Das's avatar
Ashutosh Das committed
36
   `settings.yml <https://github.com/asciimoo/searx/blob/master/searx/settings.yml>`__
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
   (set your ``secret_key``!)
-  run ``python searx/webapp.py`` to start the application


Bugs
~~~~

Bugs or suggestions? Visit the `issue
tracker <https://github.com/asciimoo/searx/issues>`__.

`License <https://github.com/asciimoo/searx/blob/master/LICENSE>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

More about searx
~~~~~~~~~~~~~~~~

Pierre-Alain TORET's avatar
Pierre-Alain TORET committed
53
-  `openhub <https://www.openhub.net/p/searx/>`__
54 55 56
-  `twitter <https://twitter.com/Searx_engine>`__
-  IRC: #searx @ freenode

57 58 59 60 61 62 63

.. |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