mirror of
https://github.com/n8n-io/n8n-docs.git
synced 2025-11-20 17:48:34 +00:00
42 lines
2.0 KiB
Markdown
42 lines
2.0 KiB
Markdown
---
|
|
title: SSH credentials
|
|
description: Documentation for SSH credentials. Use these credentials to authenticate SSH in n8n, a workflow automation platform.
|
|
contentType: integration
|
|
---
|
|
|
|
# SSH credentials
|
|
|
|
You can use these credentials to authenticate the following nodes:
|
|
|
|
- [SSH](/integrations/builtin/core-nodes/n8n-nodes-base.ssh/)
|
|
|
|
## Prerequisites
|
|
|
|
Authentication for the SSH node requires that you have a username and password for connecting to the remote server, or an SSH key configured for the server or service you are connecting to.
|
|
See [Connecting to GitHub with SSH](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) for an example.
|
|
|
|
## Using Password
|
|
|
|
1. From the SSH Credentials dropdown, select ***Create New*** and complete the following fields:
|
|
- ***Credentials Name***: Enter a descriptive name, here we used `ssh_demo`.
|
|
- ***Host***: Enter the IP address of the server you are connecting to. Here we're using `192.168.1.8` for a local Mac set up for SSH access.
|
|
- ***Port***: Enter the port to use for this connection. SSH used port 22 by default.
|
|
- ***User***: Enter the your username for this server.
|
|
- ***Password***: Enter your password for the provided username.
|
|
2. Click ***Save*** to make these credentials available for use.
|
|
|
|
|
|
|
|
## Using Private Key
|
|
|
|
1. With ***Private Key*** selected in the ***Authentication*** field, from the SSH Credentials dropdown select ***Create New***.
|
|
2. Complete the following fields:
|
|
- ***Credentials Name***: Enter a descriptive name, here we used `ssh_demo`.
|
|
- ***Host***: Enter the IP address of the server you are connecting to.
|
|
- ***Port***: Enter the port to use for this connection. SSH used port 22 by default.
|
|
- ***Private Key***: Enter your SSH private key.
|
|
- ***Passphrase***: Enter your passphrase used to secure this key.
|
|
|
|
|
|
|