issue #105 - docs and changelog

jantman · Feb 24, 2018 · 186c9a0 · 186c9a0
1 parent a139e0d
commit 186c9a0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -29,6 +29,7 @@ Unreleased Changes
 * Fix bug found where simultaneously editing the Amount and Budget of an existing Transaction against a Standing Budget would result in incorrect changes to the balances of the Budgets.
 * Add a new ``migrations`` tox environment that automatically tests all database migrations (forward and reverse) and also validates that the database schema created from the migrations matches the one created from the models.
 * Add support for writing tests of data manipulation during database migrations, and write tests for the migration in for Issue 105, above.
+* Add support for ``BIWEEKLYBUDGET_LOG_FILE`` environment variable to cause Flask application logs to go to a file *in addition to* STDOUT.
 
 0.7.1 (2018-01-10)
 ------------------

diff --git a/docs/source/flask_app.rst b/docs/source/flask_app.rst
@@ -51,3 +51,8 @@ Security
 This code hasn't been audited. It might have SQL injection vulnerabilities in it. It might dump your bank account details in HTML comments. Anything is possible!
 
 To put it succinctly, this was written to be used by me, and me only. It was written with the assumption that anyone who can possibly access any of the application at all, whether in a browser or locally, is authorized to view and/or edit anything and everything related to the application (configuration, everything in the database, everything in Vault if it's being used). If you even think about making this accessible to anything other than localhost on a computer you physically own, it's entirely up to you how you secure it, but make sure you do it really well.
+
+Logging
+-------
+
+By default, the Flask application's logs go to STDOUT. The ``BIWEEKLYBUDGET_LOG_FILE`` environment variable can be set to the absolute path of a file, to cause Flask application logs to go to the file *in addition to* STDOUT.