1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/n8n_ynh.git synced 2024-09-03 19:55:52 +02:00
n8n_ynh/README.md

51 lines
2.1 KiB
Markdown
Raw Normal View History

2021-09-18 15:09:39 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2021-09-18 14:27:12 +02:00
# n8n for YunoHost
2023-03-31 20:50:24 +02:00
[![Integration level](https://dash.yunohost.org/integration/n8n.svg)](https://dash.yunohost.org/appci/app/n8n) ![Working status](https://ci-apps.yunohost.org/ci/badges/n8n.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/n8n.maintain.svg)
2021-09-18 15:09:39 +02:00
[![Install n8n with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=n8n)
2021-09-18 14:27:12 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-09-18 15:09:39 +02:00
> *This package allows you to install n8n quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
2021-09-18 14:27:12 +02:00
## Overview
2021-09-18 15:09:39 +02:00
n8n is an extendable workflow automation tool. With a fair-code distribution model, n8n will always have visible source code, be available to self-host, and allow you to add your own custom functions, logic and apps. n8n's node-based approach makes it highly versatile, enabling you to connect anything to everything.
2021-09-18 14:27:12 +02:00
2023-10-15 08:44:36 +02:00
**Shipped version:** 1.9.3~ynh1
2021-09-18 14:27:12 +02:00
2021-09-19 08:34:54 +02:00
## Screenshots
2022-06-13 20:44:13 +02:00
![Screenshot of n8n](./doc/screenshots/n8n-screenshot.png)
2021-09-19 08:34:54 +02:00
2022-10-04 19:03:39 +02:00
## :red_circle: Antifeatures
- **Not totally free upstream**: The packaged app is under an overall free licence, but with clauses that restrict its use.
2021-09-18 15:09:39 +02:00
## Documentation and resources
2021-09-18 14:27:12 +02:00
2022-06-13 20:44:13 +02:00
* Official app website: <https://n8n.io/>
* Official admin documentation: <https://docs.n8n.io/>
* Upstream app code repository: <https://github.com/n8n-io/n8n>
* Report a bug: <https://github.com/YunoHost-Apps/n8n_ynh/issues>
2021-09-18 14:27:12 +02:00
2021-09-18 15:09:39 +02:00
## Developer info
2021-09-18 14:27:12 +02:00
2021-09-18 15:09:39 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/n8n_ynh/tree/testing).
2021-09-18 14:27:12 +02:00
To try the testing branch, please proceed like that.
2022-06-13 20:44:13 +02:00
``` bash
2021-09-18 15:09:39 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/n8n_ynh/tree/testing --debug
2021-09-18 14:27:12 +02:00
or
2021-09-18 15:09:39 +02:00
sudo yunohost app upgrade n8n -u https://github.com/YunoHost-Apps/n8n_ynh/tree/testing --debug
2021-09-18 14:27:12 +02:00
```
2021-09-18 15:09:39 +02:00
2022-06-13 20:44:13 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>