Create spot README

# spot for [/e/](https://e.foundation)

![logo](searx/static/themes/eelo/img/favicon.png)

A privacy-respecting, hackable [metasearch 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.

## Changes between Spot and Searx

* eelo theme

* docker packaging thinking to be production ready

* better locale support

## Getting Started

You can run spot with docker-compose. First of all you have to install

docker and docker-compose on your host, then follow instructions

below to run spot for production or local environment.

### Like production

3 containes are used for production, traefik as edge router,

nginx to server static files and spot as backend.

* Run the docker-compose up command to start the project 

```

docker-compose up --build spot nginx

```

* Getting the ip of the nginx service and go to `http://<nginx-ip>`, below the docker way to get the IP of the nginx container

```

docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' my-spot_nginx_1

```

### For developer

You can directly run spot, with a python command inside a docker container which

contains all dependencies.

```

docker run -it --rm -v $(pwd):/ws -w /ws registry.gitlab.e.foundation:5000/e/cloud/my-spot/env sh

SEARX_DEBUG=1 python -X dev searx/webapp.py

```

Then go open your browser and navigate to the container IP.

searx

=====

A privacy-respecting, hackable `metasearch

engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__.

Pronunciation: səːks

List of `running

instances <https://github.com/asciimoo/searx/wiki/Searx-instances>`__.

See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information.

|OpenCollective searx backers|

|OpenCollective searx sponsors|

Installation

~~~~~~~~~~~~

With Docker

------

Go to the `searx-docker <https://github.com/searx/searx-docker>`__ project.

Without Docker

------

For all of the details, follow this `step by step installation <https://asciimoo.github.io/searx/dev/install/installation.html>`__.

Note: the documentation needs to be updated.

If you are in a hurry

------

-  clone the source:

   ``git clone https://github.com/asciimoo/searx.git && cd searx``

-  install dependencies: ``./manage.sh update_packages``

-  edit your

   `settings.yml <https://github.com/asciimoo/searx/blob/master/searx/settings.yml>`__

   (set your ``secret_key``!)

-  run ``python searx/webapp.py`` to start the application

Bugs

~~~~

Bugs or suggestions? Visit the `issue

tracker <https://github.com/asciimoo/searx/issues>`__.

`License <https://github.com/asciimoo/searx/blob/master/LICENSE>`__

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

    name='searx',

    name='searx',

    use_scm_version={"tag_regex": r"^(?:[\w-]+-)?(?P<version>[vV]?\d+(?:\.\d+){0,2}.*)$"},

    use_scm_version={"tag_regex": r"^(?:[\w-]+-)?(?P<version>[vV]?\d+(?:\.\d+){0,2}.*)$"},

    description="A privacy-respecting, hackable metasearch engine",

    description="A privacy-respecting, hackable metasearch engine",

    long_description=open('README.rst').read(),

    long_description=open('README.md').read(),

    classifiers=[

    classifiers=[

        "Development Status :: 4 - Beta",

        "Development Status :: 4 - Beta",

        "Programming Language :: Python",

        "Programming Language :: Python",