Last updated on 3rd February 2026

Configuring an SSH/SFTP server

The server form is organized into sections to help you configure your connection step by step.

Server Details

Enter the hostname of your server, then enter the port your server is listening on (if you haven't changed this you can leave this field blank and DeployHQ will use the default port 22).

Enter your username for the server connection.

SSH Server Details

Authentication

The Authentication section provides three methods to authenticate with your server, presented as tabs:

  • Public Key -- Displays your project's public SSH key. Copy this key and add it to the authorized_keys file on your server (see SSH Key authentication below).
  • Setup Script -- Provides a ready-to-use shell script that you can copy and paste into your server's terminal to automatically install the SSH key.
  • Password -- Allows you to enter a password for authentication. For security reasons, SSH key authentication is recommended over password authentication.

New servers default to the Public Key tab. If you are editing an existing server that uses password authentication, the Password tab will be selected automatically.

SSH Authentication - Public Key tab

SSH Authentication - Setup Script tab

SSH Authentication - Password tab

Deployment Path

Enter the directory on the server where your files should be placed (for example, public_html/ or /absolute/path/here). This directory must already exist on the server and be writable by the deployment user.

SSH Deployment Path

Advanced Options

Configure additional deployment settings such as zero-downtime (atomic) deployments, accelerated transfers (turbo deployments), and the unlink before upload option.

SSH Advanced Options

SSH Key authentication

If you choose to use your project's public key to authenticate, you can copy it from the Public Key tab in the Authentication section, then login to your server as the same user that you're configuring in DeployHQ. The easiest way to do this is via a terminal.

Alternatively, you can use the Setup Script tab, which provides a shell command that automatically installs the key for you. Simply copy the script and paste it into your server's terminal.

To install the key manually, run the following commands once logged in:

cd ~/.ssh/
nano authorized_keys

Then, paste the key into the file as a new line, with no trailing spaces. Then, press Ctrl+X, then y, then hit enter to save your key.