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-27 11:00:52 +00:00
2013-10-27 10:47:04 +00:00
List of [running instances ](https://github.com/asciimoo/searx/wiki/Searx-instances ).
2013-10-14 22:32:39 +00:00
2013-10-25 13:45:36 +00:00
[](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
2014-01-15 20:18:11 +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
2014-01-14 17:20:55 +00: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 22:23:29 +00:00
* Opensearch support (you can set as default search engine)
* Configurable search engines/categories
2013-10-14 22:32:39 +00:00
2014-01-15 20:18:11 +00:00
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
2014-01-12 10:42:20 +00:00
For all the details, follow this [step by step installation ](https://github.com/asciimoo/searx/wiki/Installation )
2014-01-15 20:18:11 +00:00
2014-01-12 11:40:27 +00:00
### Alternative (Recommended) Installation
* clone source: `git clone git@github.com:asciimoo/searx.git && cd searx`
* build in current folder: `make minimal`
* run `bin/searx-run` to start the application
### Development
2014-01-15 20:18:11 +00:00
Just run `make` . Versions of dependencies are pinned down inside `versions.cfg` to produce most stable build. Also remember, NO make command should be run as root, not even `make production`
### Deployment
* clone source: `git clone git@github.com:asciimoo/searx.git && cd searx`
* build in current folder: `make production`
* run `bin/supervisord` to start the application
2014-01-12 11:40:27 +00:00
2014-01-15 20:18:11 +00:00
### Upgrading
* inside previously cloned searx directory run: `git stash` to temporarily save any changes you have made
* pull source: `git pull origin master`
* re-build in current folder: `make production`
* run `bin/supervisorctl stop searx` to stop searx, if it does not, then run `fuser -k 8888/tcp`
* run `bin/supervisorctl reload` to re-read supervisor config and start searx
### Command make
2014-01-12 11:40:27 +00:00
##### `make`
Builds development environment with testing support.
##### `make tests`
Runs tests. You can write tests [here ](https://github.com/asciimoo/searx/tree/master/searx/tests ) and remember 'untested code is broken code'.
##### `make robot`
Runs robot (Selenium) tests, you must have `firefox` installed because this functional tests actually run the browser and perform operations on it. Also searx is executed with [settings_robot ](https://github.com/asciimoo/searx/blob/master/searx/settings_robot.py ).
##### `make flake8`
'pep8 is a tool to check your Python code against some of the style conventions in [PEP 8 ](http://www.python.org/dev/peps/pep-0008/ ).'
##### `make coverage`
Checks coverage of tests, after running this, execute this: `firefox ./coverage/index.html`
2014-01-15 20:18:11 +00:00
##### `make production`
Used to make co-called production environment - without tests (you should ran tests before deploying searx on the server). This installs supervisord, so if searx crashes, it will try to pick itself up again. And crontab entry is added to start supervisord at server boot.
2014-01-12 11:40:27 +00:00
##### `make minimal`
2014-01-15 20:18:11 +00:00
Minimal build - without test frameworks, the quickest build option.
2014-01-12 11:40:27 +00:00
##### `make clean`
Deletes several folders and files (see `Makefile` for more), so that next time you run any other `make` command it will rebuild everithing.
2013-10-16 20:22:36 +00:00
### TODO
2013-11-11 22:19:36 +00:00
* Moar engines
2013-10-16 20:22:36 +00:00
* Better ui
* Language support
2013-10-20 09:19:14 +00:00
* Documentation
2013-10-20 19:58:53 +00:00
* Pagination
2014-01-12 11:40:27 +00:00
* Fix `flake8` errors, `make flake8` will be merged into `make tests` when it does not fail anymore
2013-11-10 20:04:44 +00:00
* Tests
2014-01-12 11:40:27 +00:00
* When we have more tests, we can integrate Travis-CI
2013-10-20 09:20:10 +00:00
### Bugs
Bugs or suggestions? Visit the [issue tracker ](https://github.com/asciimoo/searx/issues ).
2014-01-12 11:41:58 +00: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 )
