summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMia Herkt <mia@0x0.st>2022-11-20 13:05:17 +0100
committerMia Herkt <mia@0x0.st>2022-11-20 13:05:17 +0100
commit4ba18146e192730da0ae4707163ccfdc3851011e (patch)
treee45f50d8b734ee26a65778eb605fc2e35cd304d8
parentafb581187981b56d29e7b11c15c5fce08c0899a6 (diff)
README: Clarify how to change configuration
-rw-r--r--README.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index f5270e4..e055da5 100644
--- a/README.rst
+++ b/README.rst
@@ -7,8 +7,14 @@ This is a no-bullshit file hosting and URL shortening service that also runs
Configuration
-------------
-To change settings, modify ``instance/config.py``. For more information on
-instance configuration, see `the Flask documentation <https://flask.palletsprojects.com/en/2.0.x/config/#instance-folders>`_.
+To configure 0x0, create ``instance/config.py``.
+The defaults are at the start of ``fhost.py``. To change them,
+add them to ``instance/config.py``— for example::
+
+ SQLALCHEMY_DATABASE_URI = "sqlite:///some/path/db.sqlite"
+
+For more information on instance configuration, see
+`the Flask documentation <https://flask.palletsprojects.com/en/2.0.x/config/#instance-folders>`_.
To customize the home and error pages, simply create a ``templates`` directory
in your instance directory and copy any templates you want to modify there.