realaravinth/bench-forgejo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

document command line flags (#5675)

Browse source
This commit is contained in:
Lanre Adelowo 2019-01-09 18:52:10 +01:00 committed by techknowlogick
parent c04fc677b5
commit 530c2b8ad8
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/content/doc/usage/command-line.md
View file

@ -50,12 +50,18 @@ Admin operations:
- Commands: - Commands:
- `create-user` - `create-user`
- Options: - Options:
- `--name value`: Username. Required. - `--name value`: Username. Required.
- `--password value`: Password. Required. - `--password value`: Password. Required.
- `--email value`: Email. Required. - `--email value`: Email. Required.
- `--admin`: If provided, this makes the user an admin. Optional. - `--admin`: If provided, this makes the user an admin. Optional.
- `--config path`: Gitea configuration file path. Optional. (default: custom/conf/app.ini). - `--config path`: Gitea configuration file path. Optional. (default: custom/conf/app.ini).
- `--must-change-password`: If provided, the created user will be required to choose a newer password after
the initial login. Optional. (default: false).
- ``--random-password``: If provided, a randomly generated password will be used as the password of
the created user. The value of `--password` will be discarded. Optional.
- `--random-password-length`: If provided, it will be used to configure the length of the randomly
generated password. Optional. (default: 12)
- Examples: - Examples:
- `gitea admin create-user --name myname --password asecurepassword --email me@example.com` - `gitea admin create-user --name myname --password asecurepassword --email me@example.com`
- `change-password` - `change-password`