diff options
| author | Ember Hearth <ember@corviform.gay> | 2022-11-26 22:56:38 -0500 |
|---|---|---|
| committer | Mia Herkt <mia@0x0.st> | 2022-11-28 22:30:43 +0100 |
| commit | be796b9b5bf38e9c0292e544534d35059b392c3e (patch) | |
| tree | a2938ea3c7e5152d09ed699a9578334896c7df8b /README.rst | |
| parent | b5f0cfdf6f9d621fd83a054375e50e7a4c9e42de (diff) | |
Add example configuration file
See #73.
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -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 <https://flask.palletsprojects.com/en/2.0.x/config/#instance-folders>`_. To customize the home and error pages, simply create a ``templates`` directory |
