From de05abc4124ce5cb3f016e828dc136b458212e16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Wed, 6 Sep 2023 20:23:07 +0200 Subject: [PATCH 01/13] Create DESCRIPTION_fr.md --- doc/DESCRIPTION_fr.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 doc/DESCRIPTION_fr.md diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..07301d1 --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1,8 @@ +TLDraw est une petite application de dessin. + +### Caractéristiques + +- UX très propre et agréable +- Empreinte mémoire vive et très faible sur le serveur +- Prêt pour PWA +- Mode multijoueur (compatible iFrame) \ No newline at end of file From 9c265dca4feed250681c6c9e9f7607b7c2a97635 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Wed, 6 Sep 2023 18:23:18 +0000 Subject: [PATCH 02/13] Auto-update README --- README_fr.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README_fr.md b/README_fr.md index 9d70e26..bcb7208 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,15 +16,14 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -TLDraw is a tiny little drawing app. +TLDraw est une petite application de dessin. -### Features - -- Very clean and nice UX -- Snappy and very low memory footprint on the server -- PWA ready -- Multiplayer mode (iFrame compatible) +### Caractéristiques +- UX très propre et agréable +- Empreinte mémoire vive et très faible sur le serveur +- Prêt pour PWA +- Mode multijoueur (compatible iFrame) **Version incluse :** 1.24.5~ynh3 From b7e746a01677c0257730a86479bf320eab7e546f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Wed, 6 Sep 2023 20:24:00 +0200 Subject: [PATCH 03/13] Create ADMIN_fr.md --- doc/ADMIN_fr.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 doc/ADMIN_fr.md diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md new file mode 100644 index 0000000..03d02bb --- /dev/null +++ b/doc/ADMIN_fr.md @@ -0,0 +1,12 @@ +* Le mode multijoueur nécessite les clés API Liveblocks (Public et Secret) + * Vous pouvez en obtenir gratuitement sur liveblocks.io + * Soyez **très prudent** cependant et gardez à l'esprit qu'en procédant ainsi, toutes les données de vos salles multijoueurs seront stockées sur les serveurs SaaS de animals.io, et **PAS** sur votre serveur. + * Le mode multijoueur est totalement facultatif et vous n'êtes pas obligé de l'utiliser + * Si les clés API ne sont pas fournies, elles seront automatiquement désactivées + +* TLDraw offre toutes les fonctionnalités (y compris le multijoueur) gratuitement sur tldraw.com + * Cependant, ils ont restreint l'utilisation du mode multijoueur au sein d'un iFrame, ce qui pourrait poser problème + * L'application TLDraw YunoHost corrige cette restriction afin que vous puissiez utiliser le mode multijoueur dans un iFrame comme avant. + +* Il pourrait être possible d'auto-héberger une couche multijoueur à l'avenir. Certains projets ont été lancés, basés sur la bibliothèque YJS, comme https://github.com/nimeshnayaju/yjs-tldraw, mais malheureusement aucun d'entre eux n'est suffisamment mature pour être inclus ici. + * Évidemment, dès que le multijoueur pourra être activé sans passer par les serveurs SaaS Liveblocks, l'application sera mise à jour en conséquence \ No newline at end of file From e6a1f3c50ddf5db8bc6cda99e6946b456f41e6f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Wed, 6 Sep 2023 20:24:59 +0200 Subject: [PATCH 04/13] Update manifest.toml --- manifest.toml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/manifest.toml b/manifest.toml index 791c34c..bdfe137 100644 --- a/manifest.toml +++ b/manifest.toml @@ -16,7 +16,7 @@ demo = "https://tldraw.com" code = "https://github.com/tldraw/tldraw" [integration] -yunohost = ">= 11.1.20" +yunohost = ">= 11.2" architectures = "all" multi_instance = true ldap = false @@ -27,10 +27,7 @@ ram.runtime = "50M" [install] [install.domain] - help.en = "TLDraw needs a fully dedicated domain" - help.fr = "TLDraw nécessite une installation à la racine du domaine" type = "domain" - full_domain = true [install.init_main_permission] type = "group" From 3636b0d55dbef87f3d9ef21f9300086af1178521 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com> Date: Fri, 24 Nov 2023 14:51:39 +0100 Subject: [PATCH 05/13] Update manifest.toml : disable auto update for now until multiplayer patch is fixed for newer versions --- manifest.toml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/manifest.toml b/manifest.toml index bdfe137..44137e8 100644 --- a/manifest.toml +++ b/manifest.toml @@ -53,8 +53,9 @@ ram.runtime = "50M" [resources.sources.main] url = "https://github.com/tldraw/tldraw/archive/8e55e263bf45cb6d425178c638aec385ec01e62c.zip" sha256 = "d090aac97266e043418ec34d46e722dd69c7dace4bd30f39afb9478eb21271d1" - autoupdate.upstream = "https://github.com/tldraw/tldraw" - autoupdate.strategy = "latest_github_commit" + # Disabled autoupdate for now because it's flooding with PRs which are failing the test + # The "multiplayer" patch needs to be fixed to be adapted to newer versions + #autoupdate.strategy = "latest_github_commit" [resources.ports] From ade1797bd2b5e607d186271a37ee1439303fd558 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Fri, 24 Nov 2023 13:51:45 +0000 Subject: [PATCH 06/13] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc1b747..eab00cc 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ TLDraw is a tiny little drawing app. * Official app website: * Upstream app code repository: -* YunoHost documentation for this app: +* YunoHost Store: * Report a bug: ## Developer info diff --git a/README_fr.md b/README_fr.md index bcb7208..311b699 100644 --- a/README_fr.md +++ b/README_fr.md @@ -37,7 +37,7 @@ TLDraw est une petite application de dessin. * Site officiel de l’app : * Dépôt de code officiel de l’app : -* Documentation YunoHost pour cette app : +* YunoHost Store: * Signaler un bug : ## Informations pour les développeurs From 362e6f16b85aa2abcaf6984d96a9318123df5ba5 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com> Date: Thu, 2 May 2024 02:02:28 +0200 Subject: [PATCH 07/13] Delete check_process --- check_process | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 check_process diff --git a/check_process b/check_process deleted file mode 100644 index 0f9aae1..0000000 --- a/check_process +++ /dev/null @@ -1,30 +0,0 @@ -# See here for more information -# https://github.com/YunoHost/package_check#syntax-check_process-file - -# Move this file from check_process.default to check_process when you have filled it. - -;; Test complet - ; Manifest - domain="domain.tld" - is_public=1 - publickey="public" - secretkey="secret" - ; Checks - pkg_linter=1 - setup_sub_dir=0 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none -;;; Upgrade options - ; commit=CommitHash - name=Name and date of the commit. - manifest_arg=domain=DOMAIN&path=PATH&is_public=1&language=fr&admin=USER&password=pass&port=666& From 1ce5dfd2a19f1cb8c2cbee1054fffb685566dc99 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Thu, 2 May 2024 00:02:32 +0000 Subject: [PATCH 08/13] Auto-update READMEs --- ALL_README.md | 7 ++++++ README.md | 24 ++++++++++---------- README_eu.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++ README_fr.md | 30 ++++++++++++------------- README_gl.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++ README_zh_Hans.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 202 insertions(+), 27 deletions(-) create mode 100644 ALL_README.md create mode 100644 README_eu.md create mode 100644 README_gl.md create mode 100644 README_zh_Hans.md diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..a01b345 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,7 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Irakurri README euskaraz](README_eu.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [阅读中文（简体）的 README](README_zh_Hans.md) diff --git a/README.md b/README.md index eab00cc..d46029a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install TLDraw with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tldraw) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README in other languages.](./ALL_README.md)* -> *This package allows you to install TLDraw 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.* +> *This package allows you to install TLDraw 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 @@ -28,7 +28,7 @@ TLDraw is a tiny little drawing app. **Shipped version:** 1.24.5~ynh3 -**Demo:** https://tldraw.com +**Demo:** ## Screenshots @@ -36,18 +36,18 @@ TLDraw is a tiny little drawing app. ## Documentation and resources -* Official app website: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug or sudo yunohost app upgrade tldraw -u https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..0008739 --- /dev/null +++ b/README_eu.md @@ -0,0 +1,56 @@ + + +# TLDraw YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/tldraw.svg)](https://dash.yunohost.org/appci/app/tldraw) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/tldraw.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/tldraw.maintain.svg) + +[![Instalatu TLDraw YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tldraw) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek TLDraw YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +TLDraw is a tiny little drawing app. + +### Features + +- Very clean and nice UX +- Snappy and very low memory footprint on the server +- PWA ready +- Multiplayer mode (iFrame compatible) + + +**Paketatutako bertsioa:** 1.24.5~ynh3 + +**Demoa:** + +## Pantaila-argazkiak + +![TLDraw(r)en pantaila-argazkia](./doc/screenshots/TLDraw_screenshot.png) + +## Dokumentazioa eta baliabideak + +- Aplikazioaren webgune ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug +edo +sudo yunohost app upgrade tldraw -u https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index 311b699..375bc50 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # TLDraw pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer TLDraw avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tldraw) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer TLDraw 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.* +> *Ce package vous permet d’installer TLDraw rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble @@ -25,9 +25,9 @@ TLDraw est une petite application de dessin. - Prêt pour PWA - Mode multijoueur (compatible iFrame) -**Version incluse :** 1.24.5~ynh3 +**Version incluse :** 1.24.5~ynh3 -**Démo :** https://tldraw.com +**Démo :** ## Captures d’écran @@ -35,21 +35,21 @@ TLDraw est une petite application de dessin. ## Documentations et ressources -* Site officiel de l’app : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug ou sudo yunohost app upgrade tldraw -u https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..281c754 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,56 @@ + + +# TLDraw para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/tldraw.svg)](https://dash.yunohost.org/appci/app/tldraw) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/tldraw.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/tldraw.maintain.svg) + +[![Instalar TLDraw con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tldraw) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar TLDraw de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +TLDraw is a tiny little drawing app. + +### Features + +- Very clean and nice UX +- Snappy and very low memory footprint on the server +- PWA ready +- Multiplayer mode (iFrame compatible) + + +**Versión proporcionada:** 1.24.5~ynh3 + +**Demo:** + +## Capturas de pantalla + +![Captura de pantalla de TLDraw](./doc/screenshots/TLDraw_screenshot.png) + +## Documentación e recursos + +- Web oficial da app: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug +ou +sudo yunohost app upgrade tldraw -u https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_zh_Hans.md b/README_zh_Hans.md new file mode 100644 index 0000000..dcccae2 --- /dev/null +++ b/README_zh_Hans.md @@ -0,0 +1,56 @@ + + +# YunoHost 的 TLDraw + +[![集成程度](https://dash.yunohost.org/integration/tldraw.svg)](https://dash.yunohost.org/appci/app/tldraw) ![工作状态](https://ci-apps.yunohost.org/ci/badges/tldraw.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/tldraw.maintain.svg) + +[![使用 YunoHost 安装 TLDraw](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tldraw) + +*[阅读此 README 的其它语言版本。](./ALL_README.md)* + +> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 TLDraw。* +> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* + +## 概况 + +TLDraw is a tiny little drawing app. + +### Features + +- Very clean and nice UX +- Snappy and very low memory footprint on the server +- PWA ready +- Multiplayer mode (iFrame compatible) + + +**分发版本：** 1.24.5~ynh3 + +**演示：** + +## 截图 + +![TLDraw 的截图](./doc/screenshots/TLDraw_screenshot.png) + +## 文档与资源 + +- 官方应用网站： +- 上游应用代码库： +- YunoHost 商店： +- 报告 bug： + +## 开发者信息 + +请向 [`testing` 分支](https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing) 发送拉取请求。 + +如要尝试 `testing` 分支，请这样操作： + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug +或 +sudo yunohost app upgrade tldraw -u https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug +``` + +**有关应用打包的更多信息：** From dbacb2eb23e788506c413e8db23a531ba26c1611 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com> Date: Thu, 2 May 2024 02:02:37 +0200 Subject: [PATCH 09/13] Delete config_panel.toml.example --- config_panel.toml.example | 295 -------------------------------------- 1 file changed, 295 deletions(-) delete mode 100644 config_panel.toml.example diff --git a/config_panel.toml.example b/config_panel.toml.example deleted file mode 100644 index c6bccd8..0000000 --- a/config_panel.toml.example +++ /dev/null @@ -1,295 +0,0 @@ - -## Config panel are available from webadmin > Apps > YOUR_APP > Config Panel Button -## Those panels let user configure some params on their apps using a friendly interface, -## and remove the need to manually edit files from the command line. - -## From a packager perspective, this .toml is coupled to the scripts/config script, -## which may be used to define custom getters/setters. However, most use cases -## should be covered automagically by the core, thus it may not be necessary -## to define a scripts/config at all! - -## ----------------------------------------------------------------------------- -## IMPORTANT: In accordance with YunoHost's spirit, please keep things simple and -## do not overwhelm the admin with tons of misunderstandable or advanced settings. -## ----------------------------------------------------------------------------- - -## The top level describe the entire config panels screen. - -## The version is a required property. -## Here a small reminder to associate config panel version with YunoHost version -## | Config | YNH | Config panel small change log | -## | ------ | --- | ------------------------------------------------------- | -## | 0.1 | 3.x | 0.1 config script not compatible with YNH >= 4.3 | -## | 1.0 | 4.3.x | The new config panel system with 'bind' property | -version = "1.0" - -## (optional) i18n property let you internationalize questions, however this feature -## is only available in core configuration panel (like yunohost domain config). -## So in app config panel this key is ignored for now, but you can internationalize -## by using a lang dictionary (see property name bellow) -# i18n = "prefix_translation_key" - -################################################################################ -#### ABOUT PANELS -################################################################################ - -## The next level describes web admin panels -## You have to choose an ID for each panel, in this example the ID is "main" -## Keep in mind this ID will be used in CLI to refer to your question, so choose -## something short and meaningfull. -## In the webadmin, each panel corresponds to a distinct tab / form -[main] - -## Define the label for your panel -## Internationalization works similarly to the 'description' and 'ask' questions in the manifest -# name.en = "Main configuration" -# name.fr = "Configuration principale" - -## (optional) If you need to trigger a service reload-or-restart after the user -## change a question in this panel, you can add your service in the list. -services = ["__APP__"] -# or services = ["nginx", "__APP__"] to also reload-or-restart nginx - -## (optional) This help properties is a short help displayed on the same line -## than the panel title but not displayed in the tab. -# help = "" - - ############################################################################ - #### ABOUT SECTIONS - ############################################################################ - - ## A panel is composed of one or several sections. - ## - ## Sections are meant to group questions together when they correspond to - ## a same subtopic. This impacts the rendering in terms of CLI prompts - ## and HTML forms - ## - ## You should choose an ID for your section, and prefix it with the panel ID - ## (Be sure to not make a typo in the panel ID, which would implicitly create - ## an other entire panel) - ## - ## We use the context of pepettes_ynh as an example, - ## which is a simple donation form app written in python, - ## and for which the admin will want to edit the configuration - [main.customization] - - ## (optional) Defining a proper title for sections is not mandatory - ## and depends on the exact rendering you're aiming for the CLI / webadmin - name = "" - - ## (optional) This help properties is a short help displayed on the same line - ## than the section title, meant to provide additional details - # help = "" - - ## (optional) As for panel, you can specify to trigger a service - ## reload-or-restart after the user change a question in this section. - ## This property is added to the panel property, it doesn't deactivate it. - ## So no need to replicate, the service list from panel services property. - # services = [] - - ## (optional) By default all questions are optionals, but you can specify a - ## default behaviour for question in the section - optional = false - - ## (optional) It's also possible with the 'visible' property to only - ## display the section depending on the user's answers to previous questions. - ## - ## Be careful that the 'visible' property should only refer to **previous** questions - ## Hence, it should not make sense to have a "visible" property on the very first section. - ## - ## Also, keep in mind that this feature only works in the webadmin and not in CLI - ## (therefore a user could be prompted in CLI for a question that may not be relevant) - # visible = true - - ######################################################################## - #### ABOUT QUESTIONS - ######################################################################## - - ## A section is compound of one or several questions. - - ## --------------------------------------------------------------------- - ## IMPORTANT: as for panel and section you have to choose an ID, but this - ## one should be unique in all this document, even if the question is in - ## an other panel. - ## --------------------------------------------------------------------- - - ## You can use same questions types and properties than in manifest.yml - ## install part. However, in YNH 4.3, a lot of change has been made to - ## extend availables questions types list. - ## See: TODO DOC LINK - - [main.customization.project_name] - - ## (required) The ask property is equivalent to the ask property in - ## the manifest. However, in config panels, questions are displayed on the - ## left side and therefore have less space to be rendered. Therefore, - ## it is better to use a short question, and use the "help" property to - ## provide additional details if necessary. - ask.en = "Name of the project" - - ## (required) The type property indicates how the question should be - ## displayed, validated and managed. Some types have specific properties. - ## - ## Types available: string, boolean, number, range, text, password, path - ## email, url, date, time, color, select, domain, user, tags, file. - ## - ## For a complete list with specific properties, see: TODO DOC LINK - type = "string" - - ######################################################################## - #### ABOUT THE BIND PROPERTY - ######################################################################## - - ## (recommended) 'bind' property is a powerful feature that let you - ## configure how and where the data will be read, validated and written. - - ## By default, 'bind property is in "settings" mode, it means it will - ## **only** read and write the value in application settings file. - ## bind = "settings" - - ## However, settings usually correspond to key/values in actual app configurations - ## Hence, a more useful mode is to have bind = ":FILENAME". In that case, YunoHost - ## will automagically find a line with "KEY=VALUE" in FILENAME - ## (with the adequate separator between KEY and VALUE) - ## - ## YunoHost will then use this value for the read/get operation. - ## During write/set operations, YunoHost will overwrite the value - ## in **both** FILENAME and in the app's settings.yml - - ## Configuration file format supported: yaml, toml, json, ini, env, php, - ## python. The feature probably works with others formats, but should be tested carefully. - - ## Note that this feature only works with relatively simple cases - ## such as `KEY: VALUE`, but won't properly work with - ## complex data structures like multilin array/lists or dictionnaries. - ## It also doesn't work with XML format, custom config function call, php define(), ... - - ## More info on TODO - # bind = ":/var/www/__APP__/settings.py" - - - ## By default, bind = ":FILENAME" will use the question ID as KEY - ## ... but the question ID may sometime not be the exact KEY name in the configuration file. - ## - ## In particular, in pepettes, the python variable is 'name' and not 'project_name' - ## (c.f. https://github.com/YunoHost-Apps/pepettes_ynh/blob/5cc2d3ffd6529cc7356ff93af92dbb6785c3ab9a/conf/settings.py##L11 ) - ## - ## In that case, the key name can be specified before the column ':' - - bind = "name:/var/www/__APP__/settings.py" - - ## --------------------------------------------------------------------- - ## IMPORTANT: other 'bind' mode exists: - ## - ## bind = "FILENAME" (with no column character before FILENAME) - ## may be used to bind to the **entire file content** (instead of a single KEY/VALUE) - ## This could be used to expose an entire configuration file, or binary files such as images - ## For example: - ## bind = "/var/www/__APP__/img/logo.png" - ## - ## bind = "null" can be used to disable reading / writing in settings. - ## This creates sort of a "virtual" or "ephemeral" question which is not related to any actual setting - ## In this mode, you are expected to define custom getter/setters/validators in scripts/config: - ## - ## getter: get__QUESTIONID() - ## setter: set__QUESTIONID() - ## validator: validate__QUESTIONID() - ## - ## You can also specify a common getter / setter / validator, with the - ## function 'bind' mode, for example here it will try to run - ## get__array_settings() first. - # bind = "array_settings()" - ## --------------------------------------------------------------------- - - ## --------------------------------------------------------------------- - ## IMPORTANT: with the exception of bind=null questions, - ## question IDs should almost **always** correspond to an app setting - ## initialized / reused during install/upgrade. - ## Not doing so may result in inconsistencies between the config panel mechanism - ## and the use of ynh_add_config - ## --------------------------------------------------------------------- - - ######################################################################## - #### OTHER GENERIC PROPERTY FOR QUESTIONS - ######################################################################## - - ## (optional) An help text for the question - help = "Fill the name of the project which will received donation" - - ## (optional) An example display as placeholder in web form - # example = "YunoHost" - - ## (optional) set to true in order to redact the value in operation logs - # redact = false - - ## (optional) A validation pattern - ## --------------------------------------------------------------------- - ## IMPORTANT: your pattern should be between simple quote, not double. - ## --------------------------------------------------------------------- - pattern.regexp = '^\w{3,30}$' - pattern.error = "The name should be at least 3 chars and less than 30 chars. Alphanumeric chars are accepted" - - ## Note: visible and optional properties are also available for questions - - - [main.customization.contact_url] - ask = "Contact url" - type = "url" - example = "mailto: contact@example.org" - help = "mailto: accepted" - pattern.regexp = '^mailto:[^@]+@[^@]+|https://$' - pattern.error = "Should be https or mailto:" - bind = ":/var/www/__APP__/settings.py" - - [main.customization.logo] - ask = "Logo" - type = "file" - accept = ".png" - help = "Fill with an already resized logo" - bind = "__FINALPATH__/img/logo.png" - - [main.customization.favicon] - ask = "Favicon" - type = "file" - accept = ".png" - help = "Fill with an already sized favicon" - bind = "__FINALPATH__/img/favicon.png" - - - [main.stripe] - name = "Stripe general info" - optional = false - - # The next alert is overwrited with a getter from the config script - [main.stripe.amount] - ask = "Donation in the month : XX € - type = "alert" - style = "success" - - [main.stripe.publishable_key] - ask = "Publishable key" - type = "string" - redact = true - help = "Indicate here the stripe publishable key" - bind = ":/var/www/__APP__/settings.py" - - [main.stripe.secret_key] - ask = "Secret key" - type = "string" - redact = true - help = "Indicate here the stripe secret key" - bind = ":/var/www/__APP__/settings.py" - - [main.stripe.prices] - ask = "Prices ID" - type = "tags" - help = """\ - Indicates here the prices ID of donation products you created in stripe interfaces. \ - Go on [Stripe products](https://dashboard.stripe.com/products) to create those donation products. \ - Fill it tag with 'FREQUENCY/CURRENCY/PRICE_ID' \ - FREQUENCY: 'one_time' or 'recuring' \ - CURRENCY: 'EUR' or 'USD' \ - PRICE_ID: ID from stripe interfaces starting with 'price_' \ - """ - pattern.regexp = '^(one_time|recuring)/(EUR|USD)/price_.*$' - pattern.error = "Please respect the format describe in help text for each price ID" From 6ab96fa0dde47c4a4a7ae9374084772a9cb9e35c Mon Sep 17 00:00:00 2001 From: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com> Date: Thu, 2 May 2024 02:02:49 +0200 Subject: [PATCH 10/13] Delete doc/.DS_Store --- doc/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 doc/.DS_Store diff --git a/doc/.DS_Store b/doc/.DS_Store deleted file mode 100644 index c90376b56b73b627c519d1a34c5d8c9abb7004dc..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKyG{c^3>-s>NNG}1?l15Mt0;UyegFv&DbPhqfch%Fi%(bFB<-Yt6!=#P*lfL7ulP#UTPH8)y|&RG>0a|qcjG!J4AG8> j(T=(Cc6=8_S=W5c^IkY62A%n!6ZJFTy2zx!wH5dQ#>Eyj From 3256d81a80a6f7590a3e21ad82a191a3b36345a0 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com> Date: Thu, 2 May 2024 02:02:58 +0200 Subject: [PATCH 11/13] Delete doc/.gitkeep --- doc/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 doc/.gitkeep diff --git a/doc/.gitkeep b/doc/.gitkeep deleted file mode 100644 index e69de29..0000000 From c7f47f914f729a07d37bd90a7fd1ca380db50fd4 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com> Date: Thu, 2 May 2024 02:03:26 +0200 Subject: [PATCH 12/13] Delete sources/patches/.gitignore --- sources/patches/.gitignore | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 sources/patches/.gitignore diff --git a/sources/patches/.gitignore b/sources/patches/.gitignore deleted file mode 100644 index 783a4ae..0000000 --- a/sources/patches/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -*~ -*.sw[op] From a4a861c6aec461029c41753843727f53b3a4cb0e Mon Sep 17 00:00:00 2001 From: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com> Date: Thu, 2 May 2024 02:03:38 +0200 Subject: [PATCH 13/13] Delete sources/extra_files directory --- sources/extra_files/app/.gitignore | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 sources/extra_files/app/.gitignore diff --git a/sources/extra_files/app/.gitignore b/sources/extra_files/app/.gitignore deleted file mode 100644 index 783a4ae..0000000 --- a/sources/extra_files/app/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -*~ -*.sw[op]