searxng/README.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

2013-10-14 21:09:13 +00:00
searx
=====
2013-10-20 19:58:53 +00:00
A privacy-respecting, hackable [metasearch engine](https://en.wikipedia.org/wiki/Metasearch_engine).
2013-10-14 22:32:39 +00:00
2013-10-25 13:45:36 +00: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 10:50:16 +00:00
2013-10-14 22:52:41 +00:00
### Features
2013-10-18 17:53:22 +00:00
* Tracking free
2013-10-15 16:18:50 +00:00
* Modular (see [examples](https://github.com/asciimoo/searx/blob/master/examples))
2013-10-14 22:52:41 +00:00
* Parallel queries
2013-10-20 20:23:51 +00:00
* Supports json output `curl http://searx.0x2a.tk/?format=json&q=[query]`
2013-10-17 18:42:38 +00:00
* Opensearch support (you can set as default search engine in your browser)
2013-10-17 20:26:39 +00:00
* Search categories
2013-10-19 20:17:02 +00:00
* User-agent forwarding
2013-10-14 22:32:39 +00:00
### Installation
2013-10-16 20:22:36 +00:00
* clone source: `git clone git@github.com:asciimoo/searx.git && cd searx`
2013-10-19 23:00:04 +00:00
* install dependencies: `pip install -r requirements.txt`
2013-10-19 14:25:06 +00:00
* edit your [searx/settings.py](https://github.com/asciimoo/searx/blob/master/searx/settings.py) (set your `secret_key`!)
2013-10-23 21:51:25 +00:00
* rename `engines.cfg_sample` to `engines.cfg`
2013-10-16 20:22:36 +00:00
* run `python searx/webapp.py` to start the application
### TODO
* Better ui
* Language support
2013-10-20 09:19:14 +00:00
* Documentation
2013-10-20 19:58:53 +00:00
* Pagination
2013-10-20 09:20:10 +00:00
### Bugs
Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/searx/issues).