beenull/sftpgo-mirror
1
0
Fork 0
mirror of https://github.com/drakkan/sftpgo.git synced 2024-11-22 07:30:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

improve some docs

Browse source 
Signed-off-by: Nicola Murino <nicola.murino@gmail.com>
This commit is contained in:
Nicola Murino 2022-10-30 08:34:16 +01:00
parent bf45d04600
commit 5618b95372
No known key found for this signature in database
GPG key ID: 935D2952DEC4EECF
4 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
examples/backup/README.md
View file

@ -1,5 +1,7 @@
# Data Backup # 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 `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: The script is written in Python and has the following requirements:

2
examples/data-retention/README.md
View file

@ -1,5 +1,7 @@
# File retention policies # 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. 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. :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.

2
examples/quotascan/README.md
View file

@ -1,5 +1,7 @@
# Update user quota # 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 `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. 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.

3
fail2ban/README.md Normal file
View file

@ -0,0 +1,3 @@
# Fail2ban
:warning: We recommend using the [built-in defender](../docs/defender.md) instead of Fail2ban.