searx/README.md

43 lines
1.4 KiB
Markdown
Raw Normal View History

2013-10-14 23:09:13 +02:00
searx
=====
2013-10-20 21:58:53 +02:00
A privacy-respecting, hackable [metasearch engine](https://en.wikipedia.org/wiki/Metasearch_engine).
2013-10-27 12:00:52 +01:00
2013-10-27 11:47:04 +01:00
List of [running instances](https://github.com/asciimoo/searx/wiki/Searx-instances).
2013-10-15 00:32:39 +02:00
2013-10-25 15:45:36 +02:00
[![Flattr searx](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software)
2013-10-25 12:50:16 +02:00
2013-10-15 00:52:41 +02:00
### Features
2013-10-18 19:53:22 +02:00
* Tracking free
2013-10-15 18:18:50 +02:00
* Modular (see [examples](https://github.com/asciimoo/searx/blob/master/examples))
2013-10-15 00:52:41 +02:00
* Parallel queries
2013-10-27 11:47:04 +01:00
* Supports json output `curl https://searx.0x2a.tk/?format=json&q=[query]`
2013-12-31 02:59:08 +01:00
* Supports csv output `curl https://searx.0x2a.tk/?format=csv&q=[query]`
2013-11-11 23:23:29 +01:00
* Opensearch support (you can set as default search engine)
* Configurable search engines/categories
2013-10-19 22:17:02 +02:00
* User-agent forwarding
2013-10-15 00:32:39 +02:00
### Installation
2013-10-16 22:22:36 +02:00
* clone source: `git clone git@github.com:asciimoo/searx.git && cd searx`
2013-10-20 01:00:04 +02:00
* install dependencies: `pip install -r requirements.txt`
2013-10-19 16:25:06 +02:00
* edit your [searx/settings.py](https://github.com/asciimoo/searx/blob/master/searx/settings.py) (set your `secret_key`!)
2013-10-23 23:51:25 +02:00
* rename `engines.cfg_sample` to `engines.cfg`
2013-10-16 22:22:36 +02:00
* run `python searx/webapp.py` to start the application
### TODO
2013-11-11 23:19:36 +01:00
* Moar engines
2013-10-16 22:22:36 +02:00
* Better ui
* Language support
2013-10-20 11:19:14 +02:00
* Documentation
2013-10-20 21:58:53 +02:00
* Pagination
2013-11-10 21:04:44 +01:00
* Tests
2013-10-20 11:20:10 +02:00
### Bugs
Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/searx/issues).