A Flask app demonstrating the usage of Sphinx Web Support.

How to Use?

Note

In the following steps, I am assuming that you copied sphinxweb to /var/www/sphinxweb and cd to it.

1. Install the requirements

   pip install -r requirements.txt
   

2. Edit settings.py and update SERVER_NAME, EMAIL_HOST_USER and EMAIL_HOST_PASSWORD

3. Build the docs and database

   python build.py
   

4. Run the development server

   python runserver.py
   

5. If you want to use a production server like Apache:

   1. Install and enable mod_wsgi module
   2. Change the ServerName and paths in deploy/sphinxweb.apache.conf
   3. Copy deploy/sphinxweb.apache.conf to /etc/apache2/sites-enabled
   4. Restart apache2

6. If you want to use a production server like Nginx:

   1. Install Nginx, uWSGI and Supervisor
   2. Copy deploy/sphinxweb.supervisor.conf to /etc/supervisor/conf.d
   3. Change the ServerName and paths in deploy/sphinxweb.nginx.conf
   4. Copy deploy/sphinxweb.nginx.conf to /etc/nginx/sites-enabled
   5. Restart Supervisor and Nginx