Merge pull request #38 from YunoHost-Apps/2021.11.04

2021.11.04

README.md

@@ -1,3 +1,8 @@
+<!--
+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.
+-->
+
 # YesWiki for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/yeswiki.svg)](https://dash.yunohost.org/appci/app/yeswiki) ![](https://ci-apps.yunohost.org/ci/badges/yeswiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yeswiki.maintain.svg)  
@@ -5,8 +10,8 @@
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allow you to install YesWiki quickly and simply on a YunoHost server.
+> *This package allows you to install YesWiki 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.*
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
 
 ## Overview
 
@@ -19,26 +24,16 @@ However, with a YesWiki we can build a website with multiple uses:
 - Communicate information flows
 - Cultivate a bit of freedom...
 
-**Shipped version:** Doryphore 2021-08-17-1
+
+**Shipped version:** 2021.11.04~ynh1
+
+**Demo:** https://ferme.yeswiki.net/?CreerSonWiki
 
 ## Screenshots
 
-![](/images/yeswiki_screenshots.png)
+![](./doc/screenshots/yeswiki_screenshots.png)
 
-## Demo
+## Disclaimers / important information
-
-* [Official demo](https://ferme.yeswiki.net/?CreerSonWiki)
-
-## Configuration
-
-Configure the application via YesWiki.
-
-## Documentation
-
-* Official documentation: https://yeswiki.net/?DocumentatioN
-* YunoHost documentation: If specific documentation is needed, feel free to contribute.
-
-## YunoHost specific features
 
 #### Multi-users support
 
@@ -46,36 +41,23 @@ LDAP integration is supported and required on new installs. It is possible to di
 
 At the moment SSO authentication is not supported. It is necessary to login on the wiki.
 
-#### Supported architectures
+## Documentation and resources
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/yeswiki.svg)](https://ci-apps.yunohost.org/ci/apps/yeswiki/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/yeswiki.svg)](https://ci-apps-arm.yunohost.org/ci/apps/yeswiki/)
-
-## Limitations
-
-* Any known limitations.
-
-## Additional information
-
-* Other information you would add about this application
-
-## Links
 
+* Official app website: https://yeswiki.net/
+* Official admin documentation: https://yeswiki.net/?DocumentatioN
+* Upstream app code repository: https://github.com/YesWiki/yeswiki
+* YunoHost documentation for this app: https://yunohost.org/app_yeswiki
 * Report a bug: https://github.com/YunoHost-Apps/yeswiki_ynh/issues
-* App website: https://yeswiki.net/?AccueiL
-* Upstream app repository: https://github.com/YesWiki/yeswiki
-* YunoHost website: https://yunohost.org/
 
----
+## Developer info
 
-## Developers info
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing).
-
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
-
 ```
 sudo yunohost app install https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade yeswiki -u https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -4,9 +4,10 @@
 [![Installer YesWiki avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yeswiki)
 
 *[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
 
 > *Ce package vous permet d'installer YesWiki 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.*
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
 
 ## Vue d'ensemble
 
@@ -19,26 +20,16 @@ Néanmoins, avec un YesWiki on peut fabriquer un site internet aux usages multip
 - Faire communiquer des flux d'informations
 - Cultiver un bout de liberté...
 
-**Version incluse :** Doryphore 2021-08-17-1
+
+**Version incluse :** 2021.11.04~ynh1
+
+**Démo :** https://ferme.yeswiki.net/?CreerSonWiki
 
 ## Captures d'écran
 
-![](/images/yeswiki_screenshots.png)
+![](./doc/screenshots/yeswiki_screenshots.png)
 
-## Démo
+## Avertissements / informations importantes
-
-* [Démo officielle](https://ferme.yeswiki.net/?CreerSonWiki)
-
-## Configuration
-
-Configurer l'application via YesWiki.
-
-## Documentation
-
- * Documentation officielle : https://yeswiki.net/?DocumentatioN
- * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
-
-## Caractéristiques spécifiques YunoHost
 
 #### Support multi-utilisateurs
 
@@ -46,27 +37,13 @@ L'intégration au LDAP est la seule méthode supportée pour les nouvelles insta
 
 Pour le moment l'authentification SSO n'est pas prise en charge. Il est nécessaire de se connecter sur le wiki.
 
-#### Architectures supportées
+## Documentations et ressources
 
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/yeswiki.svg)](https://ci-apps.yunohost.org/ci/apps/yeswiki/)
+* Site officiel de l'app : https://yeswiki.net/
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/yeswiki.svg)](https://ci-apps-arm.yunohost.org/ci/apps/yeswiki/)
+* Documentation officielle de l'admin : https://yeswiki.net/?DocumentatioN
-
+* Dépôt de code officiel de l'app : https://github.com/YesWiki/yeswiki
-## Limitations
+* Documentation YunoHost pour cette app : https://yunohost.org/app_yeswiki
-
+* Signaler un bug : https://github.com/YunoHost-Apps/yeswiki_ynh/issues
-* Limitations connues.
-
-## Informations additionnelles
-
-* Autres informations à ajouter sur cette application
-
-## Liens
-
- * Signaler un bug : https://github.com/YunoHost-Apps/yeswiki_ynh/issues
- * Site de l'application : https://yeswiki.net/?AccueiL
- * Dépôt de l'application principale : https://github.com/YesWiki/yeswiki
- * Site web YunoHost : https://yunohost.org/
-
----
 
 ## Informations pour les développeurs
 
@@ -78,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/yeswiki_ynh/tree/test
 ou
 sudo yunohost app upgrade yeswiki -u https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

check_process

@@ -6,8 +6,7 @@
 		admin="john"
 		language="fr"
 		is_public=1
-		password="password"
+		wiki_name="MyYunoHostWiki"
-		port="666"
 	; Actions
 		is_public=1|0
 	; Config_panel
@@ -27,7 +26,6 @@
 		upgrade=1	from_commit=792c90c592f52f8fb1a89c22ab9b73f1e0bc2a3d
 		backup_restore=1
 		multi_instance=1
-		port_already_use=1	(66)
 		change_url=1
 		actions=0
 		config_panel=0

conf/app.src

@@ -1,6 +1,6 @@
-SOURCE_URL=https://repository.yeswiki.net/doryphore/yeswiki-doryphore-2021-08-17-1.zip
+SOURCE_URL=https://repository.yeswiki.net/doryphore/yeswiki-doryphore-2021-11-04-6.zip
-SOURCE_SUM=289b31feeab29ff52e1dcd46f7c417224eef0464975399104b90077db8d6d016
+SOURCE_SUM=f29d30506c0e69e7c0cb1a8f0b4a63bb798039bdf3c92ee93138c9bf8ea00754
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=zip
 SOURCE_IN_SUBDIR=true
-SOURCE_FILENAME=yeswiki-doryphore-2021-08-17-1.zip
+SOURCE_FILENAME=yeswiki-doryphore-2021-11-04-6.zip

doc/DESCRIPTION.md

@@ -0,0 +1,8 @@
+YesWiki is a wiki designed to remain simple, very easy to install, in French translated into English, Spanish, Catalan, Flemish...
+
+However, with a YesWiki we can build a website with multiple uses:
+- Gather all the information of a project or a group (function of "central station")
+- Mapping members or places in a participatory way
+- Share resources, lists, calendars thanks to powerful cooperative databases
+- Communicate information flows
+- Cultivate a bit of freedom...

doc/DESCRIPTION_fr.md

@@ -0,0 +1,8 @@
+YesWiki est un wiki conçu pour rester simple, très facile à installer, en français traduit en anglais, espagnol, catalan, flamand...
+
+Néanmoins, avec un YesWiki on peut fabriquer un site internet aux usages multiples :
+- Rassembler toutes les infos d'un projet ou d'un groupe (fonction de "gare centrale")
+- Cartographier des membres ou des lieux de façon participative
+- Partager des ressources, des listes, des agendas grâce à des bases de données coopératives puissantes
+- Faire communiquer des flux d'informations
+- Cultiver un bout de liberté...

doc/DISCLAIMER.md

@@ -0,0 +1,5 @@
+#### Multi-users support
+
+LDAP integration is supported and required on new installs. It is possible to disable it on older installs by removing the loginldap plugin. **Warning: only do it if you know credentials for a wiki admin account**
+
+At the moment SSO authentication is not supported. It is necessary to login on the wiki.

doc/DISCLAIMER_fr.md

@@ -0,0 +1,5 @@
+#### Support multi-utilisateurs
+
+L'intégration au LDAP est la seule méthode supportée pour les nouvelles installations. Il est possible de la désactiver sur les anciennes installations en retirant l'extension loginldap. **Attention : Ne pas retirer l'extension sans connaitre d'identifiants administrateurs du wiki**
+
+Pour le moment l'authentification SSO n'est pas prise en charge. Il est nécessaire de se connecter sur le wiki.

manifest.json

@@ -3,11 +3,18 @@
     "id": "yeswiki",
     "packaging_format": 1,
     "description": {
-        "en": "Wiki that is quick and easy to use.",
+        "en": "Wiki that is quick and easy to use",
-        "fr": "Wiki facile et rapide à prendre en main."
+        "fr": "Wiki facile et rapide à prendre en main"
     },
-    "version": "2021-08-17-1~ynh1",
+    "version": "2021.11.04~ynh1",
     "url": "https://yeswiki.net/",
+        "upstream": {
+        "license": "AGPL-3.0-only",
+        "website": "https://yeswiki.net/",
+        "demo": "https://ferme.yeswiki.net/?CreerSonWiki",
+        "admindoc": "https://yeswiki.net/?DocumentatioN",
+        "code": "https://github.com/YesWiki/yeswiki"
+    },
     "license": "AGPL-3.0-only",
     "maintainer": [
         {
@@ -21,7 +28,7 @@
         }
     ],
     "requirements": {
-        "yunohost": ">= 4.1.7"
+        "yunohost": ">= 4.2.3"
     },
     "multi_instance": true,
     "services": [
@@ -33,8 +40,7 @@
         "install": [
             {
                 "name": "domain",
-                "type": "domain",
+                "type": "domain"
-                "example": "example.com"
             },
             {
                 "name": "path",
@@ -44,8 +50,7 @@
             },
             {
                 "name": "admin",
-                "type": "user",
+                "type": "user"
-                "example": "johndoe"
             },
             {
                 "name": "is_public",

scripts/backup

@@ -67,4 +67,4 @@ ynh_mysql_dump_db --database="$db_name" > db.sql
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info --message="Backup script completed for YesWiki. (YunoHost will then actually copy those files to the archive)."
+ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

scripts/change_url

@@ -96,8 +96,6 @@ fi
 #=================================================
 # SPECIFIC MODIFICATIONS
 #=================================================
-# ...
-#=================================================
 
 ynh_replace_string --match_string="https://$old_domain${old_path%/}" --replace_string="https://$new_domain${new_path%/}" --target_file="$final_path/wakka.config.php"
 
@@ -114,4 +112,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Change of URL completed for YesWiki" --last
+ynh_script_progression --message="Change of URL completed for $app" --last

scripts/install

@@ -66,6 +66,14 @@ db_user=$db_name
 ynh_app_setting_set --app=$app --key=db_name --value=$db_name
 ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
 
+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Configuring system user..." --weight=1
+
+# Create a system user
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@@ -83,14 +91,6 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=1
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..." --weight=1
-
-# Create a system user
-ynh_system_user_create --username=$app
-
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
@@ -193,4 +193,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Installation of YesWiki completed" --last
+ynh_script_progression --message="Installation of $app completed" --last

scripts/remove

@@ -70,4 +70,4 @@ ynh_system_user_delete --username=$app
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Removal of YesWiki completed" --last
+ynh_script_progression --message="Removal of $app completed" --last

scripts/restore

@@ -39,8 +39,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..." --weight=2
 
-ynh_webpath_available --domain=$domain --path_url=$path_url \
-	|| ynh_die --message="Path not available: ${domain}${path_url}"
 test ! -d $final_path \
 	|| ynh_die --message="There is already a directory: $final_path "
 
@@ -52,20 +50,20 @@ test ! -d $final_path \
 
 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
-#=================================================
-# RESTORE THE APP MAIN DIR
-#=================================================
-ynh_script_progression --message="Restoring YesWiki main directory..." --weight=2
-
-ynh_restore_file --origin_path="$final_path"
-
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
 ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
 
 # Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
+#=================================================
+# RESTORE THE APP MAIN DIR
+#=================================================
+ynh_script_progression --message="Restoring YesWiki main directory..." --weight=2
+
+ynh_restore_file --origin_path="$final_path"
 
 #=================================================
 # RESTORE USER RIGHTS
@@ -112,4 +110,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Restoration completed for YesWiki" --last
+ynh_script_progression --message="Restoration completed for $app" --last

scripts/upgrade

@@ -30,6 +30,20 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 upgrade_type=$(ynh_check_app_version_changed)
 
+#=================================================
+# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+#=================================================
+ynh_script_progression --message="Backing up YesWiki before upgrading (may take a while)..." --weight=6
+
+# Backup the current version of the app
+ynh_backup_before_upgrade
+ynh_clean_setup () {
+	# restore it if the upgrade fails
+	ynh_restore_upgradebackup
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
@@ -55,18 +69,12 @@ if ynh_legacy_permissions_exists; then
 fi
 
 #=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+# CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Backing up YesWiki before upgrading (may take a while)..." --weight=6
+ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
 
-# Backup the current version of the app
+# Create a dedicated user (if not existing)
-ynh_backup_before_upgrade
+ynh_system_user_create --username=$app --home_dir="$final_path"
-ynh_clean_setup () {
-	# restore it if the upgrade fails
-	ynh_restore_upgradebackup
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
 
 #=================================================
 # STANDARD UPGRADE STEPS
@@ -124,14 +132,6 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." -
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
-
-# Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app
-
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
@@ -164,4 +164,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Upgrade of YesWiki completed" --last
+ynh_script_progression --message="Upgrade of $app completed" --last