mirror of https://github.com/searxng/searxng.git synced 2024-12-23 17:50:29 +00:00

SearXNG is a free internet metasearch engine which aggregates results from various search services and databases. Users are neither tracked nor profiled.

hacktoberfest metasearch metasearch-engine python search

Find a file

Matej Cotman bfc88aef19 flat design: logo, search box and some links		2014-01-17 17:26:45 +01:00
examples	[enh] example engine update	2013-10-19 20:54:21 +02:00
searx	flat design: logo, search box and some links	2014-01-17 17:26:45 +01:00
.gitignore	[enh] gitignore updates	2014-01-15 14:07:11 +01:00
base.cfg	tests and robot tests framework, build overhaul	2014-01-14 23:31:15 +01:00
bootstrap.py	tests and robot tests framework, build overhaul	2014-01-14 23:31:15 +01:00
buildout.cfg	tests and robot tests framework, build overhaul	2014-01-14 23:31:15 +01:00
engines.cfg_sample	[fix] urbandictionary html mods	2014-01-12 18:48:01 +01:00
LICENSE	[enh] license informations	2013-10-15 00:33:18 +02:00
Makefile	tests and robot tests framework, build overhaul	2014-01-14 23:31:15 +01:00
production.cfg	tests and robot tests framework, build overhaul	2014-01-14 23:31:15 +01:00
README.md	tests and robot tests framework, build overhaul	2014-01-14 23:31:15 +01:00
requirements.txt	[enh] initial commit	2013-10-14 23:09:13 +02:00
setup.py	tests and robot tests framework, build overhaul	2014-01-14 23:31:15 +01:00
versions.cfg	tests and robot tests framework, build overhaul	2014-01-14 23:31:15 +01:00

README.md

searx

A privacy-respecting, hackable metasearch engine.

List of running instances.

Features

Tracking free
Modular (see examples)
Parallel queries
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]
Opensearch support (you can set as default search engine)
Configurable search engines/categories

Installation

clone source: git clone git@github.com:asciimoo/searx.git && cd searx
install dependencies: pip install -r requirements.txt
edit your searx/settings.py (set your secret_key!)
rename engines.cfg_sample to engines.cfg
run python searx/webapp.py to start the application

For all the details, follow this step by step installation

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

Just run make. Versions of dependencies are pinned down inside versions.cfg to produce most stable build.

Command make

`make`

Builds development environment with testing support.

`make tests`

Runs tests. You can write tests here 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.

`make flake8`

'pep8 is a tool to check your Python code against some of the style conventions in PEP 8.'

`make coverage`

Checks coverage of tests, after running this, execute this: firefox ./coverage/index.html

`make minimal`

Used to make co-called production environment - without tests (you should ran tests before deploying searx on the server).

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

TODO

Moar engines
Better ui
Language support
Documentation
Pagination
Fix flake8 errors, make flake8 will be merged into make tests when it does not fail anymore
Tests
When we have more tests, we can integrate Travis-CI

Bugs

Bugs or suggestions? Visit the issue tracker.