clarify notifications on folder deletion

This commit is contained in:
Nicola Murino 2019-07-27 09:52:57 +02:00
parent 48451a9924
commit 6a6e31cceb

View file

@ -65,7 +65,7 @@ The `sftpgo.conf` configuration file contains the following sections:
- `max_auth_tries` integer. Maximum number of authentication attempts permitted per connection. If set to a negative number, the number of attempts are unlimited. If set to zero, the number of attempts are limited to 6. - `max_auth_tries` integer. Maximum number of authentication attempts permitted per connection. If set to a negative number, the number of attempts are unlimited. If set to zero, the number of attempts are limited to 6.
- `umask`, string. Umask for the new files and directories. This setting has no effect on Windows. Default: "0022" - `umask`, string. Umask for the new files and directories. This setting has no effect on Windows. Default: "0022"
- `actions`, struct. It contains the command to execute and/or the HTTP URL to notify and the trigger conditions - `actions`, struct. It contains the command to execute and/or the HTTP URL to notify and the trigger conditions
- `execute_on`, list of strings. Valid values are `download`, `upload`, `delete`, `rename`. Leave empty to disable actions. - `execute_on`, list of strings. Valid values are `download`, `upload`, `delete`, `rename`. On folder deletion a `delete` notification will be sent for each deleted file. Leave empty to disable actions.
- `command`, string. Absolute path to the command to execute. Leave empty to disable. The command is invoked with the following arguments: - `command`, string. Absolute path to the command to execute. Leave empty to disable. The command is invoked with the following arguments:
- `action`, any valid `execute_on` string - `action`, any valid `execute_on` string
- `username`, user who did the action - `username`, user who did the action
@ -102,8 +102,8 @@ Here is a full example showing the default config:
"max_auth_tries":0, "max_auth_tries":0,
"umask":"0022", "umask":"0022",
"actions":{ "actions":{
"execute_on":["upload"], "execute_on":[],
"command":"/usr/bin/uploadscript", "command":"",
"http_notification_url":"" "http_notification_url":""
} }
}, },