Skip to content

Commit 9cb9804

Browse files
janoberjanober
committed
Initial commit to release
0 parents  commit 9cb9804

File tree

257 files changed

+42436
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

257 files changed

+42436
-0
lines changed

‎.editorconfig

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_style = tab
6+
end_of_line = lf
7+
insert_final_newline = true
8+
trim_trailing_whitespace = true

‎.gitignore

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
node_modules
2+
.DS_Store
3+
.tmp
4+
tmp
5+
dist
6+
npm-debug.log*
7+
lerna-debug.log
8+
package-lock.json
9+
yarn.lock
10+
google-generated-credentials.json
11+
_START_PACKAGE

‎LICENSE

+230
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,230 @@
1+
“Commons Clause” License Condition v1.0
2+
3+
The Software is provided to you by the Licensor under the
4+
License, as defined below, subject to the following condition.
5+
6+
Without limiting other conditions in the License, the grant
7+
of rights under the License will not include, and the License
8+
does not grant to you, the right to Sell the Software.
9+
10+
For purposes of the foregoing, “Sell” means practicing any or
11+
all of the rights granted to you under the License to provide
12+
to third parties, for a fee or other consideration (including
13+
without limitation fees for hosting or consulting/ support
14+
services related to the Software), a product or service whose
15+
value derives, entirely or substantially, from the functionality
16+
of the Software. Any license notice or attribution required by
17+
the License must also include this Commons Clause License
18+
Condition notice.
19+
20+
Software: n8n
21+
22+
License: Apache 2.0
23+
24+
Licensor: Jan Oberhauser
25+
26+
27+
---------------------------------------------------------------------
28+
29+
30+
Apache License
31+
Version 2.0, January 2004
32+
http://www.apache.org/licenses/
33+
34+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
35+
36+
1. Definitions.
37+
38+
"License" shall mean the terms and conditions for use, reproduction,
39+
and distribution as defined by Sections 1 through 9 of this document.
40+
41+
"Licensor" shall mean the copyright owner or entity authorized by
42+
the copyright owner that is granting the License.
43+
44+
"Legal Entity" shall mean the union of the acting entity and all
45+
other entities that control, are controlled by, or are under common
46+
control with that entity. For the purposes of this definition,
47+
"control" means (i) the power, direct or indirect, to cause the
48+
direction or management of such entity, whether by contract or
49+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
50+
outstanding shares, or (iii) beneficial ownership of such entity.
51+
52+
"You" (or "Your") shall mean an individual or Legal Entity
53+
exercising permissions granted by this License.
54+
55+
"Source" form shall mean the preferred form for making modifications,
56+
including but not limited to software source code, documentation
57+
source, and configuration files.
58+
59+
"Object" form shall mean any form resulting from mechanical
60+
transformation or translation of a Source form, including but
61+
not limited to compiled object code, generated documentation,
62+
and conversions to other media types.
63+
64+
"Work" shall mean the work of authorship, whether in Source or
65+
Object form, made available under the License, as indicated by a
66+
copyright notice that is included in or attached to the work
67+
(an example is provided in the Appendix below).
68+
69+
"Derivative Works" shall mean any work, whether in Source or Object
70+
form, that is based on (or derived from) the Work and for which the
71+
editorial revisions, annotations, elaborations, or other modifications
72+
represent, as a whole, an original work of authorship. For the purposes
73+
of this License, Derivative Works shall not include works that remain
74+
separable from, or merely link (or bind by name) to the interfaces of,
75+
the Work and Derivative Works thereof.
76+
77+
"Contribution" shall mean any work of authorship, including
78+
the original version of the Work and any modifications or additions
79+
to that Work or Derivative Works thereof, that is intentionally
80+
submitted to Licensor for inclusion in the Work by the copyright owner
81+
or by an individual or Legal Entity authorized to submit on behalf of
82+
the copyright owner. For the purposes of this definition, "submitted"
83+
means any form of electronic, verbal, or written communication sent
84+
to the Licensor or its representatives, including but not limited to
85+
communication on electronic mailing lists, source code control systems,
86+
and issue tracking systems that are managed by, or on behalf of, the
87+
Licensor for the purpose of discussing and improving the Work, but
88+
excluding communication that is conspicuously marked or otherwise
89+
designated in writing by the copyright owner as "Not a Contribution."
90+
91+
"Contributor" shall mean Licensor and any individual or Legal Entity
92+
on behalf of whom a Contribution has been received by Licensor and
93+
subsequently incorporated within the Work.
94+
95+
2. Grant of Copyright License. Subject to the terms and conditions of
96+
this License, each Contributor hereby grants to You a perpetual,
97+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
98+
copyright license to reproduce, prepare Derivative Works of,
99+
publicly display, publicly perform, sublicense, and distribute the
100+
Work and such Derivative Works in Source or Object form.
101+
102+
3. Grant of Patent License. Subject to the terms and conditions of
103+
this License, each Contributor hereby grants to You a perpetual,
104+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
105+
(except as stated in this section) patent license to make, have made,
106+
use, offer to sell, sell, import, and otherwise transfer the Work,
107+
where such license applies only to those patent claims licensable
108+
by such Contributor that are necessarily infringed by their
109+
Contribution(s) alone or by combination of their Contribution(s)
110+
with the Work to which such Contribution(s) was submitted. If You
111+
institute patent litigation against any entity (including a
112+
cross-claim or counterclaim in a lawsuit) alleging that the Work
113+
or a Contribution incorporated within the Work constitutes direct
114+
or contributory patent infringement, then any patent licenses
115+
granted to You under this License for that Work shall terminate
116+
as of the date such litigation is filed.
117+
118+
4. Redistribution. You may reproduce and distribute copies of the
119+
Work or Derivative Works thereof in any medium, with or without
120+
modifications, and in Source or Object form, provided that You
121+
meet the following conditions:
122+
123+
(a) You must give any other recipients of the Work or
124+
Derivative Works a copy of this License; and
125+
126+
(b) You must cause any modified files to carry prominent notices
127+
stating that You changed the files; and
128+
129+
(c) You must retain, in the Source form of any Derivative Works
130+
that You distribute, all copyright, patent, trademark, and
131+
attribution notices from the Source form of the Work,
132+
excluding those notices that do not pertain to any part of
133+
the Derivative Works; and
134+
135+
(d) If the Work includes a "NOTICE" text file as part of its
136+
distribution, then any Derivative Works that You distribute must
137+
include a readable copy of the attribution notices contained
138+
within such NOTICE file, excluding those notices that do not
139+
pertain to any part of the Derivative Works, in at least one
140+
of the following places: within a NOTICE text file distributed
141+
as part of the Derivative Works; within the Source form or
142+
documentation, if provided along with the Derivative Works; or,
143+
within a display generated by the Derivative Works, if and
144+
wherever such third-party notices normally appear. The contents
145+
of the NOTICE file are for informational purposes only and
146+
do not modify the License. You may add Your own attribution
147+
notices within Derivative Works that You distribute, alongside
148+
or as an addendum to the NOTICE text from the Work, provided
149+
that such additional attribution notices cannot be construed
150+
as modifying the License.
151+
152+
You may add Your own copyright statement to Your modifications and
153+
may provide additional or different license terms and conditions
154+
for use, reproduction, or distribution of Your modifications, or
155+
for any such Derivative Works as a whole, provided Your use,
156+
reproduction, and distribution of the Work otherwise complies with
157+
the conditions stated in this License.
158+
159+
5. Submission of Contributions. Unless You explicitly state otherwise,
160+
any Contribution intentionally submitted for inclusion in the Work
161+
by You to the Licensor shall be under the terms and conditions of
162+
this License, without any additional terms or conditions.
163+
Notwithstanding the above, nothing herein shall supersede or modify
164+
the terms of any separate license agreement you may have executed
165+
with Licensor regarding such Contributions.
166+
167+
6. Trademarks. This License does not grant permission to use the trade
168+
names, trademarks, service marks, or product names of the Licensor,
169+
except as required for reasonable and customary use in describing the
170+
origin of the Work and reproducing the content of the NOTICE file.
171+
172+
7. Disclaimer of Warranty. Unless required by applicable law or
173+
agreed to in writing, Licensor provides the Work (and each
174+
Contributor provides its Contributions) on an "AS IS" BASIS,
175+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
176+
implied, including, without limitation, any warranties or conditions
177+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
178+
PARTICULAR PURPOSE. You are solely responsible for determining the
179+
appropriateness of using or redistributing the Work and assume any
180+
risks associated with Your exercise of permissions under this License.
181+
182+
8. Limitation of Liability. In no event and under no legal theory,
183+
whether in tort (including negligence), contract, or otherwise,
184+
unless required by applicable law (such as deliberate and grossly
185+
negligent acts) or agreed to in writing, shall any Contributor be
186+
liable to You for damages, including any direct, indirect, special,
187+
incidental, or consequential damages of any character arising as a
188+
result of this License or out of the use or inability to use the
189+
Work (including but not limited to damages for loss of goodwill,
190+
work stoppage, computer failure or malfunction, or any and all
191+
other commercial damages or losses), even if such Contributor
192+
has been advised of the possibility of such damages.
193+
194+
9. Accepting Warranty or Additional Liability. While redistributing
195+
the Work or Derivative Works thereof, You may choose to offer,
196+
and charge a fee for, acceptance of support, warranty, indemnity,
197+
or other liability obligations and/or rights consistent with this
198+
License. However, in accepting such obligations, You may act only
199+
on Your own behalf and on Your sole responsibility, not on behalf
200+
of any other Contributor, and only if You agree to indemnify,
201+
defend, and hold each Contributor harmless for any liability
202+
incurred by, or claims asserted against, such Contributor by reason
203+
of your accepting any such warranty or additional liability.
204+
205+
END OF TERMS AND CONDITIONS
206+
207+
APPENDIX: How to apply the Apache License to your work.
208+
209+
To apply the Apache License to your work, attach the following
210+
boilerplate notice, with the fields enclosed by brackets "[]"
211+
replaced with your own identifying information. (Don't include
212+
the brackets!) The text should be enclosed in the appropriate
213+
comment syntax for the file format. We also recommend that a
214+
file or class name and description of purpose be included on the
215+
same "printed page" as the copyright notice for easier
216+
identification within third-party archives.
217+
218+
Copyright [yyyy] [name of copyright owner]
219+
220+
Licensed under the Apache License, Version 2.0 (the "License");
221+
you may not use this file except in compliance with the License.
222+
You may obtain a copy of the License at
223+
224+
http://www.apache.org/licenses/LICENSE-2.0
225+
226+
Unless required by applicable law or agreed to in writing, software
227+
distributed under the License is distributed on an "AS IS" BASIS,
228+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
229+
See the License for the specific language governing permissions and
230+
limitations under the License.

‎README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# n8n - Workflow Automation Tool
2+
3+
![n8n.io - Workflow Automation](https://n8n.io/n8n-logo.png)
4+
5+
n8n is a tool which allows to easily and fast automate different taks.
6+
7+
Is still in beta so can not guarantee that everything works perfectly. Also
8+
is there currently not much documentation. That will hopefully change soon.
9+
10+
11+
## Usage
12+
13+
Information about how to install and use it can be found in the cli package [here](packages/cli/README)
14+
15+
And information about how to run it in Docker [here](docker/images/n8n/README.md)
16+
17+
18+
## Development Setup
19+
20+
1. Clone the repository
21+
2. Go into repository folder
22+
3. Run: `npm install`
23+
4. Run: `npx lerna bootstrap --hoist`
24+
5. Run: `npm run build` or `npx lerna exec npm run build` (if lerna is not installed)
25+
26+
## Start
27+
28+
Execute: `npm run start`
29+
30+
31+
## License
32+
33+
[Apache 2.0 with Commons Clause](LICENSE)

‎docker/compose/withMongo/.env

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
MONGO_INITDB_ROOT_USERNAME=adminuser
2+
MONGO_INITDB_ROOT_PASSWORD=JvsjjAYg12FJ90sdCBdsh322V
3+
MONGO_INITDB_DATABASE=n8n
4+
5+
MONGO_NON_ROOT_USERNAME=n8nuser
6+
MONGO_NON_ROOT_PASSWORD=PLsQ8vHGShwDFdmSssb

‎docker/compose/withMongo/README.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# n8n with MongoDB
2+
3+
Starts n8n with MongoDB as database.
4+
5+
6+
## Start
7+
8+
To start n8n with MongoDB simply start docker-compose by executing the following
9+
command in the current folder.
10+
11+
12+
**IMPORTANT:** But before you do that change the default users and passwords in the `.env` file!
13+
14+
```
15+
docker-compose up -d
16+
```
17+
18+
To stop it execute:
19+
20+
```
21+
docker-compose stop
22+
```
23+
24+
## Configuration
25+
26+
The default name of the database, user and password for MongoDB can be changed in the `.env` file in the current directory.

‎docker/compose/withMongo/docker-compose.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
version: '3.1'
2+
3+
services:
4+
5+
mongo:
6+
image: mongo:4.0
7+
restart: always
8+
environment:
9+
- MONGO_INITDB_ROOT_USERNAME
10+
- MONGO_INITDB_ROOT_PASSWORD
11+
- MONGO_INITDB_DATABASE
12+
- MONGO_NON_ROOT_USERNAME
13+
- MONGO_NON_ROOT_PASSWORD
14+
volumes:
15+
- ./init-data.sh:/docker-entrypoint-initdb.d/init-data.sh
16+
17+
n8n:
18+
image: n8n
19+
restart: always
20+
ports:
21+
- 5678:5678
22+
links:
23+
- mongo
24+
volumes:
25+
- ~/.n8n:/root/.n8n
26+
# Wait 5 seconds to start n8n to make sure that MongoDB is ready
27+
# when n8n tries to connect to it
28+
command: /bin/sh -c "sleep 5; n8n start --NODE_CONFIG='{\"database\":{\"type\":\"mongodb\", \"mongodbConfig\":{\"url\":\"mongodb://n8nuser:${MONGO_NON_ROOT_PASSWORD}@mongo:27017/${MONGO_INITDB_DATABASE}\"}}}'"

‎docker/compose/withMongo/init-data.sh

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#!/bin/bash
2+
set -e;
3+
4+
# Create a default non-root role
5+
MONGO_NON_ROOT_ROLE="${MONGO_NON_ROOT_ROLE:-readWrite}"
6+
7+
if [ -n "${MONGO_NON_ROOT_USERNAME:-}" ] && [ -n "${MONGO_NON_ROOT_PASSWORD:-}" ]; then
8+
"${mongo[@]}" "$MONGO_INITDB_DATABASE" <<-EOJS
9+
db.createUser({
10+
user: $(_js_escape "$MONGO_NON_ROOT_USERNAME"),
11+
pwd: $(_js_escape "$MONGO_NON_ROOT_PASSWORD"),
12+
roles: [ { role: $(_js_escape "$MONGO_NON_ROOT_ROLE"), db: $(_js_escape "$MONGO_INITDB_DATABASE") } ]
13+
})
14+
EOJS
15+
else
16+
echo "SETUP INFO: No Environment variables given!"
17+
fi

‎docker/images/n8n/Dockerfile

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
FROM mhart/alpine-node:10
2+
3+
# Update everything and install needed dependencies
4+
RUN apk add --update \
5+
graphicsmagick
6+
7+
# # Set a custom user to not have n8n run as root
8+
USER root
9+
10+
# Install n8n and the also temporary all the packages
11+
# it needs to build it correctly.
12+
RUN apk --update add --virtual build-dependencies python build-base && \
13+
npm_config_user=root npm install -g n8n && \
14+
apk del build-dependencies
15+
16+
WORKDIR /data
17+
18+
CMD "n8n"

0 commit comments

Comments
 (0)