diff --git a/README.md b/README.md index 99d3d27..1e84dc5 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ make sure blinkies are actually blinkie-sized, and stamps are likewise stamp-siz this is how your config should look at the latest update ``` -REGISTRATION = True # Make sure to disable in production +REGISTRATION = False # Make sure is disabled in production STATIC_FOLDER = 'myriad/static' ICON_UPLOAD_FOLDER = 'myriad/static/icons' # where member icons will be stored BLINKIES_UPLOAD_FOLDER = 'myriad/static/blinkies' # where blinkies will be stored @@ -37,6 +37,23 @@ SECRET_KEY = "dev" # CHANGE THIS - see wiki for details most likely if you get an error after updating, you need to make sure your config has all the fields as sampled above. we may have added something that you now need. +# Commands + +(Re-)Initialize the database. **if a database already exists, this erases the entire thing!!! Use with caution** + +``` +flask --app myriad init-db +``` + +--- + +Create an admin account. Functionally the same as the web Registration without the security issue of enable registration in the web browser. if not provided, will prompt for username and password. + +``` +flask --app myriad register-admin +flask --app myriad register-admin --username EXAMPLE_USER --password EXAMPLE_PASSWORD +``` + # A note on data export/import there are currently various ways to export and import data for use within myriad. individual member exports and imports deal only with the fields (though icons, stamps, and blinkies can be exported to a zip folder). they're designed to be used with an active database for whatever purpose the user requires.