From 571e088fdd180bd3a81159cf8918412666f5e845 Mon Sep 17 00:00:00 2001 From: Nicola Murino Date: Sun, 30 Oct 2022 08:34:16 +0100 Subject: [PATCH] improve some docs Signed-off-by: Nicola Murino --- examples/backup/README.md | 2 ++ examples/data-retention/README.md | 2 ++ examples/quotascan/README.md | 2 ++ fail2ban/README.md | 3 +++ 4 files changed, 9 insertions(+) create mode 100644 fail2ban/README.md diff --git a/examples/backup/README.md b/examples/backup/README.md index e11e06b1..b5a1adc9 100644 --- a/examples/backup/README.md +++ b/examples/backup/README.md @@ -1,5 +1,7 @@ # Data Backup +:warning: Since v2.4.0 you can use the [EventManager](../../docs/eventmanager.md) to schedule backups. + The `backup` example script shows how to use the SFTPGo REST API to backup your data. The script is written in Python and has the following requirements: diff --git a/examples/data-retention/README.md b/examples/data-retention/README.md index a1c96c9e..e098464f 100644 --- a/examples/data-retention/README.md +++ b/examples/data-retention/README.md @@ -1,5 +1,7 @@ # File retention policies +:warning: Since v2.4.0 you can use the [EventManager](../../docs/eventmanager.md) to schedule data retention checks. + The `checkretention` example script shows how to use the SFTPGo REST API to manage data retention. :warning: Deleting files is an irreversible action, please make sure you fully understand what you are doing before using this feature, you may have users with overlapping home directories or virtual folders shared between multiple users, it is relatively easy to inadvertently delete files you need. diff --git a/examples/quotascan/README.md b/examples/quotascan/README.md index 861bbbd1..52c3fb77 100644 --- a/examples/quotascan/README.md +++ b/examples/quotascan/README.md @@ -1,5 +1,7 @@ # Update user quota +:warning: Since v2.4.0 you can use the [EventManager](../../docs/eventmanager.md) to schedule quota scans. + The `scanuserquota` example script shows how to use the SFTPGo REST API to update the users' quota. The stored quota may be incorrect for several reasons, such as an unexpected shutdown while uploading files, temporary provider failures, files copied outside of SFTPGo, and so on. diff --git a/fail2ban/README.md b/fail2ban/README.md new file mode 100644 index 00000000..7783cbd6 --- /dev/null +++ b/fail2ban/README.md @@ -0,0 +1,3 @@ +# Fail2ban + +:warning: We recommend using the [built-in defender](../docs/defender.md) instead of Fail2ban.