diff --git a/README.md b/README.md index c337c3d..1872de2 100755 --- a/README.md +++ b/README.md @@ -1,72 +1,43 @@ + + # n8n for YunoHost -[![Integration level](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg) -[![Install Etherpad-Lite with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad) +[![Integration level](https://dash.yunohost.org/integration/n8n.svg)](https://dash.yunohost.org/appci/app/n8n) ![](https://ci-apps.yunohost.org/ci/badges/n8n.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/n8n.maintain.svg) +[![Install n8n with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=n8n) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Etherpad-Lite quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* - -> :warning: This package installs Etherpad-Lite (without MyPads and plugins). It uses PostgreSQL as database. ->If you want to install Etherpad with the MyPads plugin, use the [Etherpad MyPads package](https://github.com/YunoHost-Apps/etherpad_mypads_ynh). +> *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.* ## Overview -Etherpad allows you to edit documents collaboratively in real-time, much like a live multi-player editor that runs in your browser. Write articles, press releases, to-do lists, etc. together with your friends, fellow students or colleagues, all working on the same document at the same time. -**Shipped version:** 0.138.0 +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. -## Screenshots +**Shipped version:** 0.138.0~ynh1 -![]() +**Demo:** https://demo.example.com -## Demo +## Documentation and resources -* [Official demo]() +* Official app website: https://n8n.io/ +* Official admin documentation: https://docs.n8n.io/ +* Upstream app code repository: https://github.com/n8n-io/n8n +* YunoHost documentation for this app: https://yunohost.org/app_n8n +* Report a bug: https://github.com/YunoHost-Apps/n8n_ynh/issues -## Configuration +## Developer info -You can access Etherpad's admin panel at `domain.tld/admin`. The configuration file for Etherpad is at the path `/var/www/etherpad/settings.json`. - -*Skin Builder* (accessible at this address `domain.tld/pad/p/test#skinvariantsbuilder`) allows you to customize the skin of your pad. It will give you a parameter to copy into your configuration file `/var/www/etherpad/settings.json`. - -## Documentation - - * Official documentation: http://etherpad.org/doc/v1.8.13 - * YunoHost documentation: https://yunohost.org/en/app_etherpad - -## YunoHost specific features - -#### Multi-users support - - * Is LDAP auth supported? **No** - * Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/etherpad%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad/) -* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad/) - -## Limitations - -## Additionnal informations - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/etherpad_ynh/issues - * n8n website: https://n8n.io/ - * Upstream app repository: https://github.com/n8n-io/n8n - * YunoHost website: https://yunohost.org/ - ---- - -## Developers infos - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/n8n_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/n8n_ynh/tree/testing --debug or -sudo yunohost app upgrade etherpad -u https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug +sudo yunohost app upgrade n8n -u https://github.com/YunoHost-Apps/n8n_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index fae74eb..6db61cc 100755 --- a/README_fr.md +++ b/README_fr.md @@ -1,72 +1,39 @@ # n8n pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg) -[![Installer Etherpad-Lite avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad) +[![Niveau d'intégration](https://dash.yunohost.org/integration/n8n.svg)](https://dash.yunohost.org/appci/app/n8n) ![](https://ci-apps.yunohost.org/ci/badges/n8n.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/n8n.maintain.svg) +[![Installer n8n avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=n8n) *[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Etherpad-Lite rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/#/install_fr) pour savoir comment l'installer et en profiter.* +> *Ce package vous permet d'installer n8n rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* -> :warning: Ce paquet installe Etherpad-Lite (sans MyPads et divers plugins). Il utilise PostgreSQL comme base de données. -> Si vous souhaitez installer Etherpad avec MyPads, utilisez le paquet [Etherpad MyPads](https://github.com/YunoHost-Apps/etherpad_mypads_ynh). +## Vue d'ensemble -## Résumé -Etherpad vous permet d'éditer des documents de manière collaborative en temps réel, un peu comme un éditeur multi-joueurs en direct qui s'exécute dans votre navigateur. Rédigez des articles, des communiqués de presse, des listes de choses à faire, etc. avec vos amis, camarades ou collègues, tous travaillant sur le même document en même temps. +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. -**Version embarquée :** 0.138.0 +**Version incluse :** 0.138.0~ynh1 -## Captures d'écran +**Démo :** https://demo.example.com -![]() +## Documentations et ressources -## Démo +* Site officiel de l'app : https://n8n.io/ +* Documentation officielle de l'admin : https://docs.n8n.io/ +* Dépôt de code officiel de l'app : https://github.com/n8n-io/n8n +* Documentation YunoHost pour cette app : https://yunohost.org/app_n8n +* Signaler un bug : https://github.com/YunoHost-Apps/n8n_ynh/issues -* [Démo officielle]() +## Informations pour les développeurs -## Configuration +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/n8n_ynh/tree/testing). -Vous pouvez accéder au panneau d'administration d'Etherpad à l'adresse `domain.tld/admin`. Le fichier de configuration d'Etherpad est `/var/www/etherpad/settings.json`. - -*Skin Builder* (accessible à l'adresse `domain.tld/pad/p/test#skinvariantsbuilder`) vous permet de personnaliser l'apparence de votre pad. Il vous donnera un paramètre à copier dans votre fichier de configuration `/var/www/etherpad/settings.json`. - -## Documentation - - * Documentation officielle : http://etherpad.org/doc/v1.8.13 - * Documentation YunoHost : https://yunohost.org/fr/app_etherpad - -## Fonctionnalités spécifiques à YunoHost - -#### Support multi-utilisateurs - - * L'authentification LDAP est-elle prise en charge ? **Non** - * L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** - -#### Architectures supportées - -* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/etherpad%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad/) -* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad/) - -## Limitations - -## Informations additionnelles - -## Liens - - * Reporter un bug : https://github.com/YunoHost-Apps/etherpad_ynh/issues - * Site d'Etherpad : http://etherpad.org/ - * Dépôt GitHub de l'application : https://github.com/ether/etherpad-lite - * Site de YunoHost : https://yunohost.org/ - ---- - -## Informations à l'intention des développeurs - -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing). - -Pour tester la branche testing, merci de procéder ainsi. +Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/n8n_ynh/tree/testing --debug ou -sudo yunohost app upgrade etherpad -u https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug +sudo yunohost app upgrade n8n -u https://github.com/YunoHost-Apps/n8n_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file