..
      Copyright (c) 2017 Intel Corporation
      All Rights Reserved.

      Licensed under the Apache License, Version 2.0 (the "License"); you may
      not use this file except in compliance with the License. You may obtain
      a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
      License for the specific language governing permissions and limitations
      under the License.


Running Searchlight API using uWSGI
========================================
The recommended way to deploy Searchlight is have a web server such as Apache
or nginx to handle http requests and proxy these requests to Searchlight WSGI
app running in uWSGI. Searchlight comes with some configuration templates on
how to deploy the api service with Apache and uWSGI.

app.wsgi
********
The ``searchlight/api/app.wsgi`` file contains a WSGI application of
Searchlight API service. This file is installed with Searchlight application
code.

apache-searchlight.template
***************************
The ``searchlight/etc/apache-searchlight.template`` file contains a copy
of Apache configuration file for Searchlight API used by devstack.

searchlight-uwsgi.ini.sample
****************************
The ``searchlight/etc/searchlight-uwsgi.ini.sample`` file is a sample
configuration file for uWSGI server. Update the file to match your
system configuration.

Steps to use these sample configuration files:

1. Enable mod_proxy_uwsgi module

* On Ubuntu install required uwsgi package
  ``sudo apt-get install libapache2-mod-proxy-uwsgi``; enable using
  ``sudo a2enmod proxy``, ``sudo a2enmod proxy_uwsgi``.
* On Fedora the required package is mod_proxy_uwsgi; enable by creating a file
  ``/etc/httpd/conf.modules.d/11-proxy_uwsgi.conf`` containing
  ``LoadModule proxy_uwsgi_module modules/mod_proxy_uwsgi.so``

2. On deb-based systems copy or symlink the file to
   ``/etc/apache2/sites-available/searchlight.conf``. For rpm-based systems the file should go into
   ``/etc/httpd/conf.d/searchlight.conf``.

3. Enable Searchlight site. On deb-based systems::

      $ a2ensite searchlight
      $ service apache2 reload

   On rpm-based systems::

      $ service httpd reload

4. Copy searchlight/etc/searchlight-uwsgi.ini.sample to /etc/searchlight/searchlight-uwsgi.ini.

5. Start Searchlight api using uWSGI::

      $ sudo pip install uwsgi
      $ uwsgi /etc/searchlight/searchlight-uwsgi.ini
