Giter VIP home page Giter VIP logo

searx's Introduction

searx

A privacy-respecting, hackable metasearch engine.

List of running instances.

See the wiki for more information.

Flattr searx

Features

  • Tracking free
  • 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
  • Different search languages
  • Duckduckgo like !bang functionality with engine shortcuts
  • Parallel queries - relatively fast

Installation

  • clone source: git clone [email protected]:asciimoo/searx.git && cd searx
  • install dependencies: pip install -r requirements.txt
  • edit your settings.yml (set your secret_key!)
  • run python searx/webapp.py to start the application

For all the details, follow this step by step installation

  • clone source: git clone [email protected]: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. Also remember, NO make command should be run as root, not even make production

Deployment

  • clone source: git clone [email protected]:asciimoo/searx.git && cd searx
  • build in current folder: make production
  • run bin/supervisord to start the application

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

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

make minimal

Minimal build - without test frameworks, the quickest build option.

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
  • Browser integration
  • Documentation
  • 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.

More about searx

searx's People

Contributors

asciimoo avatar pointhi avatar dalf avatar matejc avatar dnet avatar aigeruth avatar

Watchers

 avatar Yuval Adam avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.