beenull/sftpgo-mirror
1
0
Fork 0
mirror of https://github.com/drakkan/sftpgo.git synced 2024-11-21 23:20:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

examples: update docs

Browse source 
Signed-off-by: Nicola Murino <nicola.murino@gmail.com>
This commit is contained in:
Nicola Murino 2024-04-27 14:40:20 +02:00
parent 4d4d2ad801
commit 193d11587d
No known key found for this signature in database
GPG key ID: 935D2952DEC4EECF
6 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
examples/OTP/authy/README.md
View file

@ -56,3 +56,5 @@ We provide the following examples:
- [Check password hook](./checkpwd/README.md) for 2FA using a password consisting of a fixed string and a One Time Token. - [Check password hook](./checkpwd/README.md) for 2FA using a password consisting of a fixed string and a One Time Token.
Please note that these are sample programs not intended for production use, you should write your own hook based on them and you should prefer HTTP based hooks if performance is a concern. Please note that these are sample programs not intended for production use, you should write your own hook based on them and you should prefer HTTP based hooks if performance is a concern.
:warning: SFTPGo has also built-in 2FA support.

2
examples/backup/README.md
View file

@ -1,6 +1,6 @@
# Data Backup # Data Backup
:warning: Since v2.4.0 you can use the [EventManager](../../docs/eventmanager.md) to schedule backups. :warning: Since v2.4.0 you can use the [EventManager](https://sftpgo.github.io/latest/eventmanager/) 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.

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

@ -1,6 +1,6 @@
# File retention policies # File retention policies
:warning: Since v2.4.0 you can use the [EventManager](../../docs/eventmanager.md) to schedule data retention checks. :warning: Since v2.4.0 you can use the [EventManager](https://sftpgo.github.io/latest/eventmanager/) 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.

2
examples/ldapauth/README.md
View file

@ -45,4 +45,4 @@ aci: (targetattr = "sshPublicKey") (version 3.0; acl "Allow members of sshpublic
- -
``` ```
Please feel free to send pull requests to improve this example authentication program, thanks! :warning: A plugin for LDAP/Active Directory authentication is also [available](https://github.com/sftpgo/sftpgo-plugin-auth).

2
examples/ldapauthserver/README.md
View file

@ -9,3 +9,5 @@ You can build this example using the following command:
```console ```console
go build -ldflags "-s -w" -o ldapauthserver go build -ldflags "-s -w" -o ldapauthserver
``` ```
:warning: A plugin for LDAP/Active Directory authentication is also [available](https://github.com/sftpgo/sftpgo-plugin-auth).

2
examples/quotascan/README.md
View file

@ -1,6 +1,6 @@
# Update user quota # Update user quota
:warning: Since v2.4.0 you can use the [EventManager](../../docs/eventmanager.md) to schedule quota scans. :warning: Since v2.4.0 you can use the [EventManager](https://sftpgo.github.io/latest/eventmanager/) 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.