searx/README.md

55 lines
1.7 KiB
Markdown
Raw Normal View History

2013-10-14 14:09:13 -07:00
searx
=====
2013-10-20 12:58:53 -07:00
A privacy-respecting, hackable [metasearch engine](https://en.wikipedia.org/wiki/Metasearch_engine).
2013-10-27 04:00:52 -07:00
2013-10-27 03:47:04 -07:00
List of [running instances](https://github.com/asciimoo/searx/wiki/Searx-instances).
2013-10-14 15:32:39 -07:00
2013-10-25 06:45:36 -07: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 03:50:16 -07:00
2013-10-14 15:52:41 -07:00
### Features
2013-10-18 10:53:22 -07:00
* Tracking free
2013-10-15 09:18:50 -07:00
* Modular (see [examples](https://github.com/asciimoo/searx/blob/master/examples))
2013-10-14 15:52:41 -07:00
* Parallel queries
2014-01-14 09:20:55 -08:00
* Supports multiple output formats
* json `curl https://searx.0x2a.tk/?format=json&q=[query]`
* csv `curl https://searx.0x2a.tk/?format=csv&q=[query]`
* opensearch/rss `curl https://searx.0x2a.tk/?format=rss&q=[query]`
2013-11-11 14:23:29 -08:00
* Opensearch support (you can set as default search engine)
* Configurable search engines/categories
2013-10-14 15:32:39 -07:00
### Installation
2013-10-16 13:22:36 -07:00
* clone source: `git clone git@github.com:asciimoo/searx.git && cd searx`
2013-10-19 16:00:04 -07:00
* install dependencies: `pip install -r requirements.txt`
2013-10-19 07:25:06 -07:00
* edit your [searx/settings.py](https://github.com/asciimoo/searx/blob/master/searx/settings.py) (set your `secret_key`!)
2013-10-23 14:51:25 -07:00
* rename `engines.cfg_sample` to `engines.cfg`
2013-10-16 13:22:36 -07:00
* run `python searx/webapp.py` to start the application
2014-01-12 02:42:20 -08:00
For all the details, follow this [step by step installation](https://github.com/asciimoo/searx/wiki/Installation)
2013-10-16 13:22:36 -07:00
### TODO
2013-11-11 14:19:36 -08:00
* Moar engines
2013-10-16 13:22:36 -07:00
* Better ui
* Language support
2013-10-20 02:19:14 -07:00
* Documentation
2013-10-20 12:58:53 -07:00
* Pagination
2013-11-10 12:04:44 -08:00
* Tests
2013-10-20 02:20:10 -07:00
### Bugs
Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/searx/issues).
2014-01-12 03:41:58 -08:00
### [License](https://github.com/asciimoo/searx/blob/master/LICENSE)
### More about searx
* [ohloh](https://www.ohloh.net/p/searx/)
* [twitter](https://twitter.com/Searx_engine)