From e9bb0aa28d9bc149508f5a0ee15aea92fe520646 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 16 Oct 2022 20:26:47 +0200 Subject: [PATCH 1/4] Apply last example_ynh --- .gitattributes | 17 ---------------- .gitignore | 47 ------------------------------------------- check_process | 2 ++ conf/app.src | 1 + conf/nginx.conf | 2 -- doc/DESCRIPTION_fr.md | 7 +++++++ manifest.json | 4 ++-- scripts/_common.sh | 8 ++++++-- scripts/backup | 3 +-- scripts/change_url | 4 +++- scripts/install | 17 ++++++++-------- scripts/remove | 6 ++++-- scripts/restore | 31 ++++++++++++++-------------- scripts/upgrade | 28 +++++++++++++++++--------- 14 files changed, 69 insertions(+), 108 deletions(-) delete mode 100644 .gitattributes delete mode 100644 .gitignore create mode 100644 doc/DESCRIPTION_fr.md diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index bdb0cab..0000000 --- a/.gitattributes +++ /dev/null @@ -1,17 +0,0 @@ -# Auto detect text files and perform LF normalization -* text=auto - -# Custom for Visual Studio -*.cs diff=csharp - -# Standard to msysgit -*.doc diff=astextplain -*.DOC diff=astextplain -*.docx diff=astextplain -*.DOCX diff=astextplain -*.dot diff=astextplain -*.DOT diff=astextplain -*.pdf diff=astextplain -*.PDF diff=astextplain -*.rtf diff=astextplain -*.RTF diff=astextplain diff --git a/.gitignore b/.gitignore deleted file mode 100644 index cd2946a..0000000 --- a/.gitignore +++ /dev/null @@ -1,47 +0,0 @@ -# Windows image file caches -Thumbs.db -ehthumbs.db - -# Folder config file -Desktop.ini - -# Recycle Bin used on file shares -$RECYCLE.BIN/ - -# Windows Installer files -*.cab -*.msi -*.msm -*.msp - -# Windows shortcuts -*.lnk - -# ========================= -# Operating System Files -# ========================= - -# OSX -# ========================= - -.DS_Store -.AppleDouble -.LSOverride - -# Thumbnails -._* - -# Files that might appear in the root of a volume -.DocumentRevisions-V100 -.fseventsd -.Spotlight-V100 -.TemporaryItems -.Trashes -.VolumeIcon.icns - -# Directories potentially created on remote AFP share -.AppleDB -.AppleDesktop -Network Trash Folder -Temporary Items -.apdisk diff --git a/check_process b/check_process index c587673..38c40ba 100644 --- a/check_process +++ b/check_process @@ -12,6 +12,8 @@ setup_public=1 upgrade=1 upgrade=1 from_commit=73f74039fb63adc555222d73ded6b43a64d41456 + # 0.30.0~ynh3 + upgrade=1 from_commit=af190a49ec43b470a38b21d81887a1b457b333fa backup_restore=1 multi_instance=0 change_url=1 diff --git a/conf/app.src b/conf/app.src index 2c6471e..46c7310 100644 --- a/conf/app.src +++ b/conf/app.src @@ -4,3 +4,4 @@ SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=zip SOURCE_IN_SUBDIR=false SOURCE_FILENAME=h5ai.zip +SOURCE_EXTRACT=true diff --git a/conf/nginx.conf b/conf/nginx.conf index c169ca5..ce361ca 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -4,7 +4,6 @@ location __PATH__/ { # Path to source alias __FINALPATH__/; -### Example PHP configuration (remove it if not used) index index.php __PATH__/_h5ai/public/index.php; # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file @@ -24,7 +23,6 @@ location __PATH__/ { fastcgi_param PATH_INFO $fastcgi_path_info; fastcgi_param SCRIPT_FILENAME $request_filename; } -### End of PHP configuration part # Include SSOWAT user panel. include conf.d/yunohost_panel.conf.inc; diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..2b7a432 --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1,7 @@ +h5ai est un indexeur de fichiers moderne pour les serveurs web HTTP avec un focus sur vos fichiers. Les répertoires sont affichés de manière attrayante et leur navigation est améliorée par différentes vues, un fil d'Ariane et une arborescence. + +### Caractéristiques + +Il y a beaucoup d'extensions optionnelles et d'options de configuration pour personnaliser l'apparence web de vos listes de répertoire. Tout le balisage est du HTML5 valide, agrémenté de CSS3 et du JavaScript le plus fin pour construire + +Parmi les fonctionnalités optionnelles, citons : le tri des fichiers, différents modes d'affichage, la localisation, le fil d'Ariane, l'arborescence, les en-têtes et pieds de page personnalisés, le filtrage et la recherche de fichiers, la taille des dossiers, le rafraîchissement automatique, l'emballage... diff --git a/manifest.json b/manifest.json index 61f1449..9639936 100644 --- a/manifest.json +++ b/manifest.json @@ -11,9 +11,9 @@ "upstream": { "license": "MIT", "website": "https://larsjung.de/h5ai/", + "demo": "https://larsjung.de/h5ai/demo/", "admindoc": "https://larsjung.de/h5ai/", - "code": "https://github.com/lrsjng/h5ai", - "demo": "https://larsjung.de/h5ai/demo/" + "code": "https://github.com/lrsjng/h5ai" }, "license": "MIT", "maintainer": { diff --git a/scripts/_common.sh b/scripts/_common.sh index 6fb7135..d311fd0 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -3,11 +3,15 @@ #================================================= # COMMON VARIABLES #================================================= +# PHP APP SPECIFIC +#================================================= YNH_PHP_VERSION=7.4 -# dependencies used by the app -pkg_dependencies="php$YNH_PHP_VERSION-fpm ffmpeg imagemagick" +php_dependencies="php$YNH_PHP_VERSION-fpm" + +# dependencies used by the app (must be on a single line) +pkg_dependencies="ffmpeg imagemagick $php_dependencies" #================================================= # PERSONAL HELPERS diff --git a/scripts/backup b/scripts/backup index 8a882cb..e0a77d8 100644 --- a/scripts/backup +++ b/scripts/backup @@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. true } # Exit if an error occurs during the execution of the script @@ -24,7 +23,7 @@ ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_print_info --message="Loading installation settings..." +ynh_print_info --message="Loading settings..." app=$YNH_APP_INSTANCE_NAME diff --git a/scripts/change_url b/scripts/change_url index 7d347e3..fa8736a 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -24,7 +24,7 @@ app=$YNH_APP_INSTANCE_NAME #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +ynh_script_progression --message="Loading settings..." --weight=1 # Needed for helper "ynh_add_nginx_config" final_path=$(ynh_app_setting_get --app=$app --key=final_path) @@ -91,6 +91,8 @@ then ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" fi +#================================================= +# GENERIC FINALISATION #================================================= # RELOAD NGINX #================================================= diff --git a/scripts/install b/scripts/install index 5c2c8b7..83d2112 100644 --- a/scripts/install +++ b/scripts/install @@ -14,7 +14,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. true } # Exit if an error occurs during the execution of the script @@ -82,6 +81,14 @@ chmod 750 "$final_path" chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" +#================================================= +# PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Configuring PHP-FPM..." --weight=1 + +# Create a dedicated PHP-FPM config +ynh_add_fpm_config + #================================================= # NGINX CONFIGURATION #================================================= @@ -91,13 +98,7 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=1 ynh_add_nginx_config #================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring PHP-FPM..." --weight=1 - -# Create a dedicated PHP-FPM config -ynh_add_fpm_config - +# GENERIC FINALIZATION #================================================= # SETUP SSOWAT #================================================= diff --git a/scripts/remove b/scripts/remove index 3dedba8..b192533 100644 --- a/scripts/remove +++ b/scripts/remove @@ -12,13 +12,15 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +ynh_script_progression --message="Loading settings..." --weight=1 app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) final_path=$(ynh_app_setting_get --app=$app --key=final_path) +#================================================= +# STANDARD REMOVE #================================================= # REMOVE APP MAIN DIR #================================================= @@ -30,7 +32,7 @@ ynh_secure_remove --file="$final_path/_h5ai" # Remove the data directory if --purge option is used if [ "${YNH_APP_PURGE:-0}" -eq 1 ] then - ynh_secure_remove --file="$final_path" + ynh_secure_remove --file="$final_path" fi #================================================= diff --git a/scripts/restore b/scripts/restore index 813cb0f..d6afdf1 100644 --- a/scripts/restore +++ b/scripts/restore @@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - #### Remove this function if there's nothing to clean before calling the remove script. true } # Exit if an error occurs during the execution of the script @@ -24,7 +23,7 @@ ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +ynh_script_progression --message="Loading settings..." --weight=1 app=$YNH_APP_INSTANCE_NAME @@ -42,13 +41,6 @@ test ! -d $final_path \ #================================================= # STANDARD RESTORATION STEPS -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1 - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" - #================================================= # RECREATE THE DEDICATED USER #================================================= @@ -68,13 +60,6 @@ chmod 750 "$final_path" chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" -#================================================= -# RESTORE THE PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weight=1 - -ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" - #================================================= # SPECIFIC RESTORATION #================================================= @@ -85,6 +70,20 @@ ynh_script_progression --message="Reinstalling dependencies..." --weight=1 # Define and install dependencies ynh_install_app_dependencies $pkg_dependencies +#================================================= +# RESTORE THE PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weight=1 + +ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" + +#================================================= +# RESTORE THE NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1 + +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" + #================================================= # GENERIC FINALIZATION #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index af7a987..1f834e7 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,7 +12,7 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +ynh_script_progression --message="Loading settings..." --weight=1 app=$YNH_APP_INSTANCE_NAME if [[ "$path_url" != "/" ]] @@ -30,6 +30,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= # CHECK VERSION #================================================= +ynh_script_progression --message="Checking version..." --weight=1 upgrade_type=$(ynh_check_app_version_changed) @@ -47,6 +48,13 @@ ynh_clean_setup () { # Exit if an error occurs during the execution of the script ynh_abort_if_errors +#================================================= +# STANDARD UPGRADE STEPS +#================================================= +# ENSURE DOWNWARD COMPATIBILITY +#================================================= +ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 + #================================================= # CREATE DEDICATED USER #================================================= @@ -71,14 +79,6 @@ chmod 750 "$final_path" chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1 - -# Create a dedicated NGINX config -ynh_add_nginx_config - #================================================= # UPGRADE DEPENDENCIES #================================================= @@ -94,6 +94,16 @@ ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=1 # Create a dedicated PHP-FPM config ynh_add_fpm_config +#================================================= +# NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1 + +# Create a dedicated NGINX config +ynh_add_nginx_config + +#================================================= +# GENERIC FINALIZATION #================================================= # RELOAD NGINX #================================================= From a2956d8587680f6d7e30c27c9740e9f0d253edd5 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 16 Oct 2022 18:26:54 +0000 Subject: [PATCH 2/4] Auto-update README --- README.md | 31 ++++++++++++++++++++----------- README_fr.md | 37 +++++++++++++++++++++++++------------ 2 files changed, 45 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 0d41372..7cd4f9b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # h5ai for YunoHost -[![Integration level](https://dash.yunohost.org/integration/h5ai.svg)](https://dash.yunohost.org/appci/app/h5ai) ![](https://ci-apps.yunohost.org/ci/badges/h5ai.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/h5ai.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/h5ai.svg)](https://dash.yunohost.org/appci/app/h5ai) ![Working status](https://ci-apps.yunohost.org/ci/badges/h5ai.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/h5ai.maintain.svg) [![Install h5ai with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=h5ai) *[Lire ce readme en français.](./README_fr.md)* @@ -15,15 +15,23 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Modern HTTP web server index for NGINX +h5ai is a modern file indexer for HTTP web servers with focus on your files. Directories are displayed in a appealing way and browsing them is enhanced by different views, a breadcrumb and a tree overview. + +### Features + +There are lots of optional extensions and configuration options to customize the web appearance of your directory listings. All markup is valid HTML5 spiced up with CSS3 and finest JavaScript to build a fresh but minimal user interface and a user experience that focuses on your files. + +Some of the optional features are: file sorting, different view modes, localization, a breadcrumb, a tree view, custom headers and footers, file filter and search, folder sizes, auto refresh, packaged download, QR codes, thumbnails, file previews + **Shipped version:** 0.30.0~ynh3 - +**Demo:** https://larsjung.de/h5ai/demo/ ## Screenshots -![](./doc/screenshots/screenshot.jpg) +![Screenshot of h5ai](./doc/screenshots/screenshot.jpg) +![Screenshot of h5ai](./doc/screenshots/h5ai-1024x540.png) ## Disclaimers / important information @@ -35,21 +43,22 @@ The main configuration file is `_h5ai/private/conf/options.json`. You might want ## Documentation and resources -* Official app website: https://larsjung.de/h5ai/ -* Official admin documentation: https://larsjung.de/h5ai/ -* Upstream app code repository: https://github.com/lrsjng/h5ai -* YunoHost documentation for this app: https://yunohost.org/app_h5ai -* Report a bug: https://github.com/YunoHost-Apps/h5ai_ynh/issues +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug or sudo yunohost app upgrade h5ai -u https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 0eea75c..8ccd7f7 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,25 +1,37 @@ + + # h5ai pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/h5ai.svg)](https://dash.yunohost.org/appci/app/h5ai) ![](https://ci-apps.yunohost.org/ci/badges/h5ai.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/h5ai.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/h5ai.svg)](https://dash.yunohost.org/appci/app/h5ai) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/h5ai.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/h5ai.maintain.svg) [![Installer h5ai avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=h5ai) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer h5ai 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 -Serveur moderne d'index pour NGINX +h5ai est un indexeur de fichiers moderne pour les serveurs web HTTP avec un focus sur vos fichiers. Les répertoires sont affichés de manière attrayante et leur navigation est améliorée par différentes vues, un fil d'Ariane et une arborescence. + +### Caractéristiques + +Il y a beaucoup d'extensions optionnelles et d'options de configuration pour personnaliser l'apparence web de vos listes de répertoire. Tout le balisage est du HTML5 valide, agrémenté de CSS3 et du JavaScript le plus fin pour construire + +Parmi les fonctionnalités optionnelles, citons : le tri des fichiers, différents modes d'affichage, la localisation, le fil d'Ariane, l'arborescence, les en-têtes et pieds de page personnalisés, le filtrage et la recherche de fichiers, la taille des dossiers, le rafraîchissement automatique, l'emballage... + **Version incluse :** 0.30.0~ynh3 - +**Démo :** https://larsjung.de/h5ai/demo/ ## Captures d'écran -![](./doc/screenshots/screenshot.jpg) +![Capture d'écran de h5ai](./doc/screenshots/screenshot.jpg) +![Capture d'écran de h5ai](./doc/screenshots/h5ai-1024x540.png) ## Avertissements / informations importantes @@ -31,21 +43,22 @@ Le fichier de configuration principal est `_h5ai / private / conf / options.json ## Documentations et ressources -* Site officiel de l'app : https://larsjung.de/h5ai/ -* Documentation officielle de l'admin : https://larsjung.de/h5ai/ -* Dépôt de code officiel de l'app : https://github.com/lrsjng/h5ai -* Documentation YunoHost pour cette app : https://yunohost.org/app_h5ai -* Signaler un bug : https://github.com/YunoHost-Apps/h5ai_ynh/issues +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug ou sudo yunohost app upgrade h5ai -u https://github.com/YunoHost-Apps/h5ai_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :** From d47757837d4358be5917230e908c34b020497ff2 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 16 Oct 2022 18:30:09 +0000 Subject: [PATCH 3/4] Auto-update README --- README_fr.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README_fr.md b/README_fr.md index a8aed7d..8ccd7f7 100644 --- a/README_fr.md +++ b/README_fr.md @@ -23,6 +23,7 @@ Il y a beaucoup d'extensions optionnelles et d'options de configuration pour per Parmi les fonctionnalités optionnelles, citons : le tri des fichiers, différents modes d'affichage, la localisation, le fil d'Ariane, l'arborescence, les en-têtes et pieds de page personnalisés, le filtrage et la recherche de fichiers, la taille des dossiers, le rafraîchissement automatique, l'emballage... + **Version incluse :** 0.30.0~ynh3 **Démo :** https://larsjung.de/h5ai/demo/ From af46cf6019f38b279cd83e2e2eab71fefa330c39 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Mon, 17 Oct 2022 01:52:08 +0200 Subject: [PATCH 4/4] Update restore --- scripts/restore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/restore b/scripts/restore index 15ce2cf..4a79d7e 100644 --- a/scripts/restore +++ b/scripts/restore @@ -55,7 +55,7 @@ ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=4 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$final_path" --not_mandatory chmod 750 "$final_path" chmod -R o-rwx "$final_path"