diff --git a/docs/_images/integrations/builtin/credentials/spotify/dashboard.gif b/docs/_images/integrations/builtin/credentials/spotify/dashboard.gif deleted file mode 100644 index 18954f466..000000000 Binary files a/docs/_images/integrations/builtin/credentials/spotify/dashboard.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/ssh/private_key_credential.png b/docs/_images/integrations/builtin/credentials/ssh/private_key_credential.png deleted file mode 100644 index f958edcef..000000000 Binary files a/docs/_images/integrations/builtin/credentials/ssh/private_key_credential.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/ssh/ssh_credentials.png b/docs/_images/integrations/builtin/credentials/ssh/ssh_credentials.png deleted file mode 100644 index 49ef7dd86..000000000 Binary files a/docs/_images/integrations/builtin/credentials/ssh/ssh_credentials.png and /dev/null differ diff --git a/docs/integrations/builtin/credentials/snowflake.md b/docs/integrations/builtin/credentials/snowflake.md index 8dbe25a25..14061b526 100644 --- a/docs/integrations/builtin/credentials/snowflake.md +++ b/docs/integrations/builtin/credentials/snowflake.md @@ -32,7 +32,7 @@ To configure this credential, you'll need: - A **Username** - A **Password** - A **Schema**: Enter the [schema](https://docs.snowflake.com/en/sql-reference/sql/use-schema){:target=_blank .external-link} you want to use after connecting. -- A **Role**: Enter the security [role you](https://docs.snowflake.com/en/sql-reference/sql/use-role){:target=_blank .external-link} want to use after connecting. -- **Client Session Keep Alive**: By default, client connections typically time out three or four hours after the most recent query execution. Turning this setting on sets the `clientSessionKeepAlive` parameter to true and the server will keep the client’s connection to the server alive indefinitely, even if the connection doesn't execute any queries. +- A **Role**: Enter the security [role](https://docs.snowflake.com/en/sql-reference/sql/use-role){:target=_blank .external-link} you want to use after connecting. +- **Client Session Keep Alive**: By default, client connections typically time out three or four hours after the most recent query execution. Turning this setting on sets the `clientSessionKeepAlive` parameter to true: the server will keep the client's connection alive indefinitely, even if the connection doesn't execute any queries. Refer to [Session Commands](https://docs.snowflake.com/en/sql-reference/commands-session){:target=_blank .external-link} for more information on these settings. diff --git a/docs/integrations/builtin/credentials/splunk.md b/docs/integrations/builtin/credentials/splunk.md index a0e1d704b..144b39b34 100644 --- a/docs/integrations/builtin/credentials/splunk.md +++ b/docs/integrations/builtin/credentials/splunk.md @@ -28,7 +28,7 @@ Refer to [Splunk's Enterprise API documentation](https://docs.splunk.com/Documen To configure this credential, you'll need: - An **Auth Token**: Once you've enabled token authentication, create an auth token in **Settings > Tokens**. Refer to [Creating authentication tokens](https://docs.splunk.com/Documentation/Splunk/9.2.1/Security/CreateAuthTokens){:target=_blank .external-link} for more information. -- A **Base URL**: For your Splunk instance. This should include the protocol, domain, and port. For example: `https://localhost:8089`. +- A **Base URL**: For your Splunk instance. This should include the protocol, domain, and port, for example: `https://localhost:8089`. - **Allow Self-Signed Certificates**: If turned on, n8n will connect even if SSL validation fails. ## Required capabilities diff --git a/docs/integrations/builtin/credentials/spotify.md b/docs/integrations/builtin/credentials/spotify.md index f6d5a2614..52fed586e 100644 --- a/docs/integrations/builtin/credentials/spotify.md +++ b/docs/integrations/builtin/credentials/spotify.md @@ -6,25 +6,31 @@ contentType: integration # Spotify credentials -You can use these credentials to authenticate the following nodes with Spotify. +You can use these credentials to authenticate the following nodes: - [Spotify](/integrations/builtin/app-nodes/n8n-nodes-base.spotify/) ## Prerequisites -Create a [Spotify Developer](https://developer.spotify.com/dashboard/login) account. +Create a [Spotify Developer](https://developer.spotify.com/){:target=_blank .external-link} account. -## Using OAuth +## Supported authentication methods -/// note | Note for n8n Cloud users -You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Spotify account to n8n. -/// +- OAuth2 -1. Access your [Spotify for Developers](https://developer.spotify.com/dashboard/login) dashboard. -2. Click the *Create an App* button at the top of your dashboard. Enter in the app's name and description and click *Create*. -3. Use provided Client Secret and Client ID with your Spotify node credentials in n8n. -4. Open the app settings and add the n8n provided redirect URL to the app's redirect URI list. Redirect URL Explanation [here](/). +## Related resources -![The Spotify App Dashboard](/_images/integrations/builtin/credentials/spotify/dashboard.gif) +Refer to [Spotify's Web API documentation](https://developer.spotify.com/documentation/web-api){:target=_blank .external-link} for more information about the service. + +## Using OAuth2 + +--8<-- "_snippets/integrations/builtin/credentials/cloud-oauth-button.md" + +If you need to configure OAuth2 from scratch, [create a Spotify app](https://developer.spotify.com/documentation/web-api/concepts/apps){:target=_blank .external-link}. + +Use these settings for your app: + +- Copy the **OAuth Redirect URL** from n8n and use this as the app's **Redirect URI**. +- Copy the **Client ID** and **Client Secret** from your app and add them to n8n. diff --git a/docs/integrations/builtin/credentials/ssh.md b/docs/integrations/builtin/credentials/ssh.md index dea1b9097..33a3c4e04 100644 --- a/docs/integrations/builtin/credentials/ssh.md +++ b/docs/integrations/builtin/credentials/ssh.md @@ -12,30 +12,37 @@ You can use these credentials to authenticate the following nodes: ## 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. +- Create a remote server with SSH enabled. +- Create one of the following: + - A user account that can `ssh` into server: Use with [password authentication](#using-password). + - An SSH key for the server or service: Use with [private key authentication](#using-private-key). -## Using Password +## Supported authentication methods -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. +- Password +- Private key -![SSH Password credentials](/_images/integrations/builtin/credentials/ssh/ssh_credentials.png) +## Related resources -## Using Private Key +Secure Shell (SSH) protocol is a method for securely sending commands over a network. Refer to [Connecting to GitHub with SSH](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) for an example of SSH setup. -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. -![SSH Private Key credentials](/_images/integrations/builtin/credentials/ssh/private_key_credential.png) +## 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.