From 635e685316a1dbca1684f75b9c4368a23d109523 Mon Sep 17 00:00:00 2001 From: Deborah Barnard Date: Tue, 29 Aug 2023 14:28:26 +0100 Subject: [PATCH 1/2] restructure and add manual info --- .../gui-install.md} | 4 +- .../community-nodes/installation/index.md | 10 +++ .../installation/manual-install.md | 88 +++++++++++++++++++ mkdocs.yml | 5 +- 4 files changed, 104 insertions(+), 3 deletions(-) rename docs/integrations/community-nodes/{installation.md => installation/gui-install.md} (96%) create mode 100644 docs/integrations/community-nodes/installation/index.md create mode 100644 docs/integrations/community-nodes/installation/manual-install.md diff --git a/docs/integrations/community-nodes/installation.md b/docs/integrations/community-nodes/installation/gui-install.md similarity index 96% rename from docs/integrations/community-nodes/installation.md rename to docs/integrations/community-nodes/installation/gui-install.md index 07e1c3ede..2ba2166e2 100644 --- a/docs/integrations/community-nodes/installation.md +++ b/docs/integrations/community-nodes/installation/gui-install.md @@ -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 diff --git a/docs/integrations/community-nodes/installation/index.md b/docs/integrations/community-nodes/installation/index.md new file mode 100644 index 000000000..fa2c43002 --- /dev/null +++ b/docs/integrations/community-nodes/installation/index.md @@ -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 application through the in-app GUI. diff --git a/docs/integrations/community-nodes/installation/manual-install.md b/docs/integrations/community-nodes/installation/manual-install.md new file mode 100644 index 000000000..5ee802f96 --- /dev/null +++ b/docs/integrations/community-nodes/installation/manual-install.md @@ -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 +``` +The 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 +``` diff --git a/mkdocs.yml b/mkdocs.yml index 0e7ec2ec0..d908755df 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 From 1fb871c8d7af51d22674f2455eabe8332090b28b Mon Sep 17 00:00:00 2001 From: Deborah Barnard Date: Tue, 29 Aug 2023 15:32:08 +0100 Subject: [PATCH 2/2] edits --- docs/integrations/community-nodes/installation/index.md | 2 +- .../integrations/community-nodes/installation/manual-install.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/community-nodes/installation/index.md b/docs/integrations/community-nodes/installation/index.md index fa2c43002..a32a5fe06 100644 --- a/docs/integrations/community-nodes/installation/index.md +++ b/docs/integrations/community-nodes/installation/index.md @@ -7,4 +7,4 @@ contentType: overview 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 application through the in-app GUI. +* [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. diff --git a/docs/integrations/community-nodes/installation/manual-install.md b/docs/integrations/community-nodes/installation/manual-install.md index 5ee802f96..c0784b3e0 100644 --- a/docs/integrations/community-nodes/installation/manual-install.md +++ b/docs/integrations/community-nodes/installation/manual-install.md @@ -31,7 +31,7 @@ Install the node: ```sh npm i n8n-nodes-nodeName ``` -The restart n8n. +Then restart n8n. ## Uninstall a community node