⚙️ How to install and configure TelePilot as n8n plugin

Overview

✈️ Install as n8n community node

Easiest way to use telepilot, is to install @telepilotco/n8n-nodes-telepilot from https://npmjs.org registry as community node in your self-hosted n8n:

Go to Settings -> Community modules of your n8n instance
Select “Install Community node”
Specify the name @telepilotco/n8n-nodes-telepilot, click checkbox that you understand the risks and click “Install”

Install Telepilot as n8n Community Node

🛠 Manual installation

For advanced usage and when your n8n is run direcly without docker, you may install the package in your ~/.n8n/nodes directory by executing these commands:

cd ~/.n8n 
mkdir -p nodes 
cd nodes 
npm install @telepilotco/n8n-nodes-telepilot

Building from Dockerfile

If you are building custom n8n Docker image, add the following line before docker-entrypoint.sh COPY command in your n8n Dockerfile:

RUN cd ~/.n8n/ && mkdir nodes && cd nodes && npm install @telepilotco/n8n-nodes-telepilot

Or you create another image based on n8nio/n8n:latest - that’s what we did. We were able to install telepilot into our own n8n docker image by using following Dockerfile:

FROM n8nio/n8n:latest
RUN cd ~/.n8n/ && mkdir nodes && cd nodes && npm install @telepilotco/n8n-nodes-telepilot
RUN ls -la ~/.n8n/nodes/
ENTRYPOINT ["tini", "--", "/docker-entrypoint.sh"]

Docker image was then built by executing docker build command:

docker build . --network=host --no-cache -t n8n-alpine-dockerfile-installation --progress=plain

In order to start container, you can try running this command:

docker run -it --rm \
	--name n8n-alpine-dockerfile-installation \
	-p 5678:5678 \
	-e EXECUTIONS_PROCESS=main \
	--net="host" \
	n8n-alpine-dockerfile-installation

Adding Telepilot to your docker-compose setup

Put following docker-compose.yml in your Dockerfile folder. You may also add traefik, caddy, salt and pepper if you like:

version: "3.7"

services:
  n8n:
    build : .
    restart: always
    ports:
      - "5678:5678"
    environment:
      - N8N_HOST=localhost
      - N8N_PORT=5678
      - N8N_PROTOCOL=https
      - NODE_ENV=production
      - GENERIC_TIMEZONE=${GENERIC_TIMEZONE}
    volumes:
      - n8n_data:/home/node/.n8n

volumes:
  n8n_data:
    external: true

And run it like this:

docker volume create --name=n8n_data
docker-compose up

Hopefully at this point you will see some messages from n8n instance that is being started.

👏 Congratulations!

Next, you can configure n8n credentials by Linking Telegram Account with TelePilot.

At some point of time you will see newly installed @telepilotco/n8n-nodes-telepilot plugin in your n8n. You may want to come back to this screen from time to time to update TelePilot.