Merge pull request #1574 from n8n-io/DOC-613-manual-com-nodes

restructure and add manual info
This commit is contained in:
Deborah 2023-08-29 15:46:56 +01:00 committed by GitHub
commit fc7ef9bc28
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 104 additions and 3 deletions

View File

@ -2,10 +2,10 @@
contentType: howto
---
# Install, upgrade, and downgrade community nodes
# Install community nodes in the n8n app
!!! note "Limited to n8n instance owners"
Only the n8n instance owner can install and manage community nodes. The instance owner is the person who sets up and manages user management. If you haven't set up user management, the instance owner is the default user.
Only the n8n instance owner can install and manage community nodes. The instance owner is the person who sets up and manages user management.
## Install a community node

View File

@ -0,0 +1,10 @@
---
contentType: overview
---
# Install and manage community nodes
There are two ways to install community nodes:
* Within n8n [using the GUI](/integrations/community-nodes/installation/gui-install/).
* [Manually from the command line](/integrations/community-nodes/installation/manual-install/): use this method if your n8n instance doesn't support installation through the in-app GUI.

View File

@ -0,0 +1,88 @@
---
contentType: howto
---
# Manually install community nodes
You can manually install community nodes on self-hosted n8n.
You need to manually install community nodes in the following circumstances:
* Your n8n instance runs in queue mode.
* You want to install [private packages](https://docs.npmjs.com/creating-and-publishing-private-packages){:target=_blank .external-link}.
## Install a community node
Access your Docker shell:
```sh
docker exec -it n8n sh
```
Create `~/.n8n/nodes` if it doesn't already exist, and navigate into it:
```sh
mkdir ~/.n8n/nodes
cd ~/.n8n/nodes
```
Install the node:
```sh
npm i n8n-nodes-nodeName
```
Then restart n8n.
## Uninstall a community node
Access your Docker shell:
```sh
docker exec -it n8n sh
```
Run npm uninstall:
```sh
npm uninstall n8n-nodes-nodeName
```
## Upgrade a community node
!!! warning "Breaking changes in versions"
Node developers may introduce breaking changes in new versions of their nodes. A breaking change is an update that breaks previous functionality. Depending on the node versioning approach that a node developer chooses, upgrading to a version with a breaking change could cause all workflows using the node to break. Be careful when upgrading your nodes. If you find that an upgrade causes issues, you can [downgrade](#downgrade-a-community-node).
### Upgrade to the latest version
Access your Docker shell:
```sh
docker exec -it n8n sh
```
Run npm update:
```sh
npm update n8n-nodes-nodeName
```
### Upgrade or downgrade to a specific version
Access your Docker shell:
```sh
docker exec -it n8n sh
```
Run npm uninstall to remove the current version:
```sh
npm uninstall n8n-nodes-nodeName
```
Run npm install with the version specified:
```sh
# Replace 2.1.0 with your version number
npm install n8n-nodes-nodeName@2.1.0
```

View File

@ -515,7 +515,10 @@ nav:
- Custom API actions for existing nodes: integrations/custom-operations.md
- Community nodes:
- integrations/community-nodes/index.md
- Installation and management: integrations/community-nodes/installation.md
- Installation and management:
- integrations/community-nodes/installation/index.md
- GUI installation: integrations/community-nodes/installation/gui-install.md
- Manual installation: integrations/community-nodes/installation/manual-install.md
- Risks: integrations/community-nodes/risks.md
- Blocklist: integrations/community-nodes/blocklist.md
- Using community nodes: integrations/community-nodes/usage.md