n8n-docs/docs/integrations/builtin/credentials/ssh.md

title, description, contentType

title	description	contentType
SSH credentials	Documentation for SSH credentials. Use these credentials to authenticate SSH in n8n, a workflow automation platform.	integration

SSH credentials

You can use these credentials to authenticate the following nodes:

• SSH

Prerequisites

• Create a remote server with SSH enabled.
• Create one of the following:
  • A user account that can ssh into server: Use with password authentication.
  • An SSH key for the server or service: Use with private key authentication.

Supported authentication methods

• Password
• Private key

Related resources

Secure Shell (SSH) protocol is a method for securely sending commands over a network. Refer to Connecting to GitHub with SSH for an example of SSH setup.

Using password

To configure this credential, you'll need:

• A Host: Enter the IP address of the server you are connecting to.
• A Port: Enter the port to use for this connection. SSH uses port 22 by default.
• A Username: Enter the username for the user account with ssh access on the server.
• A Password: Enter the password for that user account.

Using private key

To configure this credential, you'll need:

• A Host: Enter the IP address of the server you are connecting to.
• A Port: Enter the port to use for this connection. SSH uses port 22 by default.
• A Username: Enter the username the private key was generated for.
• An SSH Private Key: Enter the entire contents of your SSH private key.
• Optional: If a Passphrase was used for the key, enter the passphrase. If no passphrase was used, leave blank.