]> BookStack Code Mirror - website/commitdiff
Added security warning to debugging page
authorDan Brown <redacted>
Sat, 13 Oct 2018 09:01:19 +0000 (10:01 +0100)
committerDan Brown <redacted>
Sat, 13 Oct 2018 09:01:19 +0000 (10:01 +0100)
For BookStackApp/BookStack#1054

content/docs/admin/debugging.md

index ed8c2007cf81cf21288f97b5354905eb9d6eb239..81f8251650248521ed3e099636796daf80be7b70 100644 (file)
@@ -7,6 +7,8 @@ type = "admin-doc"
 
 When using BookStack, Especially when initially setting it up or after updating, you may come across some errors. While we try to reduce these as much as possible and make them helpful sometimes you may come across a bland, non-helpful 'An error has occurred' message. This is to prevent any potentially sensitive information being shown to all users.
 
+_**NOTE: While debugging is enabled it's possible for users to be able to see private credentials used in the BookStack or server configuration. Ensure debugging is only enabled when your instance is not accessible by others. Remember to disable debugging before restoring user access.**_
+
 To enable full error displaying edit the `.env` file, in the application root directory, and find the line `APP_DEBUG=false`. Change this to `APP_DEBUG=true` and the errors will be displayed in full with details of where it occurred. Remember to revert this change once you have found the issue so that the detailed error information is hidden from everyone.
 
 On top of the above, An error log can be found at the path `storage/logs/laravel.log`. If the `laravel.log` file does not exist the `storage/logs` directory may not be writable by the server.