Skip to content

Latest commit

 

History

History
89 lines (70 loc) · 4.97 KB

custom-actions.md

File metadata and controls

89 lines (70 loc) · 4.97 KB
Raw

Custom Actions

The actions struct inside the "common" configuration section allows to configure the actions for file operations and SSH commands. The hook can be defined as the absolute path of your program or an HTTP URL.

The upload condition includes both uploads to new files and overwrite of existing files. If an upload is aborted for quota limits SFTPGo tries to remove the partial file, so if the notification reports a zero size file and a quota exceeded error the file has been deleted. The ssh_cmd condition will be triggered after a command is successfully executed via SSH. scp will trigger the download and upload conditions and not ssh_cmd. The notification will indicate if an error is detected and so, for example, a partial file is uploaded. The pre-delete action, if defined, will be called just before files deletion. If the external command completes with a zero exit status or the HTTP notification response code is 200 then SFTPGo will assume that the file was already deleted/moved and so it will not try to remove the file and it will not execute the hook defined for the delete action.

If the hook defines a path to an external program, then this program is invoked with the following arguments:

  • action, string, possible values are: download, upload, pre-delete,delete, rename, ssh_cmd
  • username
  • path is the full filesystem path, can be empty for some ssh commands
  • target_path, non-empty for rename action and for sftpgo-copy SSH command
  • ssh_cmd, non-empty for ssh_cmd action

The external program can also read the following environment variables:

  • SFTPGO_ACTION
  • SFTPGO_ACTION_USERNAME
  • SFTPGO_ACTION_PATH
  • SFTPGO_ACTION_TARGET, non-empty for rename SFTPGO_ACTION
  • SFTPGO_ACTION_SSH_CMD, non-empty for ssh_cmd SFTPGO_ACTION
  • SFTPGO_ACTION_FILE_SIZE, non-empty for upload, download and delete SFTPGO_ACTION
  • SFTPGO_ACTION_FS_PROVIDER, 0 for local filesystem, 1 for S3 backend, 2 for Google Cloud Storage (GCS) backend, 3 for Azure Blob Storage backend
  • SFTPGO_ACTION_BUCKET, non-empty for S3, GCS and Azure backends
  • SFTPGO_ACTION_ENDPOINT, non-empty for S3 and Azure backend if configured. For Azure this is the SAS URL, if configured otherwise the endpoint
  • SFTPGO_ACTION_STATUS, integer. 0 means a generic error occurred. 1 means no error, 2 means quota exceeded error
  • SFTPGO_ACTION_PROTOCOL, string. Possible values are SSH, SFTP, SCP, FTP, DAV

Previous global environment variables aren't cleared when the script is called. The program must finish within 30 seconds.

If the hook defines an HTTP URL then this URL will be invoked as HTTP POST. The request body will contain a JSON serialized struct with the following fields:

  • action
  • username
  • path
  • target_path, not null for rename action
  • ssh_cmd, not null for ssh_cmd action
  • file_size, not null for upload, download, delete actions
  • fs_provider, 0 for local filesystem, 1 for S3 backend, 2 for Google Cloud Storage (GCS) backend, 3 for Azure Blob Storage backend
  • bucket, not null for S3, GCS and Azure backends
  • endpoint, not null for S3 and Azure backend if configured. For Azure this is the SAS URL, if configured otherwise the endpoint
  • status, integer. 0 means a generic error occurred. 1 means no error, 2 means quota exceeded error
  • protocol, string. Possible values are SSH, FTP, DAV

The HTTP request will use the global configuration for HTTP clients.

The actions struct inside the "data_provider" configuration section allows you to configure actions on user add, update, delete.

Actions will not be fired for internal updates, such as the last login or the user quota fields, or after external authentication.

If the hook defines a path to an external program, then this program is invoked with the following arguments:

  • action, string, possible values are: add, update, delete
  • username
  • ID
  • status
  • expiration_date
  • home_dir
  • uid
  • gid

The external program can also read the following environment variables:

  • SFTPGO_USER_ACTION
  • SFTPGO_USER_USERNAME
  • SFTPGO_USER_PASSWORD, hashed password as stored inside the data provider, can be empty if the user does not login using a password
  • SFTPGO_USER_ID
  • SFTPGO_USER_STATUS
  • SFTPGO_USER_EXPIRATION_DATE
  • SFTPGO_USER_HOME_DIR
  • SFTPGO_USER_UID
  • SFTPGO_USER_GID
  • SFTPGO_USER_QUOTA_FILES
  • SFTPGO_USER_QUOTA_SIZE
  • SFTPGO_USER_UPLOAD_BANDWIDTH
  • SFTPGO_USER_DOWNLOAD_BANDWIDTH
  • SFTPGO_USER_MAX_SESSIONS
  • SFTPGO_USER_FS_PROVIDER

Previous global environment variables aren't cleared when the script is called. The program must finish within 15 seconds.

If the hook defines an HTTP URL then this URL will be invoked as HTTP POST. The action is added to the query string, for example <hook>?action=update, and the user is sent serialized as JSON inside the POST body with sensitive fields removed.

The HTTP request will use the global configuration for HTTP clients.