![\"Codely](\"https://codely.com/logo/codely_logo.svg\"){kind=logo}
\n \n \n \n
\n ![\"Codely](\"https://img.shields.io/badge/Codely-OS-green.svg?style=flat-square\"){kind=icon}
\n ![\"Codely](\"https://img.shields.io/badge/Codely-Pro-black.svg?style=flat-square\"){kind=icon}
\n
\n Trigger workflows on stream start or stream end, search for Twitch streams detailsβ¦\n
\n\n\n Stars welcomed π\n
\n\n# π n8n Twitch node features\n\nOnce installed, you will be able to add Twitch triggers and actions to your n8n workflows.\n\n1. Search for Twitch node:\n\n![\"Twitch](\"/docs/node.png\")
\n\n2. Select the desired action or trigger:\n\n ![\"Twitch](\"/docs/node-actions-and-triggers.png\")
\n\n3. Parametrize it:\n\n ![\"Twitch](\"/docs/node-parameters.png\")
\n\n# π Installation instructions\n\nThis node is in the process to be officially verified by n8n.\nThe installation process will be as simple as searching for \"Twitch\" in the nodes panel once we get that verification,\nbut in the meantime, you have several options that depend on how you use n8n.\n\nWe recommend checking out the [updated n8n instructions\non how to install community nodes](https://docs.n8n.io/integrations/community-nodes/installation/) for possible updates to this process.\n\n## a) n8n cloud instance\n\nIt is not possible to install unverified community nodes in n8n cloud ([documentation](https://docs.n8n.io/integrations/community-nodes/installation/)).\nOnce we get that verification, you will be able to install this node following [this step by step](https://docs.n8n.io/integrations/community-nodes/installation/verified-install/).\n\n## b) Self-hosted n8n instance\n\n### b.a) Not using queue mode: GUI installation\n\nFollow [the official instructions](https://docs.n8n.io/integrations/community-nodes/installation/gui-install/)\nspecifying `@codelytv/n8n-nodes-twitch` as the node name to install:\n\n![\"Twitch](\"/docs/node-installation.png\")
\n\n## b.b) Using queue mode\n\n### b.b.a) Install as npm package\n\nThis is the officially recommended way for self-hosted n8n instances running in queue mode ([documentation](https://docs.n8n.io/integrations/community-nodes/installation/manual-install/).\n\nGo to the folder where n8n is installed (if you are using the standard Docker installation, it will probably be:\n`/usr/local/lib/node_modules/n8n`) and install the package as any other npm package:\n\n```bash\nnpm i @codelytv/n8n-nodes-twitch\n```\n\n### b.b.b) Install as Custom Docker image\n\n`Dockerfile` contents example for a custom image with this node added:\n\n```dockerfile\nARG N8N_VERSION\nFROM n8nio/n8n:${N8N_VERSION}\n\nRUN if [ -z \"$N8N_VERSION\" ]; then echo \"π₯ N8N_VERSION argument missing.\"; exit 1; fi && \\\n mkdir -p /home/node/.n8n/nodes && \\\n npm install --prefix /home/node/.n8n/nodes --production --silent @codelytv/n8n-nodes-twitch\n```\n\n### b.b.c) Install using Docker Compose / Docker Swarm with mapped volume\n\nTake into account that this option has a considerable downside:\nThe workflows you create will contain `CUSTOM.twitchTrigger` as the node type reference instead of `@codelytv/n8n-nodes-twitch.twitchTrigger`. However, it could be the best approach if you want a faster feedback loop while developing.\nTake into account that localhost will not be reachable from Twitch, so you `probably are interested into exposing it with a tunnel using something like `cloudflared`, or just expose a remote host to Twitch.\n\nDocker Compose / Docker Swarm definition snippet:\n\n```yaml\nvolumes:\n n8n_data:\n name: '{{.Service.Name}}_{{.Task.Slot}}'\n\nservices:\n n8n-main:\n volumes:\n - n8n_data:/home/node/.n8n\n - /home/codely/n8n-custom-nodes:/home/node/.n8n/custom\n```\n\nDeploy process:\n\n```bash\nCUSTOM_NODES_DIR=\"$HOME/n8n-custom-nodes\"\n\nmkdir -p \"$CUSTOM_NODES_DIR\"\n\ndocker run --rm \\\n --user \"$(id -u):$(id -g)\" \\\n -v \"$CUSTOM_NODES_DIR\":/data \\\n -w /data \\\n node:22-alpine \\\n sh -c \"npm install @codelytv/n8n-nodes-twitch --production --silent\"\n\ndocker stack deploy -c n8n-swarm.yml n8n\n```\n\n# π How to get Twitch credentials\n\nYou will need to create a new Twitch application to get Client ID and Client Secret following these steps:\n\n1. Go to the [Twitch Developer Console](https://dev.twitch.tv/console/apps).\n2. Log in using your Twitch account credentials.\n3. Click on the \"+ Register Your Application\" button.\n4. Fill out the form as follows and click \"Create\":\n - Name: Name your app (e.g., βn8nTwitchBotβ).\n - OAuth Redirect URLs: Use a valid redirect URL.\n Something like http://localhost:5678/rest/oauth2-credential/callback works.\n We do not plan to display Twitch authentication to end users with Oauth.\n We're only interested in getting the Client ID and Client Secret, so it's fine to specify a local URL.\n - Category: Application Integration\n - Client Type: Confidential\n5. Get your credentials:\n - Click on \"Manage\"\n - Client ID: Visible right away.\n - Client Secret: Click \"New Secret\" to generate one. Be sure to store this securely (it wonβt be shown again).\n\n# π» Documentation for node contributors\n\nHow to locally test this node (based on [the official n8n guide](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/)):\n\n1. Clone and move to the node development folder\n ```bash\n cd ~/Code/work/codely/public/\n git clone git@github.com:CodelyTV/n8n-nodes-twitch.git\n cd n8n-nodes-twitch\n ```\n2. Build the node\n ```bash\n npm run build\n ```\n3. Create a npm global symlink to the locally installed package \n ```bash\n npm link\n ```\n4. Install n8n locally:\n ```bash\n npm install n8n -g\n ```\n5. Move to your n8n local installation\n ```bash\n cd ~/.n8n/\n ```\n6. Create a custom nodes folder\n ```bash\n mkdir custom\n cd custom\n7. Link the node package to the symlink previously created\n ```bash\n npm link @codelytv/n8n-nodes-twitch\n ```\n8. Validate that the local n8n instance has the Twitch node pointing to the local folder\n ```bash\n tree -L 3 -d\n ```\n Expected output:\n ```bash\n .\n βββ node_modules\n βββ @codelytv\n βββ n8n-nodes-twitch -> ../../../../Code/work/codely/public/n8n-nodes-twitch\n ```\n9. Run n8n\n ```bash\n n8n start\n ```\n10. Enjoy!\n\n# π Codely Code Quality Standards\n\nPublishing this package we are committing ourselves to the following code quality standards:\n\n- π€ Respect **Semantic Versioning**: No breaking changes in patch or minor versions\n- π€ No surprises in transitive dependencies: Use the **bare minimum dependencies** needed to meet the purpose\n- π― **One specific purpose** to meet without having to carry a bunch of unnecessary other utilities\n- π **Well documented ReadMe** showing how to install and use\n- βοΈ **License favoring Open Source** and collaboration\n","readmeFilename":"README.md"}