fc7aa8bd66
* initial telemetry setup and adjusted pull return * quicksave before merge * feat: add conflicting workflow list to pull modal * feat: update source control pull modal * fix: fix linting issue * feat: add Enter keydown event for submitting source control push modal (no-changelog) feat: add Enter keydown event for submitting source control push modal * quicksave * user workflow table for export * improve telemetry data * pull api telemetry * fix lint * Copy tweaks. * remove authorName and authorEmail and pick from user * rename owners.json to workflow_owners.json * ignore credential conflicts on pull * feat: several push/pull flow changes and design update * pull and push return same data format * fix: add One last step toast for successful pull * feat: add up to date pull toast * fix: add proper Learn more link for push and pull modals * do not await tracking being sent * fix import * fix await * add more sourcecontrolfile status * Minor copy tweak for "More info". * Minor copy tweak for "More info". * ignore variable_stub conflicts on pull * ignore whitespace differences * do not show remote workflows that are not yet created * fix telemetry * fix toast when pulling deleted wf * lint fix * refactor and make some imports dynamic * fix variable edit validation * fix telemetry response * improve telemetry * fix unintenional delete commit * fix status unknown issue * fix up to date toast * do not export active state and reapply versionid * use update instead of upsert * fix: show all workflows when clicking push to git * feat: update Up to date pull translation * fix: update read only env checks * do not update versionid of only active flag changes * feat: prevent access to new workflow and templates import when read only env * feat: send only active state and version if workflow state is not dirty * fix: Detect when only active state has changed and prevent generation a new version ID * feat: improve readonly env messages * make getPreferences public * fix telemetry issue * fix: add partial workflow update based on dirty state when changing active state * update unit tests * fix: remove unsaved changes check in readOnlyEnv * fix: disable push to git button when read onyl env * fix: update readonly toast duration * fix: fix pinning and title input in protected mode * initial commit (NOT working) * working push * cleanup and implement pull * fix getstatus * update import to new method * var and tag diffs are no conflicts * only show pull conflict for workflows * refactor and ignore faulty credentials * add sanitycheck for missing git folder * prefer fetch over pull and limit depth to 1 * back to pull... * fix setting branch on initial connect * fix test * remove clean workfolder * refactor: Remove some unnecessary code * Fixed links to docs. * fix getstatus query params * lint fix * dialog to show local and remote name on conflict * only show remote name on conflict * fix credential expression export * fix: Broken test * dont show toast on pull with empty var/tags and refactor * apply frontend changes from old branch * fix tag with same name import * fix buttons shown for non instance owners * prepare local storage key for removal * refactor: Change wording on pushing and pulling * refactor: Change menu item * test: Fix broken test * Update packages/cli/src/environments/sourceControl/types/sourceControlPushWorkFolder.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> --------- Co-authored-by: Alex Grozav <alex@grozav.com> Co-authored-by: Giulio Andreini <g.andreini@gmail.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> |
||
---|---|---|
.. | ||
bin | ||
scripts | ||
src | ||
templates | ||
test | ||
.eslintrc.js | ||
BREAKING-CHANGES.md | ||
jest.config.js | ||
LICENSE.md | ||
LICENSE_EE.md | ||
nodemon.json | ||
package.json | ||
README.md | ||
tsconfig.build.json | ||
tsconfig.json |
n8n - Workflow Automation Tool
n8n is a free and open fair-code distributed node-based Workflow Automation Tool. You can self-host n8n, easily extend it, and even use it with internal tools.
Contents
- Demo
- Getting Started
- Available integrations
- Documentation
- Create Custom Nodes
- Contributing
- What does n8n mean and how do you pronounce it
- Support
- Jobs
- Upgrading
- License
Demo
📺 Here's a 📺 short video (< 4 min) that goes over key concepts of creating workflows in n8n.
Getting Started
There are a couple of ways to get started with n8n.
Use npx
To spin up n8n using npx, you can run:
npx n8n
It will download everything that is needed to start n8n.
You can then access n8n by opening: http://localhost:5678
Note: The minimum required version for Node.js is v14.15. Make sure to update Node.js to v14.15 or above.
Run with Docker
To play around with n8n, you can also start it using Docker:
docker run -it --rm \
--name n8n \
-p 5678:5678 \
docker.n8n.io/n8nio/n8n
Be aware that all the data will be lost once the Docker container gets removed. To persist the data mount the ~/.n8n
folder:
docker run -it --rm \
--name n8n \
-p 5678:5678 \
-v ~/.n8n:/home/node/.n8n \
docker.n8n.io/n8nio/n8n
Refer to the documentation for more information on the Docker setup.
Install with npm
To install n8n globally using npm:
npm install n8n -g
After the installation, start n8n running the following command:
n8n
# or
n8n start
Sign-up on n8n.cloud
Sign-up for an n8n.cloud account.
While n8n.cloud and n8n are the same in terms of features, n8n.cloud provides certain conveniences such as:
- Not having to set up and maintain your n8n instance
- Managed OAuth for authentication
- Easily upgrading to the newer n8n versions
Available integrations
n8n has 280+ different nodes that allow you to connect various services and build your automation workflows. You can find the list of all the integrations at https://n8n.io/integrations
Documentation
To learn more about n8n, refer to the official documentation here: https://docs.n8n.io
You can find additional information and example workflows on the n8n.io website.
Create Custom Nodes
You can create custom nodes for n8n. Follow the instructions mentioned in the documentation to create your node: Creating nodes
Contributing
🐛 Did you find a bug?
✨ Do you want to contribute a feature?
The CONTRIBUTING guide will help you set up your development environment.
You can find more information on how you can contribute to the project on our documentation: How can I contribute?
What does n8n mean, and how do you pronounce it?
Short answer: n8n is an abbreviation for "nodemation", and it is pronounced as n-eight-n.
Long answer: In n8n, you build your automation ("-mation") workflows by connecting different nodes in the Editor UI. The project is also built using Node.js. As a consequence, the project was named nodemation.
However, the name was long, and it wouldn't be a good idea to use such a long name in the CLI. Hence, nodemation got abbreviated as "n8n" (there are eight characters between the first and the last n!).
Support
If you run into issues or have any questions reach out to us via our community forum: https://community.n8n.io.
Jobs
If you are interested in working at n8n and building the project, check out the job openings.
Upgrading
Before you upgrade to the latest version, make sure to check the changelogs: Changelog
You can also find breaking changes here: Breaking Changes
License
n8n is fair-code distributed under the Sustainable Use License.
Proprietary licenses are available for enterprise customers. Get in touch
Additional information about the license can be found in the docs.