From ea6b0184ccc7487eb71052a50b9028c123230f03 Mon Sep 17 00:00:00 2001 From: freakwriter Date: Mon, 17 Jun 2024 17:07:41 -0400 Subject: [PATCH] Update AMQP, Filemaker Pro, FTP, and LinkedIn credential. Still not convinced LinkedIn is detailed enough, will check with Jon --- docs/integrations/builtin/credentials/amqp.md | 27 +++++++-- .../builtin/credentials/filemaker.md | 24 ++++++-- docs/integrations/builtin/credentials/ftp.md | 32 ++++++++-- .../builtin/credentials/linkedin.md | 58 ++++++++++++++----- 4 files changed, 111 insertions(+), 30 deletions(-) diff --git a/docs/integrations/builtin/credentials/amqp.md b/docs/integrations/builtin/credentials/amqp.md index a19fc656d7a..622ddf082f5 100644 --- a/docs/integrations/builtin/credentials/amqp.md +++ b/docs/integrations/builtin/credentials/amqp.md @@ -6,18 +6,35 @@ contentType: integration # AMQP credentials -You can use these credentials to authenticate the following nodes with AMQP. +You can use these credentials to authenticate the following nodes: - [AMQP Sender](/integrations/builtin/app-nodes/n8n-nodes-base.amqp/) - [AMQP Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.amqptrigger/) ## Prerequisites -You need to have a AMQP 1.0 compatible message broker installed. +Install an AMQP 1.0-compatible message broker like [ActiveMQ](https://activemq.apache.org/){:target=_blank .external-link}. Refer to [AMQP Products](https://www.amqp.org/about/examples){:target=_blank .external-link} for a list of options. -## Using ActiveMQ connection +## Supported authentication methods -Use your Hostname, Port, User, and Password as the AMQP Sender credential data in n8n. +- AMQP connection -**Note:** The default username for ActiveMQ is `admin` and the default password is `admin`. +## Related resources +Advanced Message Queuing Protocol (AMQP) is an open standard application layer protocol for message-oriented middleware. The defining features of AMQP are message orientation, queuing, routing, reliability and security. Refer to the [OASIS AMQP Version 1.0 Standard](http://docs.oasis-open.org/amqp/core/v1.0/amqp-core-overview-v1.0.html){:target=_blank .external-link} for more information. + +Refer to your provider's documentation for more information about the service. Refer to [ActiveMQ's API documentation](https://activemq.apache.org/components/classic/documentation/rest){:target=_blank .external-link} as one example. + +## Using AMQP connection + +To configure this credential, you'll need: + +- A **Hostname**: Enter the hostname of your AMQP message broker. +- A **Port**: Enter the port number the connection should use. +- A **User**: Enter the name of the user to establish the connection as. + - For example, the default username in ActiveMQ is `admin`. +- A **Password**: Enter the user's password. + - For example, the default password in ActiveMQ is `admin`. +- _Optional:_ **Transport Type**: Enter either `tcp` or `tls`. + +Refer to your provider's documentation for more detailed instructions. diff --git a/docs/integrations/builtin/credentials/filemaker.md b/docs/integrations/builtin/credentials/filemaker.md index 5d48cfc9dc9..c7522969105 100644 --- a/docs/integrations/builtin/credentials/filemaker.md +++ b/docs/integrations/builtin/credentials/filemaker.md @@ -6,17 +6,29 @@ contentType: integration # FileMaker credentials -You can use these credentials to authenticate the following nodes with FileMaker. +You can use these credentials to authenticate the following nodes: - [FileMaker](/integrations/builtin/app-nodes/n8n-nodes-base.filemaker/) ## Prerequisites -Create an user account on a FileMaker server. +- Create a user account on a [FileMaker Server](https://www.claris.com/filemaker/){:target=_blank .external-link} with the `fmrest` extended privilege to [Access via FileMaker Data API](https://help.claris.com/en/data-api-guide/content/enable-access.html){:target=_blank .external-link}. +- Ensure the FileMaker Server can use the [FileMaker Data API](https://help.claris.com/en/data-api-guide/content/index.html){:target=_blank .external-link}. -## Using Database Connection +## Supported authentication methods -1. Retrieve your FileMaker credentials and connection parameters. -2. Use the credentials and connection parameters with your FileMaker node credentials in n8n. -3. Click on the ***Save*** button to save your credentials. +- Database connection + +## Related resources + +Refer to [Filemaker's Data API Guide](https://help.claris.com/en/data-api-guide/content/index.html){:target=_blank .external-link} for more information about the service. + +## Using database connection + +To configure this credential, you'll need: + +- A **Host**: The IP address or host name of your FileMaker Server. +- A **Database**: The database name as it appears in the **Databases** list within Filemaker. +- The **Login** for the account with the `fmrest` extended privilege. +- The **Password** for the account with the `fmrest` extended privilege. diff --git a/docs/integrations/builtin/credentials/ftp.md b/docs/integrations/builtin/credentials/ftp.md index 98401d83c91..7c30fad68db 100644 --- a/docs/integrations/builtin/credentials/ftp.md +++ b/docs/integrations/builtin/credentials/ftp.md @@ -12,17 +12,37 @@ You can use these credentials to authenticate the following nodes: ## Prerequisites -Create an account on an FTP server. +Create an account on a File Transfer Protocol (FTP) server. ## Supported authentication methods -- FTP account +- FTP account: Use this method if your FTP server doesn't support SSH tunneling or encrypted connections. +- SFTP account: Use this method if your FTP server supports SSH tunneling and encrypted connections. + +## Related resources + +File Transfer Protocol (FTP) and Secure Shell File Transfer Protocol (SFTP) are protocols for transferring files directly between an FTP/SFTP client and server. ## Using FTP account To configure this credential, you'll need: -- The FTP **Host** -- The FTP **Port** -- FTP **Username** -- FTP **Password** +- A **Host**: Enter the name or IP address of your FTP server's host. +- A **Port**: Enter the port number the connection should use. +- A **Username**: Enter the name of the user the connection should use. +- A **Password**: Enter the user's password. + +Review your FTP server provider's documentation for instructions on getting the information you need. + +## Using SFTP account + +To configure this credential, you'll need: + +- A **Host**: Enter the name or IP address of your FTP server's host. +- A **Port**: Enter the port number the connection should use. +- A **Username**: Enter the name of the user the connection should use. +- A **Password**: Enter the user's password. +- A **Private Key**: Enter a string for either key-based or host-based user authentication (OpenSSH format). +- A **Passphrase**: If the **Private Key** is encrypted, enter the passphrase used to decrypt it. + +Review your FTP server provider's documentation for instructions on getting the information you need. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/linkedin.md b/docs/integrations/builtin/credentials/linkedin.md index f6f3143d431..544b7f83641 100644 --- a/docs/integrations/builtin/credentials/linkedin.md +++ b/docs/integrations/builtin/credentials/linkedin.md @@ -6,29 +6,61 @@ contentType: integration # LinkedIn credentials -You can use these credentials to authenticate the following nodes with LinkedIn. +You can use these credentials to authenticate the following nodes: - [LinkedIn](/integrations/builtin/app-nodes/n8n-nodes-base.linkedin/) ## Prerequisites -* A [LinkedIn](https://www.linkedin.com/){:target=_blank .external-link} account. -* A LinkedIn Company Page. +* Create a [LinkedIn](https://www.linkedin.com/){:target=_blank .external-link} account. +* Create a LinkedIn [Company Page](https://www.linkedin.com/help/linkedin/answer/a543852){:target=_blank .external-link}. -## Using OAuth +## Supported authentication methods -/// note | Note for n8n Cloud users -You can skip this setup. Enter the **Credentials Name** and select **Connect my account** to connect your LinkedIn account to n8n. -/// -This section provides outline steps for setting up OAuth with LinkedIn. Refer to [LinkedIn's documentation](https://learn.microsoft.com/en-gb/linkedin/){:target=_blank .external-link} for detailed information. +- Community Management OAuth2: Use with the Community Management product. +- OAuth2: Use with or without the Community Management product. + +## Related Resources + +Refer to [LinkedIn's Community Management API documentation](https://learn.microsoft.com/en-us/linkedin/marketing/community-management/community-management-overview?view=li-lms-2024-04){:target=_blank .external-link} for more information about the service. + +This credential works with API version `202404`. -To enable OAuth, you need to: +## Using Community Management OAuth2 -1. Create a [new app](https://www.linkedin.com/developers/apps/new){:target=_blank .external-link}. - * Provide a LinkedIn Company Page for **LinkedIn Page**. Refer to [Associate an App with a LinkedIn Page](https://www.linkedin.com/help/linkedin/answer/a548360){:target=_blank .external-link} for more guidance. -2. Enable APIs for your app. You need to enable **Share on LinkedIn** and **Sign In with LinkedIn**. +To configure this credential, you'll need: + +- A **Client ID**: Generated after you create a new developer app. +- A **Client Secret**: Generated after you create a new developer app. + +To enable OAuth, you need to create a [new developer app](https://www.linkedin.com/developers/apps/new){:target=_blank .external-link}. + +Use these settings for your app: +- Enter a LinkedIn Company Page for **LinkedIn Page**. Refer to [Associate an App with a LinkedIn Page](https://www.linkedin.com/help/linkedin/answer/a548360){:target=_blank .external-link} for more guidance. +- Enable APIs for your app, including: + - **Share on LinkedIn** + - **Sign In with LinkedIn using OpenID Connect** /// note | Posting from organization accounts To post as an organization, you need to put your app through LinkedIn's [Community Management App Review](https://learn.microsoft.com/en-us/linkedin/marketing/community-management-app-review){:target=_blank .external-link} process. -/// \ No newline at end of file +/// + +## Using OAuth2 + +--8<-- "_snippets/integrations/builtin/credentials/cloud-oauth-button.md" + +All users must select: + +- **Organization Support**: If turned on, the credential requests permission to post as an organization using the `w_organization_social` scope. + - To use this option, you must put your app through LinkedIn's [Community Management App Review](https://learn.microsoft.com/en-us/linkedin/marketing/community-management-app-review){:target=_blank .external-link} process. +- **Legacy**: If turned on, the credential uses legacy scopes for `r_liteprofile` and `r_emailaddress` instead of the newer `profile` and `email` scopes. + +If you need to configure OAuth2 from scratch, create a [new developer app](https://www.linkedin.com/developers/apps/new){:target=_blank .external-link}. + +Use these settings for your app: + +- Enter a LinkedIn Company Page for **LinkedIn Page**. Refer to [Associate an App with a LinkedIn Page](https://www.linkedin.com/help/linkedin/answer/a548360){:target=_blank .external-link} for more guidance. +- Enable APIs for your app, including: + - **Share on LinkedIn** + - **Sign In with LinkedIn using OpenID Connect**