Add warnings about debugging mode

[mudpy.git] / doc / source / configuration.rst

diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index d0f8093..2ced5c2 100644 (file)
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -2,7 +2,7 @@
  configuration
 ===============
 
  configuration
 ===============
 

-.. Copyright (c) 2004-2019 mudpy authors. Permission to use, copy,
+.. Copyright (c) 2004-2020 mudpy authors. Permission to use, copy,

    modify, and distribute this software is granted under terms
    provided in the LICENSE file distributed with this software.
 
    modify, and distribute this software is granted under terms
    provided in the LICENSE file distributed with this software.
 


@@ -167,6 +167,21 @@ Example::
 
   .mudpy.limit.backups: 10
 
 
   .mudpy.limit.backups: 10
 

+.mudpy.limit.debug
+~~~~~~~~~~~~~~~~~~
+
+bool, optional
+
+Whether unsafe debugging functionality is enabled. If unspecified or
+set to false, unsafe debugging functions will be disabled. Be very
+careful enabling this feature, as debugging commands may allow service
+administrators to run arbitrary shell commands or modify files
+accessible to the system user underwhich the service is running.
+
+Example::
+
+  .mudpy.limit.debug: true
+

 .mudpy.limit.password_tries
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .mudpy.limit.password_tries
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~