From c3ce70b61356f3bdec8e4b5253560425ecf2dbf2 Mon Sep 17 00:00:00 2001 From: Ryan Petrello Date: Mon, 11 May 2015 10:48:47 -0400 Subject: [PATCH] Add more emphasis to the need for debug=False in deployment documentation. 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 --- docs/source/deployment.rst | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/source/deployment.rst b/docs/source/deployment.rst index b6ab953..fa07e8b 100644 --- a/docs/source/deployment.rst +++ b/docs/source/deployment.rst @@ -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 --------------