From 193d11587dcf8b0d84ad84888020f4432e2772a6 Mon Sep 17 00:00:00 2001 From: Nicola Murino Date: Sat, 27 Apr 2024 14:40:20 +0200 Subject: [PATCH] examples: update docs Signed-off-by: Nicola Murino --- examples/OTP/authy/README.md | 2 ++ examples/backup/README.md | 2 +- examples/data-retention/README.md | 2 +- examples/ldapauth/README.md | 2 +- examples/ldapauthserver/README.md | 2 ++ examples/quotascan/README.md | 2 +- 6 files changed, 8 insertions(+), 4 deletions(-) diff --git a/examples/OTP/authy/README.md b/examples/OTP/authy/README.md index c2b0973f..af582956 100644 --- a/examples/OTP/authy/README.md +++ b/examples/OTP/authy/README.md @@ -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. 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. diff --git a/examples/backup/README.md b/examples/backup/README.md index b5a1adc9..d00ce1d8 100644 --- a/examples/backup/README.md +++ b/examples/backup/README.md @@ -1,6 +1,6 @@ # 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. diff --git a/examples/data-retention/README.md b/examples/data-retention/README.md index e098464f..6508c295 100644 --- a/examples/data-retention/README.md +++ b/examples/data-retention/README.md @@ -1,6 +1,6 @@ # 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. diff --git a/examples/ldapauth/README.md b/examples/ldapauth/README.md index eeacf2bc..c55d4f96 100644 --- a/examples/ldapauth/README.md +++ b/examples/ldapauth/README.md @@ -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). diff --git a/examples/ldapauthserver/README.md b/examples/ldapauthserver/README.md index 803e8acd..a45c45a2 100644 --- a/examples/ldapauthserver/README.md +++ b/examples/ldapauthserver/README.md @@ -9,3 +9,5 @@ You can build this example using the following command: ```console 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). diff --git a/examples/quotascan/README.md b/examples/quotascan/README.md index 52c3fb77..0e7c0a04 100644 --- a/examples/quotascan/README.md +++ b/examples/quotascan/README.md @@ -1,6 +1,6 @@ # 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.