almet/argos
1
0
Fork 0
mirror of https://framagit.org/framasoft/framaspace/argos.git synced 2025-04-28 18:02:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

📝 — Document test-mail command

Browse source
This commit is contained in:
Luc Didry 2024-08-29 17:19:06 +02:00
parent 67162f6ce4
commit 9b40c5a675
No known key found for this signature in database
GPG key ID: EA868E12D0257E3C
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/cli.md
View file

@ -85,6 +85,7 @@ Commands:
migrate Run database migrations migrate Run database migrations
reload-config Load or reload tasks’ configuration reload-config Load or reload tasks’ configuration
start Starts the server (use only for testing or development!) start Starts the server (use only for testing or development!)
test-mail Send a test email
user User management user User management
watch-agents Watch agents (to run routinely) watch-agents Watch agents (to run routinely)
``` ```
@ -465,3 +466,28 @@ Options:
<!--[[[end]]] <!--[[[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]]]
-->