2024-04-13 22:03:13 +00:00
|
|
|
---
|
|
|
|
title: SFTPGo Plugins
|
|
|
|
---
|
2024-04-03 00:09:33 +00:00
|
|
|
|
2024-04-02 15:38:31 +00:00
|
|
|
Due to a number of different possible combinations of plugins, final configuration
|
|
|
|
must be done through manually set environmental variables. Please refer to examples below.
|
|
|
|
|
|
|
|
Note that all examples still require their env variables to be set in the proper chart
|
|
|
|
area, however without these manual additons those env variables won't add any functions to
|
|
|
|
the container.
|
|
|
|
|
|
|
|
## Examples
|
2024-04-03 00:09:33 +00:00
|
|
|
|
2024-04-02 15:38:31 +00:00
|
|
|
### LDAP Only
|
2024-04-03 00:09:33 +00:00
|
|
|
|
2024-04-02 15:38:31 +00:00
|
|
|
```yaml
|
2024-04-03 00:09:33 +00:00
|
|
|
SFTPGO_PLUGINS__0__TYPE: auth
|
|
|
|
SFTPGO_PLUGINS__0__AUTH_OPTIONS__SCOPE: 5
|
|
|
|
SFTPGO_PLUGINS__0__CMD: "/usr/local/bin/sftpgo-plugin-auth"
|
|
|
|
SFTPGO_PLUGINS__0__ARGS: "serve"
|
|
|
|
SFTPGO_PLUGINS__0__AUTO_MTLS: 1
|
2024-04-02 15:38:31 +00:00
|
|
|
```
|
2024-04-03 00:09:33 +00:00
|
|
|
|
2024-04-02 15:38:31 +00:00
|
|
|
### LDAP & Geoblocking
|
2024-04-03 00:09:33 +00:00
|
|
|
|
2024-04-02 15:38:31 +00:00
|
|
|
```yaml
|
2024-04-03 00:09:33 +00:00
|
|
|
SFTPGO_PLUGINS__0__TYPE: auth
|
|
|
|
SFTPGO_PLUGINS__0__AUTH_OPTIONS__SCOPE: 5
|
|
|
|
SFTPGO_PLUGINS__0__CMD: "/usr/local/bin/sftpgo-plugin-auth"
|
|
|
|
SFTPGO_PLUGINS__0__ARGS: "serve"
|
|
|
|
SFTPGO_PLUGINS__0__AUTO_MTLS: 1
|
|
|
|
SFTPGO_PLUGINS__1__TYPE: geoipfilter
|
|
|
|
SFTPGO_PLUGINS__1__CMD: "/usr/local/bin/sftpgo-plugin-geoipfilter"
|
|
|
|
SFTPGO_PLUGINS__1__ARGS: "serve"
|
2024-04-02 15:38:31 +00:00
|
|
|
```
|
2024-04-03 00:09:33 +00:00
|
|
|
|
2024-04-02 15:38:31 +00:00
|
|
|
### Geoblocking Only
|
2024-04-03 00:09:33 +00:00
|
|
|
|
2024-04-02 15:38:31 +00:00
|
|
|
```yaml
|
2024-04-03 00:09:33 +00:00
|
|
|
SFTPGO_PLUGINS__0__TYPE: geoipfilter
|
|
|
|
SFTPGO_PLUGINS__0__CMD: "/usr/local/bin/sftpgo-plugin-geoipfilter"
|
|
|
|
SFTPGO_PLUGINS__0__ARGS: "serve"
|
2024-04-02 15:38:31 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
### Tip
|
2024-04-03 00:09:33 +00:00
|
|
|
|
2024-04-02 15:38:31 +00:00
|
|
|
There are [some variables][1] which can only be found by looking at code.
|
|
|
|
|
|
|
|
[1]: https://github.com/drakkan/sftpgo/blob/cb3bc3f6043791081d28b9b1666a053a33e2a962/internal/config/config.go#L920
|