1. cPanel & WHM Documentation
  2. WHM
  3. Scripts
  4. The setupftpserver script
whmadvanced ftp

The setupftpserver script

Valid for versions 82 through the latest version

Version:

82

Last modified: October 19, 2020

Overview

The /usr/local/cpanel/scripts/setupftpserver script allows you to select your server’s FTP server, configure anonymous FTP services, or disable FTP services.

Note:

You can select an FTP server with WHM’s FTP Server Selection interface (WHM » Home » Service Configuration » FTP Server Selection). You can also configure anonymous FTP with WHM’s FTP Server Configuration interface (WHM » Home » Service Configuration » FTP Server Configuration).

Run the script

To run this script on the command line, use the following format:

/usr/local/cpanel/scripts/setupftpserver options ftpserver

Options

Use the following options with this script:

Options Description Example
--force Run this script and do not stop for warnings, even if the script fails. /usr/local/cpanel/scripts/setupftpserver --force pure-ftpd
--current Display the currently-configured FTP server. /usr/local/cpanel/scripts/setupftpserver --current
--enable-anonymous Enable anonymous FTP.
Warning:
This feature may cause security risks.
/usr/local/cpanel/scripts/setupftpserver --enable-anonymous pure-ftpd

Use the following values for the ftpserver option:

Value Description Example
pure-ftpd Use the Pure-FTPd FTP server. /usr/local/cpanel/scripts/setupftpserver pure-ftpd
proftp Use the ProFTP FTP server. /usr/local/cpanel/scripts/setupftpserver proftpd
disabled Disable FTP services. /usr/local/cpanel/scripts/setupftpserver disabled

Additional Documentation