diff --git a/README.md b/README.md index 81bc52f..7e7860c 100644 --- a/README.md +++ b/README.md @@ -32,19 +32,17 @@ be overridden with `ARIMELODY_DB_HOST`. the location of the configuration file can also be overridden with `ARIMELODY_CONFIG`. -## command arguments +### command arguments by default, `arimelody-web` will spin up a web server as usual. instead, arguments may be supplied to run administrative actions. the web server doesn't need to be up for this, making this ideal for some offline maintenance. +- `createTOTP `: Creates a timed one-time passcode method. +- `listTOTP `: Lists an account's TOTP methods. +- `deleteTOTP `: Deletes an account's TOTP method. +- `testTOTP `: Generates the code for an account's TOTP method. - `createInvite`: Creates an invite code to register new accounts. - `purgeInvites`: Deletes all available invite codes. - `listAccounts`: Lists all active accounts. - `deleteAccount `: Deletes an account with a given `username`. - -## database - -the server requires a postgres database to run. you can use the -[schema.sql](schema.sql) provided in this repo to generate the required tables. -automatic schema building/migration may come in a future update.