diff options
| author | Zoran Peričić <zpericic@netst.org> | 2022-01-12 23:54:53 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-12 22:54:53 +0000 |
| commit | 17b2079f3e06b95ab1ad752ed1218795538a1606 (patch) | |
| tree | 95dd4e1b1aeea05ad1ac2ea87f75be747afd7bd0 /docs | |
| parent | ff00b8688bf2a918a975c49081868815919b1793 (diff) | |
| download | gitea-17b2079f3e06b95ab1ad752ed1218795538a1606.tar.gz gitea-17b2079f3e06b95ab1ad752ed1218795538a1606.zip | |
Add/update SMTP auth providers via cli (#18197)
Allow adding/updating SMTP authentication source via CLI using:
- gitea admin auth add-smtp
- gitea admin auth update-smtp
Signed-off-by: Zoran Peričić <zpericic@netst.org>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/doc/usage/command-line.en-us.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/content/doc/usage/command-line.en-us.md b/docs/content/doc/usage/command-line.en-us.md index e477f31f1a..90e872e635 100644 --- a/docs/content/doc/usage/command-line.en-us.md +++ b/docs/content/doc/usage/command-line.en-us.md @@ -161,6 +161,33 @@ Admin operations: - `--restricted-group`: Group Claim value for restricted users. (Optional) - Examples: - `gitea admin auth update-oauth --id 1 --name external-github-updated` + - `add-smtp`: + - Options: + - `--name`: Application Name. Required. + - `--auth-type`: SMTP Authentication Type (PLAIN/LOGIN/CRAM-MD5). Default to PLAIN. + - `--host`: SMTP host. Required. + - `--port`: SMTP port. Required. + - `--force-smtps`: SMTPS is always used on port 465. Set this to force SMTPS on other ports. + - `--skip-verify`: Skip TLS verify. + - `--helo-hostname`: Hostname sent with HELO. Leave blank to send current hostname. + - `--disable-helo`: Disable SMTP helo. + - `--allowed-domains`: Leave empty to allow all domains. Separate multiple domains with a comma (','). + - `--skip-local-2fa`: Skip 2FA to log on. + - `--active`: This Authentication Source is Activated. + Remarks: + `--force-smtps`, `--skip-verify`, `--disable-helo`, `--skip-loca-2fs` and `--active` options can be used in form: + - `--option`, `--option=true` to enable + - `--option=false` to disable + If those options are not specified value would not be changed in `update-smtp` or would use default `false` value in `add-smtp` + - Examples: + - `gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active` + - `update-smtp`: + - Options: + - `--id`: ID of source to be updated. Required. + - other options are shared with `add-smtp` + - Examples: + - `gitea admin auth update-smtp --id 1 --host smtp.mydomain.org --port 587 --skip-verify=false` + - `gitea admin auth update-smtp --id 1 --active=false` - `add-ldap`: Add new LDAP (via Bind DN) authentication source - Options: - `--name value`: Authentication name. Required. |