-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/gh-pages'
- Loading branch information
Showing
14 changed files
with
127 additions
and
119 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 |
|---|---|---|
|
|
@@ -1868,7 +1868,7 @@ <h2 id="common">Common</h2> | |
| <li><code>rename_mode</code>, integer. By default (<code>0</code>), renaming of non-empty directories is not allowed for cloud storage providers (S3, GCS, Azure Blob). Set to <code>1</code> to enable recursive renames for these providers, they may be slow, there is no atomic rename API like for local filesystem, so SFTPGo will recursively list the directory contents and do a rename for each entry (partial renaming and incorrect disk quota updates are possible in error cases). Default <code>0</code>.</li> | ||
| <li><code>resume_max_size</code>, integer. defines the maximum size allowed, in bytes, to resume uploads on storage backends with immutable objects. By default, resuming uploads is not allowed for cloud storage providers (S3, GCS, Azure Blob) because SFTPGo must rewrite the entire file. Set to a value greater than 0 to allow resuming uploads of files smaller than or equal to the defined size. Please note that uploads for these backends are still atomic, the client must intentionally upload a portion of the target file and then resume uploading.. Default <code>0</code>.</li> | ||
| <li><code>temp_path</code>, string. Defines the path for temporary files such as those used for atomic uploads or file pipes. If you set this option you must make sure that the defined path exists, is accessible for writing by the user running SFTPGo, and is on the same filesystem as the users home directories otherwise the renaming for atomic uploads will become a copy and therefore may take a long time. The temporary files are not namespaced. The default is generally fine. Leave empty for the default.</li> | ||
| <li><code>proxy_protocol</code>, integer. Support for <a href="https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt" target="_blank">HAProxy PROXY protocol</a>. If you are running SFTPGo behind a proxy server such as HAProxy, AWS ELB or NGINX, you can enable the proxy protocol. It provides a convenient way to safely transport connection information such as a client's address across multiple layers of NAT or TCP proxies to get the real client IP address instead of the proxy IP. Both protocol versions 1 and 2 are supported. If the proxy protocol is enabled in SFTPGo then you have to enable the protocol in your proxy configuration too. For example, for HAProxy, add <code>send-proxy</code> or <code>send-proxy-v2</code> to each server configuration line. The PROXY protocol is supported for SSH/SFTP and FTP/S. The following modes are supported:<ul> | ||
| <li><code>proxy_protocol</code>, integer. Support for <a href="https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt" target="_blank">HAProxy PROXY protocol</a>. If you are running SFTPGo behind a proxy server such as HAProxy, AWS ELB or NGINX, and your proxy is not able to preserve the clients IP address, you can enable the proxy protocol. It provides a convenient way to safely transport connection information such as a client's address across multiple layers of NAT or TCP proxies to get the real client IP address instead of the proxy IP. Both protocol versions 1 and 2 are supported. If the proxy protocol is enabled in SFTPGo then you have to enable the protocol in your proxy configuration too. For example, for HAProxy, add <code>send-proxy</code> or <code>send-proxy-v2</code> to each server configuration line. The PROXY protocol is supported for SSH/SFTP and FTP/S. The following modes are supported:<ul> | ||
| <li>0, disabled</li> | ||
| <li>1, enabled. If the upstream IP is not allowed to send a proxy header, the header will be ignored. Using this mode does not mean that we can accept connections with and without the proxy header. We always try to read the proxy header and we ignore it if the upstream IP is not allowed to send a proxy header. Set <code>proxy_skipped</code> if you want to allow some IPs/networks to connect without sending a proxy header and without SFTPGo trying to read it</li> | ||
| <li>2, required. If the upstream IP is not allowed to send a proxy header, the connection will be rejected if a proxy header is found. We always try to read the proxy header. Set <code>proxy_skipped</code> if you want to allow some IPs/networks to connect without sending a proxy header and without SFTPGo trying to read it</li> | ||
|
|
@@ -1925,6 +1925,10 @@ <h2 id="common">Common</h2> | |
| <li><code>entries_hard_limit</code>, integer. The number of per-ip rate limiters kept in memory will vary between the soft and hard limit</li> | ||
| </ul> | ||
| </li> | ||
| <li><code>event_manager</code>, struct containing the configuration for the EventManager<ul> | ||
| <li><code>enabled_commands</code>, list of strings. Absolute path to system commands that can be executed through Event Manager. An empty list means that no commands are allowed to be executed. <img alt="⚠" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/26a0.svg" title=":warning:" /> Allowing system command could pose a security risk. Default: empty</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <h2 id="acme">ACME</h2> | ||
| <p>Automatic Certificate Management Environment (ACME) protocol configuration. To obtain the certificates the first time you have to configure the ACME protocol and execute the <code>sftpgo acme run</code> command or use the WebAdmin UI. The SFTPGo service will take care of the automatic renewal of certificates for the configured domains.</p> | ||
|
|
||
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
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 |
|---|---|---|
|
|
@@ -1564,7 +1564,7 @@ <h1 id="event-manager">Event Manager</h1> | |
| <p>The following actions are supported:</p> | ||
| <ul> | ||
| <li><code>HTTP notification</code>. You can notify an HTTP/S endpoing via GET, POST, PUT, DELETE methods. You can define custom headers, query parameters and a body for POST and PUT request. Placeholders are supported for username, body, header and query parameter values.</li> | ||
| <li><code>Command execution</code>. You can launch custom commands passing parameters via environment variables. Placeholders are supported for environment variable values.</li> | ||
| <li><code>Command execution</code>. You can launch custom commands passing parameters via environment variables. Placeholders are supported for environment variable values. <img alt="⚠" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/26a0.svg" title=":warning:" /> Allowing any system command could pose a security risk, they are disabled by default.</li> | ||
| <li><code>Email notification</code>. Placeholders are supported in subject and body. The email will be sent as plain text. For this action to work you have to configure an SMTP server in the SFTPGo configuration file.</li> | ||
| <li><code>Backup</code>. A backup will be saved in the configured backup directory. The backup will contain the week day and the hour in the file name.</li> | ||
| <li><code>Rotate log file</code>. If file logging is enabled, the log file will be rotated regardless of its size.</li> | ||
|
|
||
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
Large diffs are not rendered by default.
Oops, something went wrong.
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
Binary file not shown.
Oops, something went wrong.