Skip to content

Commit

Permalink
examples: update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Nicola Murino <[email protected]>
  • Loading branch information
drakkan committed Apr 27, 2024
1 parent 4d4d2ad commit 193d115
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 4 deletions.
2 changes: 2 additions & 0 deletions examples/OTP/authy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion examples/backup/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion examples/data-retention/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion examples/ldapauth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 2 additions & 0 deletions examples/ldapauthserver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion examples/quotascan/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit 193d115

Please sign in to comment.