openstack/deb-python-pecan
Code Issues Proposed changes

Add more emphasis to the need for debug=False in deployment documentation.

Browse Source 
Given https://wiki.openstack.org/wiki/OSSN/OSSN-0046, it seems that this
portion of documentation needs to be far more visible on the page.

Change-Id: I00f48d23edf5a0844d247a0d1476e9cd31ca84d7
This commit is contained in:
Ryan Petrello
2015-05-11 10:48:47 -04:00
parent 9a6a893d5e
commit c3ce70b613
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/source/deployment.rst
View File

@@ -42,19 +42,21 @@ environments:
Disabling Debug Mode
--------------------
One of the most important steps to take before deploying a Pecan app
into production is to disable **Debug Mode**, which is responsible for
serving static files locally and providing a development-oriented
debugging environment for tracebacks. In your production
configuration file, ensure that ``debug`` is set to ``False``.
.. warning::
One of the most important steps to take before deploying a Pecan app
into production is to ensure that you have disabled **Debug Mode**, which
provides a development-oriented debugging environment for tracebacks
encountered at runtime. Failure to disable this development tool in your
production environment *will* result in serious security issues. In your
production configuration file, ensure that ``debug`` is set to ``False``.
::
::
# myapp/production_config.py
app = {
...
'debug': False
}
# myapp/production_config.py
app = {
...
'debug': False
}
Pecan and WSGI
--------------