mirror of
https://framagit.org/framasoft/framaspace/argos.git
synced 2025-04-28 09:52:38 +02:00
📝 — Document test-mail command
This commit is contained in:
parent
67162f6ce4
commit
9b40c5a675
1 changed files with 26 additions and 0 deletions
26
docs/cli.md
26
docs/cli.md
|
@ -85,6 +85,7 @@ Commands:
|
|||
migrate Run database migrations
|
||||
reload-config Load or reload tasks’ configuration
|
||||
start Starts the server (use only for testing or development!)
|
||||
test-mail Send a test email
|
||||
user User management
|
||||
watch-agents Watch agents (to run routinely)
|
||||
```
|
||||
|
@ -465,3 +466,28 @@ Options:
|
|||
|
||||
<!--[[[end]]]
|
||||
-->
|
||||
|
||||
#### Test the email settings
|
||||
|
||||
You can verify that your mail settings are ok by sending a test email
|
||||
|
||||
<!--
|
||||
.. [[[cog
|
||||
help(["server", "test-mail", "--help"])
|
||||
.. ]]] -->
|
||||
|
||||
```man
|
||||
Usage: argos server test-mail [OPTIONS]
|
||||
|
||||
Send a test email
|
||||
|
||||
Options:
|
||||
--config TEXT Path of the configuration file. If ARGOS_YAML_FILE
|
||||
environment variable is set, its value will be used instead.
|
||||
--domain TEXT Domain for the notification
|
||||
--severity TEXT Severity
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
<!--[[[end]]]
|
||||
-->
|
||||
|
|
Loading…
Reference in a new issue