Commit b7f2ed0b authored by Nicolas Gelot's avatar Nicolas Gelot

Update README

parent d7d988da
......@@ -6,9 +6,7 @@ engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__.
Spot was forked from searx: read `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information.
|OpenCollective searx backers|
|OpenCollective searx sponsors|
Spot is based on Python3.7+
Getting Started
~~~~~~~~~~~~
......@@ -20,7 +18,6 @@ with one command.
- Run the docker-compose **up** command to start the project ``docker-compose up --build``
- Getting the ip of the spot service and go to http://<spot-ip>:8888
- Or you can use the command line ``curl -X POST -F 'category=general' -F 'language=en-US' -F 'q=lequipe' -F 'time_range=' -F 'output=json' http://<spot-ip>:8888/``
.. note:: Here the command to get the IP of the spot service
``docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' my-spot_spot_1``
......@@ -28,6 +25,24 @@ with one command.
You can also install **redis** and **spot** on your host, for all the details, follow this `step by step
installation <https://github.com/asciimoo/searx/wiki/Installation>`__.
Developer mode
~~~~~~~~~~~~
First run the redis database:
- ``docker-compose up -d redis``
Then on spot workdir run the following commands to start spot:
- ``docker-compose build spot``
- ``docker-compose run --rm -v $(pwd):/ws -w /ws -e PYTHONPATH=/ws spot sh``
- ``python3 -X dev searx/webapp.py``
Run tests:
- ``docker run -it --rm -v $(pwd):/ws -w /ws -v /var/run/docker.sock:/var/run/docker.sock -e PYTHONPATH=/ws registry.gitlab.e.foundation:5000/e/cloud/my-spot/env bash``
- ``pytest --pdb --pdbcls IPython.terminal.debugger:TerminalPdb tests``
Bugs
~~~~
......@@ -43,11 +58,3 @@ More about searx
- `openhub <https://www.openhub.net/p/searx/>`__
- `twitter <https://twitter.com/Searx_engine>`__
- IRC: #searx @ freenode
.. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg
:target: https://opencollective.com/searx#backer
.. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg
:target: https://opencollective.com/searx#sponsor
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment