add action

This commit is contained in:
Deborah Barnard 2024-01-08 11:39:47 +00:00
parent 88f970e2da
commit a5b1280565
29 changed files with 52 additions and 34 deletions

12
.github/workflows/lint.yml vendored Normal file
View File

@ -0,0 +1,12 @@
name: Run Vale
on: [pull_request]
jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: errata-ai/vale-action@reviewdog
with:
files: '["docs", "_snippets"]'

View File

@ -4,5 +4,4 @@ Vocab = default
[*.md]
BasedOnStyles = alex, write-good, Microsoft, n8n-styles, Vale
alex.Profanity = NO
BlockIgnores = (\**Release date:\**.*)
TokenIgnores = (\-\-8\<\-\- \".*\")
TokenIgnores = (\-\-8\<\-\- \".*\"), (-only), (\*\*.*\*\*), (\**Release date:\**.*)

View File

@ -2,10 +2,11 @@
Vector Store nodes in n8n have three modes: **Get Many**, **Insert Documents** and **Retrieve Documents**. The mode you select determines the operations you can perform with the node and what inputs and outputs are available.
<!-- vale off -->
#### Get Many
In this mode, you can retrieve multiple documents from your vector database by providing a prompt. The prompt will be embedded and used for similarity search. The node will return the documents that are most similar to the prompt with their similarity score. This is useful if you want to retrieve a list of similar documents and pass them to a chain as additional context.
<!-- vale on -->
#### Insert Documents
Use insert documents mode to insert new documents into your vector database.

View File

@ -49,7 +49,7 @@ The syntax to use the built-in methods and variables is `$variableName` or `$met
n8n added Python support in version 1.0. It doesn't include a Python executable. Instead, n8n provides Python support using [Pyodide](https://pyodide.org/en/stable/){:target=_blank .external-link}, which is a port of CPython to WebAssembly. This limits the available Python packages to the [Packages included with Pyodide](https://pyodide.org/en/stable/usage/packages-in-pyodide.html#packages-in-pyodide){:target=_blank .external-link}. n8n downloads the package automatically the first time you use it.
/// note | Slower than JavaScript
The Code node takes longer to process Python than JavaScript. This is due to the additional compilation steps.
The Code node takes longer to process Python than JavaScript. This is due to the extra compilation steps.
///
### Built-in methods and variables

View File

@ -1,7 +1,8 @@
1. Access your [Google Cloud Console - Library](https://console.cloud.google.com/apis/library){:target=_blank .external-link}. Make sure you're in the correct project.
1. Search for and select the API(s) you want to enable. For example, for the Gmail node, search for and enable the Gmail API.
<!-- vale off -->
/// note | Some integrations need additional APIs
<!-- vale on -->
The following integrations require the Google Drive API, as well as their own API:
* Google Docs

View File

@ -1 +1 @@
If you self-host n8n, you are responsible for deleting user data. If you need to delete data on behalf of one of your users, you can delete the respective execution. n8n recommends configuring n8n to prune execution data automatically after few days to avoid effortful GDPR request handling as much as possible. Configure this using the `EXECUTIONS_DATA_MAX_AGE` environment variable. Refer to [Environment variables](/hosting/environment-variables/environment-variables/) for more information.
If you self-host n8n, you are responsible for deleting user data. If you need to delete data on behalf of one of your users, you can delete the respective execution. n8n recommends configuring n8n to prune execution data automatically every few days to avoid effortful GDPR request handling as much as possible. Configure this using the `EXECUTIONS_DATA_MAX_AGE` environment variable. Refer to [Environment variables](/hosting/environment-variables/environment-variables/) for more information.

View File

@ -1,7 +1,7 @@
## n8n with tunnel
/// danger
This is only meant for local development and testing. Do not use it in production.
Use this for local development and testing. It isn't safe to use it in production.
///
To be able to use webhooks for trigger nodes of external services like GitHub, n8n has to be reachable from the web. To make that easy, n8n has a special [tunnel service](https://github.com/localtunnel/localtunnel) which redirects requests from our servers to your local n8n instance.
To be able to use webhooks for trigger nodes of external services like GitHub, n8n has to be reachable from the web. n8n has a [tunnel service](https://github.com/localtunnel/localtunnel) which redirects requests from n8n's servers to your local n8n instance.

View File

@ -2,5 +2,5 @@ The advantage of this pattern is that work is instantly available to other envir
The disadvantages are:
* If you push by mistake, there is a risk the work will make it into your production instance. If you [use a GitHub Action to automate pulls](#optional-use-a-github-action-to-automate-pulls) to production, you must either use the multi-instance, multi-branch pattern, or be very careful to never push work that you don't want in production.
* If you push by mistake, there is a risk the work will make it into your production instance. If you [use a GitHub Action to automate pulls](#optional-use-a-github-action-to-automate-pulls) to production, you must either use the multi-instance, multi-branch pattern, or be careful to never push work that you don't want in production.
* Pushing and pulling to the same instance can cause data loss as changes are overridden when performing these actions. You should set up processes to ensure content flows in one direction.

View File

@ -87,7 +87,7 @@ It's easy to get started contributing code to n8n [here](https://github.com/n8n-
n8n was until 17 March 2022 licensed under Apache 2.0 with Commons Clause. Commons Clause was initiated by various software companies wanting to protect their rights against cloud providers. The concept involved adding a commercial restriction on top of an existing open source license.
However, the use of the Commons Clause as an additional condition to an open source license, as well as the use of wording that is open to interpretation, created some confusion and uncertainty regarding the terms of use. The Commons Clause also restricted people's ability to offer consulting and support services: we realized these services are critical in enabling people to get value from n8n, so we wanted to remove this restriction.
However, the use of the Commons Clause as an additional condition to an open source license, as well as the use of wording that's open to interpretation, created some confusion and uncertainty regarding the terms of use. The Commons Clause also restricted people's ability to offer consulting and support services: we realized these services are critical in enabling people to get value from n8n, so we wanted to remove this restriction.
We created the Sustainable Use License to be more permissive and more clear about what use is allowed, while continuing to ensure n8n gets the funding needed to build and improve our product.

View File

@ -10,7 +10,7 @@ Some of the things that Nathan does are very repetitive and mind-numbing. He wan
## Understanding the scenario
**You 👩‍🔧:** Nice to meet you, Nathan. Glad to be doing this! What's a repetitive task that is error-prone and that you'd like to get off your plate first?
**You 👩‍🔧:** Nice to meet you, Nathan. Glad to be doing this! What's a repetitive task that's error-prone and that you'd like to get off your plate first?
**Nathan 🙋:** Thanks for coming in! The most annoying one's gotta be the weekly sales reporting.

View File

@ -21,7 +21,7 @@ The **Code node** has two operational *Modes* that change the way it processes d
- Use the Code node.
- Get the most out of n8n.
In n8n, the data that is passed between nodes is an array of objects with the following structure:
In n8n, the data that's passed between nodes is an array of objects with the following structure:
```json
[

View File

@ -268,7 +268,7 @@ Build a workflow that adds five days to an input date. Then, if the calculated d
## Binary data
So far, you have mainly worked with text data. But what if you want to process data that is not text? For example, images or PDF files. This is binary data, as it's represented in the binary numeral system. In this form, binary data doesn't offer you useful information, so it needs to be converted into a readable form.
So far, you have mainly worked with text data. But what if you want to process data that's not text? For example, images or PDF files. This is binary data, as it's represented in the binary numeral system. In this form, binary data doesn't offer you useful information, so it needs to be converted into a readable form.
In n8n, you can process binary data with the following nodes:

View File

@ -18,7 +18,7 @@ From the terminal, run:
npx n8n
```
This command will download everything that is needed to start n8n. You can then access n8n and start building workflows by opening [http://localhost:5678](http://localhost:5678){:target=_blank .external-link}.
This command will download everything that's needed to start n8n. You can then access n8n and start building workflows by opening [http://localhost:5678](http://localhost:5678){:target=_blank .external-link}.
## Install globally with npm

View File

@ -160,7 +160,7 @@ SSL_EMAIL=user@example.com
### 7. Create data folder
Create the Docker volume that is defined as `n8n_data`. n8n will save the database file from SQLite and the encryption key in this volume.
Create the Docker volume that's defined as `n8n_data`. n8n will save the database file from SQLite and the encryption key in this volume.
```sh
sudo docker volume create n8n_data

View File

@ -53,6 +53,6 @@ The start node exists by default when you create a new workflow.
2. Open the project that contains the job you want to use with n8n.
3. In the sidebar, click on 'JOBS'.
4. Under 'All Jobs', click on the name of the job you want to use with n8n.
5. In the top left corner, under the name of the job, copy the string that is displayed in smaller font below the job name. This is your job ID.
5. In the top left corner, under the name of the job, copy the string that's displayed in smaller font below the job name. This is your job ID.
6. Paste this job ID in the `Job Id` field in n8n.

View File

@ -26,7 +26,7 @@ The Execute Command node has two properties:
## Example Usage
This workflow allows you to execute a command that returns the percentage of the hard disk that is full using the Execute Command node. The workflow triggers twice a day, and if the memory usage exceeds 80%, it sends an SMS using the Twilio node. You can also find the [workflow](https://n8n.io/workflows/716) on n8n.io. This example usage workflow would use the following nodes.
This workflow allows you to execute a command that returns the percentage of the hard disk that's full using the Execute Command node. The workflow triggers twice a day, and if the memory usage exceeds 80%, it sends an SMS using the Twilio node. You can also find the [workflow](https://n8n.io/workflows/716) on n8n.io. This example usage workflow would use the following nodes.
- [Schedule trigger](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/)
- [Execute Command]()
@ -59,7 +59,7 @@ The Execute Command node executes the command and return the percentage of hard
1. Enter `df -k / | tail -1 | awk '{print $5}'` in the **Command** field.
2. Click on **Execute Node** to run the node.
In the screenshot below, note that the node executes the command and returns the percentage of the hard disk that is full.
In the screenshot below, note that the node executes the command and returns the percentage of the hard disk that's full.
![Using the Execute Command node to get the percentage of hard disk used on the host machine](/_images/integrations/builtin/core-nodes/executecommand/executecommand_node.png)

View File

@ -26,8 +26,8 @@ The XML node is useful to convert data from and to XML.
- ***Normalize:*** Trim whitespaces inside the text nodes. This field is displayed when 'XML to JSON' is selected from the ***Mode*** dropdown list.
- ***Normalize Tags:*** Normalize all tag names to lowercase. This field is displayed when 'XML to JSON' is selected from the ***Mode*** dropdown list.
- ***Trim:*** Trim the whitespace at the beginning and end of text nodes. This field is displayed when 'XML to JSON' is selected from the ***Mode*** dropdown list.
- ***Attribute Key:*** Prefix that is used to access the attributes.
- ***Character Key:*** Prefix that is used to access the character content.
- ***Attribute Key:*** Prefix that's used to access the attributes.
- ***Character Key:*** Prefix that's used to access the character content.
## Example Usage

View File

@ -39,7 +39,7 @@ You'll only need to enter the Credentials Name and click on the circle button in
1. Open your Acuity Scheduling dashboard.
2. Click on 'Integrations' in the left sidebar.
3. Scroll down and click on 'view credentials' under the API section.
4. Copy the ***User ID*** and ***API Key*** from the pop-up that is displayed.
4. Copy the ***User ID*** and ***API Key*** from the pop-up that's displayed.
5. Use these credentials with your Acuity Scheduling node credentials in n8n.
![Getting Acuity Scheduling credentials](/_images/integrations/builtin/credentials/acuityscheduling/using-access-token.gif)

View File

@ -18,7 +18,7 @@ Create an [E-goi](https://www.e-goi.com/) account.
1. Access your E-goi dashboard.
2. Click on your name on the top right corner and select 'Integrations'.
3. Copy the ***API key*** that is displayed and use it with your E-goi node credentials in n8n.
3. Copy the ***API key*** that's displayed and use it with your E-goi node credentials in n8n.
![Getting E-goi API credentials](/_images/integrations/builtin/credentials/egoi/using-api.gif)

View File

@ -26,7 +26,7 @@ You'll only need to enter the Credentials Name and click on the circle button in
4. Click on Developer links > API keys in the sidebar.
5. Click on the *Create API Key* button.
6. Copy the 'OAuth Callback URL' provided in the Eventbrite OAuth API credentials in n8n and paste it in the 'OAuth Redirect URI' field in the Eventbrite API creation page.
7. Fill out any other information that is necessary and click 'Create Key'.
7. Fill out any other information that's necessary and click 'Create Key'.
8. Find your API key in the 'API Keys' page and click on 'Show API key, client secret and tokens'.
9. Click on 'Show API key, client secret and tokens' and use the 'API key' and the 'Client secret' with your Eventbrite OAuth API credentials in n8n.
10. Click on the circle button in the OAuth section to connect an Eventbrite account to n8n.

View File

@ -27,7 +27,7 @@ You'll only need to enter the Credentials Name and click on the circle button in
4. Click on 'My Apps' in the sidebar.
5. Click on the *Create My App* button.
6. Copy the 'OAuth Callback URL' provided in the HelpScout OAuth2 API credentials in n8n and paste it in the 'Redirection URL' field in Help Scout.
7. Fill out any other information that is necessary and click 'Create'.
7. Fill out any other information that's necessary and click 'Create'.
8. Click on the *Save* button and use the 'App ID' and the 'App Secret' with your HelpScout OAuth2 API credentials in n8n.
9. Click on the circle button in the OAuth section to connect a Help Scout account to n8n.
10. Click the *Save* button to save your credentials.

View File

@ -21,7 +21,7 @@ Create a [MailerLite](https://MailerLite.com) account.
2. Click on the profile icon on the top right corner.
3. Select 'Integrations' from the dropdown list.
4. Click on 'Developer API' in the ***MailerLite API*** section.
5. Copy the ***API key*** that is displayed and use it with your MailerLite node credentials in n8n.
5. Copy the ***API key*** that's displayed and use it with your MailerLite node credentials in n8n.
![Getting MailerLite credentials](/_images/integrations/builtin/credentials/mailerlite/using-api-key.gif)

View File

@ -21,7 +21,7 @@ From Monica CRM:
1. Access your dashboard and navigate to the ***Settings** menu.
2. From the ***API*** tab select **Create New Token**.
3. Enter a name for your new token and click **Create**.
4. Copy the access token that is displayed in the popup window.
4. Copy the access token that's displayed in the popup window.
From n8n:

View File

@ -21,7 +21,7 @@ Create a [Nextcloud](https://nextcloud.com/) account.
3. Select 'Settings' in the drop down menu.
4. Click on 'Security' under Administration in the sidebar.
5. Copy the 'OAuth Callback URL' provided in the Nextcloud OAuth2 API credentials in n8n and paste it in the *Redirection URI* field under the 'OAuth 2.0 clients' section in the Nextcloud page.
6. Fill out any other information that is necessary and click on the 'Add' button.
6. Fill out any other information that's necessary and click on the 'Add' button.
7. Click on the eye icon to reveal the Secret and use the 'Client Identifier' and the 'Secret' with your Nextcloud OAuth2 API credentials in n8n.
8. Replace your domain in the samples for the *Authorization URL* and *Access Token URL* fields.
9. Enter your [Web DAV URL](https://docs.nextcloud.com/server/stable/user_manual/en/files/access_webdav.html) in the *Web DAV URL* field.

View File

@ -6,7 +6,7 @@ contentType: integration
# Calendly trigger
[Calendly](https://calendly.com/) is an automated scheduling software that is designed to make the process of finding meeting times easy.
[Calendly](https://calendly.com/) is an automated scheduling software that's designed to make the process of finding meeting times easy.
/// note | Credentials
You can find authentication information for this node [here](/integrations/builtin/credentials/calendly/).

View File

@ -16,9 +16,9 @@ You can find authentication information for this node [here](/integrations/built
- `*`: All updates
- ***message***: Trigger on a new incoming message of any kind- text, photo, sticker, etc
- ***edited_message***: Trigger on a new version of a channel post that is known to the bot and was edited
- ***edited_message***: Trigger on a new version of a channel post that's known to the bot and was edited
- ***channel_post***: Trigger on a new incoming channel post of any kind - text, photo, sticker, etc
- ***edited_channel_post***: Trigger on a new version of a channel post that is known to the bot and was edited
- ***edited_channel_post***: Trigger on a new version of a channel post that's known to the bot and was edited
- ***inline_query***: Trigger on a new incoming inline query
- ***callback_query***: Trigger on a new incoming callback query
- ***shipping_query***: Trigger on a new incoming shipping query. Only for invoices with flexible price

View File

@ -41,7 +41,7 @@ Since n8n's repository already has a Autopilot Trigger node, we will name this n
3. Within the Autofriend folder, create a file called `AutofriendTrigger.node.ts` (YourNodeNameTrigger.node.ts).
4. Download and add the Autofriend [icon](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/Autopilot/autopilot.svg) to the folder. Name it `autopilot.svg`.
- The icon property has to be either a 60x60 pixels PNG or an SVG and must exist in the node's folder.
- An SVG is preferable. In case you have to use a PNG, make sure that it's compressed. A good tool for that is [tinypng](https://tinypng.com).
- An SVG is preferable. In case you have to use a PNG, make sure that it's compressed. A good tool for that's [tinypng](https://tinypng.com).
- A good place to find company icons is [gilbarbara/logos](https://github.com/gilbarbara/logos/tree/master/logos).
5. Paste the following code in the `AutofriendTrigger.node.ts` file.
@ -218,7 +218,7 @@ The node should now look like in the following image.
Most REST APIs use some sort of authentication mechanism. Autofriend's REST API uses API Keys. The API Key informs them about who is making the request to their system and gives you access to all the functionality that the API provides. Given all the things it can do, this has to be treated as a sensitive piece of information and should be kept private.
n8n gives you the ability to ask for sensitive information using credentials. In the credentials, you can use all the generally available UI elements. Additionally, the data that is stored using the credentials would be encrypted before being saved to the database. In order to do that, n8n uses an encryption key.
n8n gives you the ability to ask for sensitive information using credentials. In the credentials, you can use all the generally available UI elements. Additionally, the data that's stored using the credentials would be encrypted before being saved to the database. In order to do that, n8n uses an encryption key.
With that in mind, let's create the UI to ask for the user's Autofriend API Key. The process of creating and registering credentials is similar to that of creating and registering the node:

View File

@ -13,7 +13,7 @@ This page contains advice on best practices relating to user management in n8n.
* Users must be careful not to edit the same workflow simultaneously. It's possible to do it, but the users will overwrite each other's changes.
* To move workflows between accounts, export the workflow as JSON, then import it to the new account. Note that this action loses the workflow history.
* Webhook paths must be unique across the entire instance. This means each webhook path must be unique for all workflows and all users. By default, n8n generates a long random value for the webhook path, but users can edit this to their own custom path. If two users set the same path value:
* The path works for the first workflow that is run or activated.
* The path works for the first workflow that's run or activated.
* Other workflows will error if they try to run with the same path.
## Self-hosted

View File

@ -10,13 +10,15 @@ Automizy
Axios
Backblaze
backend
bcrypt
Beeminder
Bitly
Bitwarden
Boolean
boolean
Brandfetch
bcrypt
Burstable
burstable
Caddy
Citrix
Clearbit
@ -64,6 +66,8 @@ Meraki
Metabase
Middleware
middleware
Millicore
millicore
Mindee
n8n
namespace
@ -89,6 +93,7 @@ Prefilled
prefilled
Pushbullet
Pushcut
Pyodide
Qdrant
Qualys
Realtime