-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
ENT-11569: Added documentation for mailto, mailfrom, smtpserver and maxmaillines (3.21)
- Loading branch information
Showing
1 changed file
with
56 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -732,19 +732,71 @@ allowed values (`LOG_USER`, `LOG_DAEMON`, `LOG_LOCAL0`, `LOG_LOCAL1`, | |
|
||
### mailto | ||
|
||
The address that `cf-execd` should email agent output to. | ||
The address that `cf-execd` should email agent output to. Defaults to `root@$(default:def.domain)`. | ||
|
||
This setting can be customized via Augments, for example: | ||
|
||
```json | ||
{ | ||
"variables": { | ||
"default:def.mailto": { | ||
"value": "[email protected]", | ||
"comment": "When output differs from the prior execution cf-execd will deliver the output to this Email address for review." | ||
} | ||
} | ||
} | ||
``` | ||
|
||
### mailfrom | ||
|
||
The address that output mailed from `cf-execd` should come from. | ||
The address that output mailed from `cf-execd` should come from. Defaults to `root@$(sys.uqhost).$(def.domain)`. | ||
|
||
This setting can be customized via Augments, for example: | ||
|
||
```json | ||
{ | ||
"variables": { | ||
"default:def.mailfrom": { | ||
"value": "[email protected]", | ||
"comment": "Email sent from cf-execd should come from this address." | ||
} | ||
} | ||
} | ||
``` | ||
|
||
### smtpserver | ||
|
||
The SMTP server that `cf-execd` should use to send emails. | ||
The SMTP server that `cf-execd` should use to send emails. Defaults to `localhost`. | ||
|
||
This setting can be customized via Augments, for example: | ||
|
||
```json | ||
{ | ||
"variables": { | ||
"default:def.smtpserver": { | ||
"value": "smtp.example.com", | ||
"comment": "The smtp server that should be used when sending email from cf-execd." | ||
} | ||
} | ||
} | ||
``` | ||
|
||
### mailmaxlines | ||
|
||
The maximumm number of lines of output that `cf-execd` will email. | ||
The maximum number of lines of output that `cf-execd` will email. Defaults to `30`. | ||
|
||
This setting can be customized via Augments, for example: | ||
|
||
```json | ||
{ | ||
"variables": { | ||
"default:def.mailmaxlines": { | ||
"value": "50", | ||
"comment": "The maximum number of lines cf-execd should email." | ||
} | ||
} | ||
} | ||
``` | ||
|
||
**History:** | ||
|
||
|