writefreely/docs
2
0
Fork 0
mirror of https://github.com/writefreely/documentation.git synced 2024-11-14 23:11:03 +00:00
Code Issues Releases Wiki Activity

Add command documentation

Browse Source
This commit is contained in:
Matt Baer 2019-01-20 17:39:15 -05:00
parent b813537a33
commit e72e45adcd
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
admin/commands.md Normal file
View File

@ -0,0 +1,46 @@
# Admin Commands
The following application flags allow administrators to perform certain actions on their instance, including installing, upgrading, or maintaining it.
## Options
These options can be used in conjunction with any other flags.
| Flag | Description |
| ---- | ----------- |
| `-c [filename]` | Config file to use with any other operation |
| `--debug` | Output debug information in application logs |
## Setup
Use these flags to perform certain actions as part of the setup process.
| Flag | Description | Interactive? |
| ---- | ----------- | ------------ |
| `--config` | Start the configuration process | Yes |
| `--gen-keys` | Generate encryption keys | No |
| `--init-db` | Initialize the database by creating the necessary tables | No |
## Upgrade
These flags assist with upgrading an instance.
| Flag | Description |
| ---- | ----------- |
| `--migrate` | Migrate database schema to the latest version |
## User administraction
Use these flags to perform actions around users.
| Flag | Description | Interactive? |
| ---- | ----------- | ------------ |
| `--create-admin [username]:[password]` | Create an admin user in the database. Fails if admin already exists. | No |
| `--create-user [username]:[password]` | Create a regular user in the database. Fails if no admin user exists yet. | No |
| `--reset-pass [username]` | Reset the given user's password | Yes |
## Miscellaneous
| Flag | Description |
| ---- | ----------- |
| `-v` | Print WriteFreely version information |