diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..77b7509 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# 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) diff --git a/README.md b/README.md index e6aa0ab..92c9ead 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install BookStack with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookstack) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README in other languages.](./ALL_README.md)* -> *This package allows you to install BookStack 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 BookStack 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 @@ -29,9 +29,9 @@ BookStack is an opinionated wiki system that provides a pleasant and simple out - Diagrams.net Integration -**Shipped version:** 24.02~ynh1 +**Shipped version:** 24.02.3~ynh1 -**Demo:** https://demo.bookstackapp.com +**Demo:** ## Screenshots @@ -39,23 +39,23 @@ BookStack is an opinionated wiki system that provides a pleasant and simple out ## Documentation and resources -* Official app website: -* Official user documentation: -* Official admin documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Official user documentation: +- Official admin documentation: +- 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/bookstack_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/bookstack_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/bookstack_ynh/tree/testing --debug or sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug ``` -**More info regarding app packaging:** \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..d565002 --- /dev/null +++ b/README_eu.md @@ -0,0 +1,61 @@ + + +# BookStack YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/bookstack.svg)](https://dash.yunohost.org/appci/app/bookstack) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/bookstack.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/bookstack.maintain.svg) + +[![Instalatu BookStack YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookstack) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek BookStack YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +BookStack is an opinionated wiki system that provides a pleasant and simple out of the box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it but they should not interfere with the core simple user experience. + +### Features + +- Multi-Factor Authentication +- Dark & Light Modes +- LDAP Authentication +- Markdown Editor +- WYSIWYG Editing +- Multi-Lingual +- Diagrams.net Integration + + +**Paketatutako bertsioa:** 24.02.3~ynh1 + +**Demoa:** + +## Pantaila-argazkiak + +![BookStack(r)en pantaila-argazkia](./doc/screenshots/screenshot.png) + +## Dokumentazioa eta baliabideak + +- Aplikazioaren webgune ofiziala: +- Erabiltzaileen dokumentazio ofiziala: +- Administratzaileen dokumentazio ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug +edo +sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index 1fcbe5c..ca9e1f4 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # BookStack pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer BookStack avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookstack) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer BookStack 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 BookStack 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 @@ -27,9 +27,9 @@ BookStack est un système wiki simple prête à l'emploi. Les nouveaux utilisate - Multilingue -**Version incluse :** 24.02~ynh1 +**Version incluse :** 24.02.3~ynh1 -**Démo :** https://demo.bookstackapp.com +**Démo :** ## Captures d’écran @@ -37,23 +37,23 @@ BookStack est un système wiki simple prête à l'emploi. Les nouveaux utilisate ## Documentations et ressources -* Site officiel de l’app : -* Documentation officielle utilisateur : -* Documentation officielle de l’admin : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Documentation officielle utilisateur : +- Documentation officielle de l’admin : +- 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/bookstack_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/bookstack_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/bookstack_ynh/tree/testing --debug ou sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_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..3279827 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,61 @@ + + +# BookStack para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/bookstack.svg)](https://dash.yunohost.org/appci/app/bookstack) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/bookstack.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/bookstack.maintain.svg) + +[![Instalar BookStack con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookstack) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar BookStack 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 + +BookStack is an opinionated wiki system that provides a pleasant and simple out of the box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it but they should not interfere with the core simple user experience. + +### Features + +- Multi-Factor Authentication +- Dark & Light Modes +- LDAP Authentication +- Markdown Editor +- WYSIWYG Editing +- Multi-Lingual +- Diagrams.net Integration + + +**Versión proporcionada:** 24.02.3~ynh1 + +**Demo:** + +## Capturas de pantalla + +![Captura de pantalla de BookStack](./doc/screenshots/screenshot.png) + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para usuarias: +- Documentación oficial para admin: +- 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/bookstack_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug +ou +sudo yunohost app upgrade bookstack -u https://github.com/YunoHost-Apps/bookstack_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/manifest.toml b/manifest.toml index ed4784e..f56efe6 100644 --- a/manifest.toml +++ b/manifest.toml @@ -5,9 +5,9 @@ name = "BookStack" description.en = "Platform to create documentation/wiki content" description.fr = "Plateforme pour créer du contenu de documentation/wiki" -version = "24.02~ynh1" +version = "24.02.3~ynh1" -maintainers = ["eric_G"] +maintainers = [] [upstream] license = "MIT" @@ -59,8 +59,8 @@ ram.runtime = "50M" [resources.sources] [resources.sources.main] - url = "https://github.com/BookStackApp/BookStack/archive/refs/tags/v24.02.tar.gz" - sha256 = "0832745f6c76ef8a21adebf21fef70e09ff063d484a5d25334ed8c034adeb0b2" + url = "https://github.com/BookStackApp/BookStack/archive/refs/tags/v24.02.3.tar.gz" + sha256 = "55e11562e550722bbbf923fc4b80f185213c033a297a16d2037b793c73464980" rename = "bookstack.tar.gz" autoupdate.strategy = "latest_github_release" diff --git a/scripts/upgrade b/scripts/upgrade index 5ca9964..e93adcf 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -47,7 +47,7 @@ then ynh_script_progression --message="Upgrading source files..." --weight=1 # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$install_dir" --keep=".env public/uploads storage/uploads" + ynh_setup_source --dest_dir="$install_dir" --full_replace=1 --keep=".env public/uploads storage/uploads" fi #=================================================