Merge pull request #52 from YunoHost-Apps/example

Example
2024-09-03 18:26:29 +02:00 · 2022-05-31 08:21:09 +02:00 · 2022-05-31 08:21:09 +02:00 · 17a0c8f71f
commit 17a0c8f71f
parent 27a03d5ad2 a73d519f41
9 changed files with 42 additions and 43 deletions
--- a/README.md
+++ b/README.md
@ -5,7 +5,7 @@ It shall NOT be edited by hand.

 # DotClear 2 for YunoHost

-[![Integration level](https://dash.yunohost.org/integration/dotclear2.svg)](https://dash.yunohost.org/appci/app/dotclear2) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/dotclear2.svg)](https://dash.yunohost.org/appci/app/dotclear2) ![Working status](https://ci-apps.yunohost.org/ci/badges/dotclear2.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/dotclear2.maintain.svg)  
 [![Install DotClear 2 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=dotclear2)

 *[Lire ce readme en français.](./README_fr.md)*
@ -23,7 +23,7 @@ Blog publishing application

 ## Screenshots

-![](./doc/screenshots/ss2_dotclear.png)
+![Screenshot of DotClear 2](./doc/screenshots/ss2_dotclear.png)

 ## Disclaimers / important information

@ -39,21 +39,22 @@ Can the app be used by multiple users? **Yes**

 ## Documentation and resources

-* Official app website: https://dotclear.org
-* Official admin documentation: https://dotclear.org/documentation/2.0
-* Upstream app code repository: https://git.dotclear.org/dev/dotclear
-* YunoHost documentation for this app: https://yunohost.org/app_dotclear2
-* Report a bug: https://github.com/YunoHost-Apps/dotclear2_ynh/issues
+* Official app website: <https://dotclear.org>
+* Official admin documentation: <https://dotclear.org/documentation/2.0>
+* Upstream app code repository: <https://git.dotclear.org/dev/dotclear>
+* YunoHost documentation for this app: <https://yunohost.org/app_dotclear2>
+* Report a bug: <https://github.com/YunoHost-Apps/dotclear2_ynh/issues>

 ## Developer info

 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing).

 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade dotclear2 -u https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing --debug
 ```

-**More info regarding app packaging:** https://yunohost.org/packaging_apps
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
--- a/README_fr.md
+++ b/README_fr.md
@ -1,10 +1,14 @@
+<!--
+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.
+-->
+
 # DotClear 2 pour YunoHost

-[![Niveau d'intégration](https://dash.yunohost.org/integration/dotclear2.svg)](https://dash.yunohost.org/appci/app/dotclear2) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/dotclear2.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/dotclear2.svg)](https://dash.yunohost.org/appci/app/dotclear2) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/dotclear2.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/dotclear2.maintain.svg)  
 [![Installer DotClear 2 avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=dotclear2)

 *[Read this readme in english.](./README.md)*
-*[Lire ce readme en français.](./README_fr.md)*

 > *Ce package vous permet d'installer DotClear 2 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.*
@ -19,7 +23,7 @@ Moteur de blog

 ## Captures d'écran

-![](./doc/screenshots/ss2_dotclear.png)
+![Capture d'écran de DotClear 2](./doc/screenshots/ss2_dotclear.png)

 ## Avertissements / informations importantes

@ -35,21 +39,22 @@ Can the app be used by multiple users? **Yes**

 ## Documentations et ressources

-* Site officiel de l'app : https://dotclear.org
-* Documentation officielle de l'admin : https://dotclear.org/documentation/2.0
-* Dépôt de code officiel de l'app : https://git.dotclear.org/dev/dotclear
-* Documentation YunoHost pour cette app : https://yunohost.org/app_dotclear2
-* Signaler un bug : https://github.com/YunoHost-Apps/dotclear2_ynh/issues
+* Site officiel de l'app : <https://dotclear.org>
+* Documentation officielle de l'admin : <https://dotclear.org/documentation/2.0>
+* Dépôt de code officiel de l'app : <https://git.dotclear.org/dev/dotclear>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_dotclear2>
+* Signaler un bug : <https://github.com/YunoHost-Apps/dotclear2_ynh/issues>

 ## Informations pour les développeurs

 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing).

 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade dotclear2 -u https://github.com/YunoHost-Apps/dotclear2_ynh/tree/testing --debug
 ```

-**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
+**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
--- a/2
+++ b/2
@ -2,8 +2,8 @@
 	; Manifest
 		domain="domain.tld"
 		path="/path"
-		admin="john"
 		is_public=1
+		admin="john"
 	; Checks
 		pkg_linter=1
 		setup_sub_dir=1
--- a/conf/app.src
+++ b/conf/app.src
@ -1,7 +1,7 @@
-SOURCE_URL=http://download.dotclear.org/latest/dotclear-2.22.tar.gz
-SOURCE_SUM=0f704078c5c35e70b96d15ca44ace5bc1566b252adc37d2642d7bdd7c9d1a76c
+SOURCE_URL=https://download.dotclear.org/latest/dotclear-2.22.zip
+SOURCE_SUM=94895d2479654c233f9b269a007ebb36bcf8cba34f4c1071424957f79b90ad6f
 SOURCE_SUM_PRG=sha256sum
-SOURCE_FORMAT=tar.gz
+SOURCE_FORMAT=zip
 SOURCE_IN_SUBDIR=true
 SOURCE_FILENAME=
 SOURCE_EXTRACT=true
--- a/conf/nginx.conf
+++ b/conf/nginx.conf
@ -4,11 +4,6 @@ location __PATH__/ {
  # Path to source
  alias __FINALPATH__/ ;

-  # Force usage of https
-  if ($scheme = http) {
-    rewrite ^ https://$server_name$request_uri? permanent;
-  }
-
  index index.php;

  # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file
--- a/manifest.json
+++ b/manifest.json
@ -7,7 +7,6 @@
        "fr": "Moteur de blog"
    },
    "version": "2.22~ynh1",
-    "license": "GPL-2.0-or-later",
    "url": "https://dotclear.org/",
    "upstream": {
        "license": "GPL-2.0-or-later",
@ -16,6 +15,7 @@
        "admindoc": "https://dotclear.org/documentation/2.0",
        "code": "https://git.dotclear.org/dev/dotclear"
    },
+    "license": "GPL-2.0-or-later",
    "maintainer": {
        "name": "kay0u",
        "email": "pierre@kayou.io"
@ -33,8 +33,7 @@
        "install": [
            {
                "name": "domain",
-                "type": "domain",
-                "example": "example.com"
+                "type": "domain"
            },
            {
                "name": "path",
@ -42,15 +41,14 @@
                "example": "/dotclear2",
                "default": "/dotclear2"
            },
-            {
-                "name": "admin",
-                "type": "user",
-                "example": "johndoe"
-            },
            {
                "name": "is_public",
                "type": "boolean",
                "default": true
+            },
+            {
+                "name": "admin",
+                "type": "user"
            }
        ]
    }
--- a/scripts/install
+++ b/scripts/install
@ -53,7 +53,7 @@ ynh_app_setting_set --app=$app --key=admin --value=$admin
 ynh_script_progression --message="Configuring system user..." --weight=2

 # Create a system user
-ynh_system_user_create --username=$app --home_dir=$final_path
+ynh_system_user_create --username=$app --home_dir="$final_path"

 #=================================================
 # CREATE A MYSQL DATABASE
@ -64,7 +64,6 @@ db_name=$(ynh_sanitize_dbid --db_name=$app)
 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
-
 db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)

 #=================================================
@ -107,6 +106,8 @@ ynh_script_progression --message="Configuring PHP-FPM..." --weight=2
 # Create a dedicated PHP-FPM config
 ynh_add_fpm_config

+#=================================================
+# SPECIFIC SETUP
 #=================================================
 # ADD A CONFIGURATION
 #=================================================
@ -171,6 +172,7 @@ chown $app:$app "$php_config"
 #=================================================
 # SETUP APPLICATION WITH CURL
 #=================================================
+ynh_script_progression --message="Setuping application with CURL..."

 # Set the app as temporarily public for curl call
 ynh_script_progression --message="Configuring SSOwat..."
--- a/scripts/remove
+++ b/scripts/remove
@ -58,7 +58,7 @@ ynh_remove_fpm_config
 #=================================================
 # REMOVE FAIL2BAN CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing Fail2ban configuration..."
+ynh_script_progression --message="Removing Fail2Ban configuration..."

 # Remove the dedicated Fail2Ban config
 ynh_remove_fail2ban_config
--- a/scripts/restore
+++ b/scripts/restore
@ -36,8 +36,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..."

-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 "

@ -56,7 +54,7 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 ynh_script_progression --message="Recreating the dedicated system user..." --weight=2

 # Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir=$final_path
+ynh_system_user_create --username=$app --home_dir="$final_path"

 #=================================================
 # RESTORE THE APP MAIN DIR