mirror of
https://github.com/drakkan/sftpgo.git
synced 2025-12-07 06:40:54 +03:00
improve README
This commit is contained in:
@@ -168,7 +168,7 @@ The `sftpgo` configuration file contains the following sections:
|
|||||||
- `pool_size`, integer. Sets the maximum number of open connections for `mysql` and `postgresql` driver. Default 0 (unlimited)
|
- `pool_size`, integer. Sets the maximum number of open connections for `mysql` and `postgresql` driver. Default 0 (unlimited)
|
||||||
- `users_base_dir`, string. Users' default base directory. If no home dir is defined while adding a new user, and this value is a valid absolute path, then the user home dir will be automatically defined as the path obtained joining the base dir and the username
|
- `users_base_dir`, string. Users' default base directory. If no home dir is defined while adding a new user, and this value is a valid absolute path, then the user home dir will be automatically defined as the path obtained joining the base dir and the username
|
||||||
- `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 `add`, `update`, `delete`.
|
- `execute_on`, list of strings. Valid values are `add`, `update`, `delete`. `update` action will not be fired for internal updates such as the last login or the user quota fields.
|
||||||
- `command`, string. Absolute path to the command to execute. Leave empty to disable. The command is invoked with the following arguments that identify the user added, updated or deleted:
|
- `command`, string. Absolute path to the command to execute. Leave empty to disable. The command is invoked with the following arguments that identify the user added, updated or deleted:
|
||||||
- `action`, any valid `execute_on` string
|
- `action`, any valid `execute_on` string
|
||||||
- `username`
|
- `username`
|
||||||
|
|||||||
@@ -134,7 +134,7 @@ type Config struct {
|
|||||||
// defined as the path obtained joining the base dir and the username
|
// defined as the path obtained joining the base dir and the username
|
||||||
UsersBaseDir string `json:"users_base_dir" mapstructure:"users_base_dir"`
|
UsersBaseDir string `json:"users_base_dir" mapstructure:"users_base_dir"`
|
||||||
// Actions to execute on user add, update, delete.
|
// Actions to execute on user add, update, delete.
|
||||||
// Update action will not be fired for internal updates such as the last login fiels or the user quota.
|
// Update action will not be fired for internal updates such as the last login or the user quota fields.
|
||||||
Actions Actions `json:"actions" mapstructure:"actions"`
|
Actions Actions `json:"actions" mapstructure:"actions"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user