## ProFTPD Contrib Module Documentation

The following is a collection of HTML documentation for modules and tools in the `contrib/` directory of the ProFTPD source distribution.

The `ftpasswd` script
  Used to easily create and manage `AuthUserFile`s and `AuthGroupFile`s

The `ftpquota` script
  Used for creating and managing file-based tables for the `mod_quotatab` module

The `ftpmail` script
  Used for automatically sending emails whenever a file is uploaded

The `mod_auth_otp` module
  For supporting HOTP/TOTP One-Time Passwords (OTP) for multi-factor authentication, e.g. using Google Authenticator

The `mod_ban` module
  For supporting automatic bans based on configurable thresholds

The `mod_ctrls_admin` module
  Adds administrative controls actions for the `ftpdctl` program. Controls are covered in more detail in the Controls mini-HOWTO

The `mod_deflate` module
  For supporting `MODE Z` compression of data transfers

The `mod_digest` module
  For supporting FTP `HASH` commands for files

The `mod_dnsbl` module
  For using DNS blacklists for access control

The `mod_dynmasq` module
  For automatically refreshing IP addresses of dynamic DNS names

The `mod_exec` module
  For executing external commands based on configurable criteria

The `mod_geoip` module
  For looking up geographic information based on client IP address

The `mod_ifsession` module
  For adding per-user/group/Class sections to your `proftpd.conf` file

The `mod_ifversion` module
  For adding version-specific sections to your `proftpd.conf` file

The `mod_load` module
  For configuring server availability based on system load

The `mod_log_forensic` module
  For writing log messages only when configurable criteria are met

The `mod_qos` module
  For configuring site-specific Quality of Service (QOS) packet values

The `mod_quotatab` module
  Adds quota support for `proftpd`

The `mod_quotatab_file` module
  This is one of the supporting modules for `mod_quotatab` which handles quota tables that are stored in specially formatted files on disk

The `mod_quotatab_ldap` module
  This one of the supporting modules for `mod_quotatab` which handles reading quota limits from LDAP directories

The `mod_quotatab_sql` module
  This is one of the supporting modules for `mod_quotatab` which handles quota tables that are stored in SQL databases

The `mod_radius` module
  Provides support for authenticating users using the RADIUS protocol

The `mod_readme` module
  Displays messages reminding users to read README files

The `mod_rewrite` module
  Adds the ability to rewrite FTP commands sent by clients on-the-fly, using regular expression matching and substitution

The `mod_sftp` module
  Supports SSH2 authentication, SFTP and SCP transfers

The `mod_sftp_pam` module
  Supports SSH2 authentication via PAM

The `mod_sftp_sql` module
  Supports storage/retrieval of authorized SSH keys using SQL databases

The `mod_shaper` module
  Adds dynamic traffic shaping based on number of concurrent sessions and transfers

The `mod_site_misc` module
  Adds support for miscellaneous `SITE` commands such as `SITE MKDIR`, `SITE SYMLINK`, and `SITE UTIME`

The `mod_snmp` module

  Provides SNMPv2 monitoring capabilities.

The `mod_sql` module
  Provides support for authenticating users using user information stored in SQL databases. Logging of various data into SQL tables is also supported.

The `mod_sql_passwd` module
  Supports MD5, SHA1, SHA256, SHA512 encoded passwords in SQL databases

The `mod_statcache` module
  Supports caching `stat(2)`/`lstat(2)` data in a shared location, for reuse across sessions/processes.

The `mod_tls` module
  Adds the ability to encrypt the control and data connections using SSL/TLS

The `mod_tls_memcache` module
  Provides SSL session caching, for faster SSL session negotiation, using a memcached servers for the shared cache

The `mod_tls_redis` module
  Provides SSL session caching, for faster SSL session negotiation, using Redis

The `mod_tls_shmcache` module
  Provides SSL session caching, for faster SSL session negotiation, using a shared memory cache

The `mod_unique_id` module
  For generating a unique ID for every FTP session

The `mod_wrap` module
  Supports using the `/etc/hosts.allow` and `/etc/hosts.deny` files, or other allow/deny files, for IP-based access control.

The `mod_wrap2` module
  Supports using the `/etc/hosts.allow` and `/etc/hosts.deny` files, or other allow/deny files, as well as SQL-based access rules, for IP-based access control.

The `mod_wrap2_file` module
  This is one of the supporting modules for `mod_wrap2` which handles access rules that are stored in specially formatted files on disk

The `mod_wrap2_redis` module
  This is one of the supporting modules for `mod_wrap2` which handles access rules that are stored in Redis lists/sets

The `mod_wrap2_sql` module
  This is one of the supporting modules for `mod_wrap2` which handles access rules that are stored in SQL database tables

If your question or issue is not covered by any of these pages, please send a request to the ProFTPD documentation list. Directions for subscribing to the docs list, as well as the other ProFTPD mailing lists, are at:

      http://www.proftpd.org/lists.html

If you are looking to see if ProFTPD supports a particular feature, the first place to look as the complete list of configuration directives:

      http://www.proftpd.org/docs/directives/index.html

The list may be intimidatingly long, but it is well worth scanning through all of the directives to see everything that ProFTPD is capable of supporting.

© Copyright 2017-2022 The ProFTPD Project
All Rights Reserved