Merge pull request #11 from YunoHost-Apps/example

Example
2024-09-03 19:56:23 +02:00 · 2022-03-14 20:23:17 +01:00 · 2022-03-14 20:23:17 +01:00 · 15758c1f96
commit 15758c1f96
parent f51c70d762 e5e4bbab54
12 changed files with 74 additions and 68 deletions
--- a/README.md
+++ b/README.md
@ -1,64 +1,31 @@
-# PHPinfo for YunoHost
+<!--
+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.
+-->
+
+# Phpinfo for YunoHost

 [![Integration level](https://dash.yunohost.org/integration/phpinfo.svg)](https://dash.yunohost.org/appci/app/phpinfo) ![](https://ci-apps.yunohost.org/ci/badges/phpinfo.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpinfo.maintain.svg)  
-[![Install PHPinfo with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpinfo)
+[![Install Phpinfo with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpinfo)

-> *This package allows you to install PHPinfo quickly and simply on a YunoHost server.  
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install Phpinfo 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
-Quick description of this app.

-**Shipped version:** 1.0
+Simple phpinfo

-## Screenshots
+**Shipped version:** 1.0~ynh3

-![](Link to a screenshot of this app.)

-## Demo

-* [Official demo](Link to a demo site for this app.)
+## Documentation and resources

-## Configuration
-
-How to configure this app: From an admin panel, a plain file with SSH, or any other way.
-
-## Documentation
-
- * Official documentation: Link to the official documentation of this app
- * YunoHost documentation: If specific documentation is needed, feel free to contribute.
-
-## YunoHost specific features
-
-#### Multi-user support
-
-* Are LDAP and HTTP auth supported?
-* Can the app be used by multiple users?
-
-#### Supported architectures
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/phpinfo%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/phpinfo/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/phpinfo%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/phpinfo/)
-
-## Limitations
-
-* Any known limitations.
-
-## Additional information
-
-* Other info you would like to add about this app.
-
-**More info on the documentation page:**  
-https://yunohost.org/packaging_apps
-
-## Links
-
- * Report a bug: https://github.com/YunoHost-Apps/phpinfo_ynh/issues
- * App website: Link to the official website of this app.
- * Upstream app repository: Link to the official repository of the upstream app.
- * YunoHost website: https://yunohost.org/
-
---
+* Official app website: https://www.php.net/manual/fr/function.phpinfo.php
+* YunoHost documentation for this app: https://yunohost.org/app_phpinfo
+* Report a bug: https://github.com/YunoHost-Apps/phpinfo_ynh/issues

 ## Developer info

@ -70,3 +37,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/phpinfo_ynh/tree/test
 or
 sudo yunohost app upgrade phpinfo -u https://github.com/YunoHost-Apps/phpinfo_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps
--- a/README_fr.md
+++ b/README_fr.md
@ -0,0 +1,37 @@
+# Phpinfo pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/phpinfo.svg)](https://dash.yunohost.org/appci/app/phpinfo) ![](https://ci-apps.yunohost.org/ci/badges/phpinfo.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpinfo.maintain.svg)  
+[![Installer Phpinfo avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpinfo)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Phpinfo 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.*
+
+## Vue d'ensemble
+
+Simple phpinfo
+
+**Version incluse :** 1.0~ynh3
+
+
+
+## Documentations et ressources
+
+* Site officiel de l'app : https://www.php.net/manual/fr/function.phpinfo.php
+* Documentation YunoHost pour cette app : https://yunohost.org/app_phpinfo
+* Signaler un bug : https://github.com/YunoHost-Apps/phpinfo_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/phpinfo_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/phpinfo_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade phpinfo -u https://github.com/YunoHost-Apps/phpinfo_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
--- 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/doc/.gitkeep
+++ b/doc/.gitkeep
--- a/doc/DESCRIPTION.md
+++ b/doc/DESCRIPTION.md
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
--- a/doc/screenshots/.gitkeep
+++ b/doc/screenshots/.gitkeep
--- a/manifest.json
+++ b/manifest.json
@ -6,15 +6,19 @@
        "en": "Simple phpinfo",
        "fr": "Simple phpinfo"
    },
-    "version": "1.0~ynh2",
+    "version": "1.0~ynh3",
    "url": "https://www.php.net/manual/fr/function.phpinfo.php",
+    "upstream": {
+        "license": "GPL-3.0-or-later",
+        "website": "https://www.php.net/manual/fr/function.phpinfo.php"
+    },
    "license": "GPL-3.0-or-later",
    "maintainer": {
 		"name": "Maniack Crudelis",
 		"email": "maniackc_dev@crudelis.fr"
    },
    "requirements": {
-        "yunohost": ">= 4.2.8"
+        "yunohost": ">= 4.3.0"
    },
    "multi_instance": true,
    "services": [
--- a/scripts/install
+++ b/scripts/install
@ -75,7 +75,7 @@ chown -R $app:www-data "$final_path"
 #=================================================
 ynh_script_progression --message="Configuring NGINX web server..."

-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config

 #=================================================
@ -83,7 +83,7 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Configuring PHP-FPM..."

-# Create a dedicated php-fpm config
+# Create a dedicated PHP-FPM config
 ynh_add_fpm_config --usage=low --footprint=low

 #=================================================
--- a/scripts/remove
+++ b/scripts/remove
@ -34,7 +34,7 @@ ynh_secure_remove --file="$final_path"
 #=================================================
 ynh_script_progression --message="Removing NGINX web server configuration..."

-# Remove the dedicated nginx config
+# Remove the dedicated NGINX config
 ynh_remove_nginx_config

 #=================================================
@ -42,7 +42,7 @@ ynh_remove_nginx_config
 #=================================================
 ynh_script_progression --message="Removing PHP-FPM configuration..."

-# Remove the dedicated php-fpm config
+# Remove the dedicated PHP-FPM config
 ynh_remove_fpm_config

 #=================================================
--- a/scripts/restore
+++ b/scripts/restore
@ -20,7 +20,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading settings..."
+ynh_script_progression --message="Loading installation settings..."

 app=$YNH_APP_INSTANCE_NAME

@ -42,7 +42,7 @@ test ! -d $final_path \
 #=================================================
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Restoring the NGINX configuration..."
+ynh_script_progression --message="Restoring the NGINX web server configuration..."

 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"

@ -68,7 +68,7 @@ chown -R $app:www-data "$final_path"
 #=================================================
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Restoring PHP-FPM configuration..."
+ynh_script_progression --message="Restoring the PHP-FPM configuration..."

 # Recreate a dedicated php-fpm config
 ynh_add_fpm_config --usage=low --footprint=low
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -24,6 +24,7 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 #=================================================
 # CHECK VERSION
 #=================================================
+ynh_script_progression --message="Checking version..."

 upgrade_type=$(ynh_check_app_version_changed)

@ -35,12 +36,14 @@ ynh_script_progression --message="Backing up the app before upgrading (may take
 # Backup the current version of the app
 ynh_backup_before_upgrade
 ynh_clean_setup () {
-	# restore it if the upgrade fails
+	# 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
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
@ -49,8 +52,6 @@ ynh_script_progression --message="Making sure dedicated system user exists..."
 # Create a dedicated user (if not existing)
 ynh_system_user_create --username=$app --home_dir="$final_path"

-#=================================================
-# STANDARD UPGRADE STEPS
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@ -72,7 +73,7 @@ chown -R $app:www-data "$final_path"
 #=================================================
 ynh_script_progression --message="Upgrading NGINX web server configuration..."

-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config

 #=================================================
@ -80,7 +81,7 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Upgrading PHP-FPM configuration..."

-# Create a dedicated php-fpm config
+# Create a dedicated PHP-FPM config
 ynh_add_fpm_config --usage=low --footprint=low

 #=================================================