mirror of
https://github.com/n8n-io/n8n-docs.git
synced 2025-11-20 17:48:34 +00:00
Merge branch 'main' into 1.11.0-release-notes
This commit is contained in:
Deborah Barnard
commit
2049705bbd
@ -2,4 +2,4 @@
|
||||
n8n releases a new minor version most weeks. The `latest` version is for production use. `next` is the most recent release. You should treat `next` as a beta: it may be unstable. To report issues, use the [forum](https://community.n8n.io/c/questions/12){:target=_blank .external-link}.
|
||||
|
||||
Current `latest`: 1.9.3
|
||||
Current `next`: 1.10.0
|
||||
Current `next`: 1.10.1
|
||||
|
||||
@ -99,11 +99,13 @@ Enabling overwrites for credentials allows you to set default values for credent
|
||||
|
||||
## Binary data
|
||||
|
||||
By default, n8n uses memory to store binary data. Enterprise users can choose to use an external service instead. Refer to [External storage](/hosting/external-storage/) for more information on using external storage for binary data.
|
||||
|
||||
| Variable | Type | Default | Description |
|
||||
| :------- | :---- | :------- | :---------- |
|
||||
| `N8N_AVAILABLE_BINARY_DATA_MODES` | String | `filesystem` | A comma separated list of available binary data modes. |
|
||||
| `N8N_BINARY_DATA_STORAGE_PATH` | String | `N8N_USE_FOLDER/binaryData` | The path where n8n stores binary data. |
|
||||
| `N8N_DEFAULT_BINARY_DATA_MODE` | String | `default` | The default binary data mode. `default` keeps binary data in memory. Set to `filesystem` to use the filesystem. |
|
||||
| `N8N_DEFAULT_BINARY_DATA_MODE` | String | `default` | The default binary data mode. `default` keeps binary data in memory. Set to `filesystem` to use the filesystem, or `s3` to AWS S3. |
|
||||
|
||||
## User management SMTP, and two-factor authentication
|
||||
|
||||
@ -198,6 +200,19 @@ Refer to [Log streaming](/log-streaming/) for more information on this feature.
|
||||
| `N8N_EVENTBUS_LOGWRITER_MAXFILESIZEINKB` | Number | `10240` | Maximum size (in kilo-bytes) of an event log file before a new one is started. |
|
||||
| `N8N_EVENTBUS_LOGWRITER_LOGBASENAME` | String | `n8nEventLog` | Basename of the event log file. |
|
||||
|
||||
## External data storage
|
||||
|
||||
Refer to [External storage](/hosting/external-storage/) for more information on using external storage for binary data.
|
||||
|
||||
| Variable | Type | Default | Description |
|
||||
| :------- | :---- | :------- | :---------- |
|
||||
| `N8N_EXTERNAL_STORAGE_S3_HOST` | String | - | Host of the n8n bucket in S3-compatible external storage. For example, `s3.us-east-1.amazonaws.com` |
|
||||
| `N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME` | String | - | Name of the n8n bucket in S3-compatible external storage. |
|
||||
| `N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION` | String | - | Region of the n8n bucket in S3-compatible external storage. For example, `us-east-1`|
|
||||
| `N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY` | String | - | Access key in S3-compatible external storage |
|
||||
| `N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET` | String | - | Access secret in S3-compatible external storage. |
|
||||
|
||||
|
||||
## Nodes
|
||||
|
||||
| Variable | Type | Default | Description |
|
||||
|
||||
76
docs/hosting/external-storage.md
Normal file
76
docs/hosting/external-storage.md
Normal file
@ -0,0 +1,76 @@
|
||||
---
|
||||
description: External storage of binary data for your n8n instance.
|
||||
contentType: howTo
|
||||
---
|
||||
|
||||
# External storage
|
||||
|
||||
!!! info "Feature availability"
|
||||
* Available on Self-hosted Enterprise plans
|
||||
* If you want access to this feature on Cloud Enterprise, [contact n8n](https://n8n-community.typeform.com/to/y9X2YuGa){:target=_blank .external-link}.
|
||||
|
||||
n8n can store binary data produced by workflow executions externally. This feature is useful to avoid relying on the filesystem for storing large amounts of binary data.
|
||||
|
||||
n8n will introduce external storage for other data types in the future.
|
||||
|
||||
## Storing n8n's binary data in S3
|
||||
|
||||
n8n supports [AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html){:target=_blank .external-link} as an external store for binary data produced by workflow executions. You can use other S3-compatible services like Cloudflare R2 and Backblaze B2, but n8n doesn't officially support these.
|
||||
|
||||
!!! info "Enterprise-tier feature"
|
||||
You will need an [Enterprise license key](/enterprise-key/) for external storage. If your license key expires and you remain on S3 mode, the instance will be able to read from, but not write to, the S3 bucket.
|
||||
|
||||
### Setup
|
||||
|
||||
Create and configure a bucket following the [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html){:target=_blank .external-link}. You can use the following policy, replacing `<bucket-name>` with the name of the bucket you created:
|
||||
|
||||
```json
|
||||
{
|
||||
"Version": "2012-10-17",
|
||||
"Statement": [
|
||||
{
|
||||
"Sid": "VisualEditor0",
|
||||
"Effect": "Allow",
|
||||
"Action": ["s3:*"],
|
||||
"Resource": ["arn:aws:s3:::<bucket-name>", "arn:aws:s3:::<bucket-name>/*"]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Once you finish creating the bucket, you will have a host, bucket name and region, and an access key ID and secret access key. You need to set them in n8n's environment:
|
||||
|
||||
```sh
|
||||
export N8N_EXTERNAL_STORAGE_S3_HOST=... # example: s3.us-east-1.amazonaws.com
|
||||
export N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME=...
|
||||
export N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION=...
|
||||
export N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY=...
|
||||
export N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET=...
|
||||
```
|
||||
|
||||
!!! note "No region"
|
||||
If your provider doesn't require a region, you can set `N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION` to `'auto'`.
|
||||
|
||||
Tell n8n to store binary data in S3:
|
||||
|
||||
```sh
|
||||
export N8N_AVAILABLE_BINARY_DATA_MODES=filesystem,s3
|
||||
export N8N_DEFAULT_BINARY_DATA_MODE=s3
|
||||
```
|
||||
|
||||
Restart the server to load the new configuration.
|
||||
|
||||
### Usage
|
||||
|
||||
After you enable S3, n8n writes and reads any new binary data to and from the S3 bucket. n8n writes binary data to your S3 bucket in this format:
|
||||
|
||||
```
|
||||
workflows/{workflowId}/executions/{executionId}/binary_data/{binaryFileId}
|
||||
```
|
||||
|
||||
n8n continues to read older binary data stored in the filesystem from the filesystem, if `filesystem` remains listed as an option in `N8N_AVAILABLE_BINARY_DATA_MODES`.
|
||||
|
||||
If you store binary data in S3 and later switch to filesystem mode, the instance continues to read any data stored in S3, as long as `s3` remains listed in `N8N_AVAILABLE_BINARY_DATA_MODES` and your S3 credentials remain valid.
|
||||
|
||||
!!! note "Binary data pruning"
|
||||
Binary data pruning operates on the active binary data mode. For example, if your instance stored data in S3, and you later switched to filesystem mode, n8n only prunes binary data in the filesystem. This may change in future.
|
||||
@ -50,6 +50,9 @@ For full release details, refer to [Releases](https://github.com/n8n-io/n8n/rele
|
||||
View the [commits](https://github.com/n8n-io/n8n/compare/n8n@1.10.0...n8n@1.10.1){:target=_blank .external-link} for this version.<br />
|
||||
**Release date:** 2023-10-11
|
||||
|
||||
!!! note "Next version"
|
||||
This is the `next` version. n8n recommends using the `latest` version. The `next` version may be unstable. To report issues, use the [forum](https://community.n8n.io/c/questions/12){:target=_blank .external-link}.
|
||||
|
||||
This release contains bug fixes.
|
||||
|
||||
For full release details, refer to [Releases](https://github.com/n8n-io/n8n/releases){:target=_blank .external-link} on GitHub.
|
||||
@ -62,6 +65,7 @@ View the [commits](https://github.com/n8n-io/n8n/compare/n8n@1.9.2...n8n@1.9.3){
|
||||
!!! note "Latest version"
|
||||
This is the `latest` version. n8n recommends using the `latest` version. The `next` version may be unstable. To report issues, use the [forum](https://community.n8n.io/c/questions/12){:target=_blank .external-link}.
|
||||
|
||||
|
||||
This release contains bug fixes.
|
||||
|
||||
For full release details, refer to [Releases](https://github.com/n8n-io/n8n/releases){:target=_blank .external-link} on GitHub.
|
||||
@ -80,8 +84,6 @@ For full release details, refer to [Releases](https://github.com/n8n-io/n8n/rele
|
||||
View the [commits](https://github.com/n8n-io/n8n/compare/n8n@1.9.1...n8n@1.10.0){:target=_blank .external-link} for this version.<br />
|
||||
**Release date:** 2023-10-05
|
||||
|
||||
!!! note "Next version"
|
||||
This is the `next` version. n8n recommends using the `latest` version. The `next` version may be unstable. To report issues, use the [forum](https://community.n8n.io/c/questions/12){:target=_blank .external-link}.
|
||||
|
||||
|
||||
This release contains bug fixes and preparatory work for new features.
|
||||
|
||||
@ -585,6 +585,7 @@ nav:
|
||||
- Isolating n8n: hosting/environment-variables/configuration-examples/isolation.md
|
||||
- Supported databases and settings: hosting/supported-databases-settings.md
|
||||
- User management: hosting/user-management-self-hosted.md
|
||||
- External storage: hosting/external-storage.md
|
||||
- Security audit: hosting/security-audit.md
|
||||
- Logging and monitoring:
|
||||
- hosting/logging-monitoring/index.md
|
||||
|
||||
@ -5,6 +5,7 @@ Airtable
|
||||
Asana
|
||||
Authentik
|
||||
Axios
|
||||
Backblaze
|
||||
backend
|
||||
Beeminder
|
||||
Boolean
|
||||
|
||||
Loading…
Reference in New Issue
Block a user