git.iko.soy/searx
on master help sign in
Merge pull request #544 from kvch/gh-pages

install docs update && dev tips

commit3e351e3b9f819d5383fd1ebafd906fdbe0c3d086 authorAdam Tauber <asciimoo@gmail.com> dateThu 21 Apr 2016, 14:42 (11 years ago) parent20b1f1bb40d7a2
3 files changed+38
compare with master
unifiedsplit
docs/dev/contribution_guide.rst+2 docs/dev/install/installation.rst+18 docs/dev/quickstart.rst+18
docs/dev/contribution_guide.rst+2
@@ -64,6 +64,8 @@ In order to submit a patch, please follow the steps below:
6464
6565- Create a pull request.
6666
67+For more help on getting started with searx development, see :ref:`devquickstart`.
68+
6769
6870Translation
6971~~~~~~~~~~~
docs/dev/install/installation.rst+18
@@ -179,6 +179,24 @@ Add this configuration in the server config file
179179 uwsgi_pass unix:/run/uwsgi/app/searx/socket;
180180 }
181181
182+
183+OR
184+
185+using reverse proxy
186+(Please, note that reverse proxy advised to be used in case of single-user or low-traffic instances.)
187+
188+.. code:: nginx
189+
190+ location /searx {
191+ proxy_pass http://127.0.0.1:8888;
192+ proxy_set_header Host $host;
193+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
194+ proxy_set_header X-Scheme $scheme;
195+ proxy_set_header X-Script-Name /searx;
196+ proxy_buffering off;
197+ }
198+
199+
182200Enable base\_url in searx/settings.yml
183201
184202::
docs/dev/quickstart.rst+18
@@ -1,3 +1,5 @@
1+.. _devquickstart:
2+
13Development Quickstart
24----------------------
35
@@ -88,3 +90,19 @@ After installing grunt, the files can be built using the following command:
8890.. code:: sh
8991
9092 ./manage.sh build_grunt
93+
94+
95+
96+Tips for debugging/development
97+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98+
99+1. Turn on debug logging
100+ Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
101+ to turn on debug logging. When debug logging is enabled a stack trace appears,
102+ instead of the cryptic ``Internal Server Error`` message. It can be turned on by setting
103+ ``debug: False`` to ``debug: True`` in settings.yml.
104+
105+2. Run ``./manage.sh tests`` before creating a PR.
106+ Failing build on Travis is common because of PEP8 checks. So a new commit must be created
107+ containing these format fixes. This phase can be skipped if ``./manage.sh tests`` is run
108+ locally before creating a PR.