How to manage your FTP and SFTP access under ISPConfig?

Procédure

FTP or SFTP access allows you to transfer a website’s files between your computer and your VPS server. You can use it in particular to publish a website, modify its files, or give separate access to a provider.

This guide explains how to create an FTP or SFTP user, change the password of an FTP account, and configure the connection in FileZilla.

Before you begin

The site you want to grant access to must already be created in ISPConfig. You must also have the necessary permissions to manage this site.

To test the connection from your computer, install software compatible with FTP and SFTP, for example FileZilla.

Choosing between FTP and SFTP

FTP and SFTP both allow files to be transferred, but they do not use the same type of account in ISPConfig.

An FTP connection can be encrypted when it uses the FTPS protocol, usually in the form of an explicit FTP connection over TLS. SFTP, on the other hand, uses the SSH protocol: it is therefore a different technology.

When possible, prefer SFTP. Otherwise, use an explicit FTP connection over TLS rather than an unencrypted FTP connection.

Create an FTP user

1. In ISPConfig, open the Sites (1) menu.
2. In the left menu, click FTP User (2).
   
3. Click New FTP User.
4. In the Website field, select the site this user should be able to access.
   
5. Enter the desired username.
6. Enter a sufficiently long password that is difficult to guess, then confirm it if ISPConfig displays a second field.

7. Click Save.

The new user then appears in the FTP user list.

FTP connection settings

To connect with this user, use the following settings:

• Protocol : FTP;
• Encryption : use an explicit FTP connection over TLS if available;
• Host : IP address or hostname of your VPS;
• Port : 21;
• Username : full username displayed in ISPConfig;
• Password : password defined when the account was created.

If your domain does not yet point to the VPS, use the server’s IP address as the connection host.

To learn how to configure FileZilla, Cyberduck, or WinSCP and transfer your website files, see: How do I publish a website via FTP with FileZilla, Cyberduck or WinSCP?

Once connected, the site’s public files are located in the web folder.

Change an FTP user’s password

You can change an FTP user’s password if it has been forgotten, shared with someone else, or saved in software you no longer have access to.

1. In ISPConfig, open the Sites (1) menu.
2. Click FTP User (2) in the left menu.
   
3. In the list, click the user to edit (3).
4. Enter the new password, then confirm it in the second field.
   
5. Click Save.

Create a user for an SFTP connection

An SFTP connection uses a Shell user, not an FTP user.

1. In ISPConfig, open the Sites (1) menu.
2. In the left menu, click Shell User (2).
   
3. Click New Shell User (3).
4. In the Website field, select the site the user should be able to access.
   
5. Enter the username.

As with an FTP user, ISPConfig can automatically add a prefix to the chosen name. Always use the full name displayed in the panel.

6. Enter the password, then confirm it.
7. Click Save.

The account then appears in the Shell user list.

SFTP connection settings

To connect with this user, use the following settings:

• Protocol : SFTP – SSH File Transfer Protocol;
• Host : IP address of your VPS;
• Port :
  • Unmanaged VPS : 22 by default, unless you have changed the SSH port;
  • Older managed VPS : 5804;
  • Recent managed VPS : 22 or 5804;
• Authentication type : normal or password;
• Username : full Shell user name displayed in ISPConfig;
• Password : password defined when the account was created.

You can use FileZilla or another SFTP-compatible software. The browsing and file transfer process is similar to the one presented in the following guide: How do I publish a website via FTP with FileZilla, Cyberduck or WinSCP?

During the first SFTP connection, the software may display the server’s identification key. Make sure you are connecting to your VPS’s IP address before accepting it.

Check that access works

Access is correctly configured when your software displays the site folders without authentication errors.

With an FTP account, open the web folder to find the site’s public files.

You can also transfer a small test file, verify that it appears on the server, then delete it.

Common issues

I get a username or password error

Check that you are using the full name displayed in ISPConfig. It may contain a prefix automatically added by the panel.

Manually retype the password to avoid spaces added during copy and paste.

Also make sure you are using the account appropriate for the chosen protocol:

• a FTP User for an FTP or FTPS connection;
• a Shell User for an SFTP connection.

The connection no longer works after changing the password

Your software is probably still using the old saved password.

Open the settings for the relevant connection and replace the old password. You can also delete the saved password so that the software asks for it at the next connection.

The connection is refused

Check that the protocol and port match the type of account used:

• FTP or FTPS: port 21;
• SFTP on an unmanaged VPS: port 22 by default, or the custom SSH port;
• SFTP on an older managed VPS: port 5804;
• SFTP on a recent managed VPS: port 22 or 5804.

Also check that you are using the correct account type: an FTP user for FTP or FTPS, and a Shell user for SFTP.

Also verify that the IP address or hostname matches the VPS on which the account was created.

I am connected, but I cannot see my website files

With an FTP account, open the web folder.

If the expected files are not there, check in ISPConfig that the user has been associated with the correct website.

I do not see the Shell User menu

The account used to access ISPConfig may not have the necessary permissions to create a Shell user.

Log in again with an account authorized to administer the site, or ask the VPS administrator to create the SFTP access.