Merge pull request #544 from kvch/gh-pages

install docs update && dev tips
This commit is contained in:
Adam Tauber 2016-04-21 14:42:32 +02:00
commit 3e351e3b9f
3 changed files with 38 additions and 0 deletions

View File

@ -64,6 +64,8 @@ In order to submit a patch, please follow the steps below:
- Create a pull request.
For more help on getting started with searx development, see :ref:`devquickstart`.
Translation
~~~~~~~~~~~

View File

@ -179,6 +179,24 @@ Add this configuration in the server config file
uwsgi_pass unix:/run/uwsgi/app/searx/socket;
}
OR
using reverse proxy
(Please, note that reverse proxy advised to be used in case of single-user or low-traffic instances.)
.. code:: nginx
location /searx {
proxy_pass http://127.0.0.1:8888;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Scheme $scheme;
proxy_set_header X-Script-Name /searx;
proxy_buffering off;
}
Enable base\_url in searx/settings.yml
::

View File

@ -1,3 +1,5 @@
.. _devquickstart:
Development Quickstart
----------------------
@ -88,3 +90,19 @@ After installing grunt, the files can be built using the following command:
.. code:: sh
./manage.sh build_grunt
Tips for debugging/development
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Turn on debug logging
Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
to turn on debug logging. When debug logging is enabled a stack trace appears,
instead of the cryptic ``Internal Server Error`` message. It can be turned on by setting
``debug: False`` to ``debug: True`` in settings.yml.
2. Run ``./manage.sh tests`` before creating a PR.
Failing build on Travis is common because of PEP8 checks. So a new commit must be created
containing these format fixes. This phase can be skipped if ``./manage.sh tests`` is run
locally before creating a PR.