From be796b9b5bf38e9c0292e544534d35059b392c3e Mon Sep 17 00:00:00 2001 From: Ember Hearth Date: Sat, 26 Nov 2022 22:56:38 -0500 Subject: Add example configuration file See #73. --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 0e1c1cc..f13167c 100644 --- a/README.rst +++ b/README.rst @@ -7,13 +7,13 @@ This is a no-bullshit file hosting and URL shortening service that also runs Configuration ------------- -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:: +To configure 0x0, copy ``instance/config.example.py`` to ``instance/config.py``, then edit +it. Resonable defaults are set, but there's a couple options you'll need to change +before running 0x0 for the first time. - SQLALCHEMY_DATABASE_URI = "sqlite:///some/path/db.sqlite" - -For more information on instance configuration, see +By default, the configuration is stored in the Flask instance directory. +Normally, this is in `./instance`, but it might be different for your system. +For details, see `the Flask documentation `_. To customize the home and error pages, simply create a ``templates`` directory -- cgit v1.2.3