From e7fde290ed45a4890b62b99c0eff6c1168a5446e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Mon, 23 May 2022 12:39:33 +0200 Subject: [PATCH 01/20] 4.4.0 (#94) * 4.4.0 --- README.md | 2 +- README_fr.md | 2 +- check_process | 9 ++-- conf/app.src | 4 +- conf/cron | 4 +- conf/php-fpm.conf | 14 +++--- manifest.json | 2 +- scripts/_common.sh | 2 + scripts/install | 8 ++++ scripts/remove | 8 ++++ scripts/restore | 11 +++-- scripts/upgrade | 108 ++++----------------------------------------- 12 files changed, 52 insertions(+), 122 deletions(-) diff --git a/README.md b/README.md index 5d3fb23..fa34d4b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Jirafeau offers the possibility to host and share your files with ease. Choose a file, Jirafeau will provide you with a link with many options. It is possible to protect your links with a password as well as to choose how long the file will be kept on the server. The file and the link will self-destruct after this time. Downloads of transmitted files can be limited to a certain date, and each file can self-destruct after the first download. Jirafeau allows you to configure maximum retention times and maximum size per file. Encryption is available as an option. -**Shipped version:** 4.3.0~ynh3 +**Shipped version:** 4.4.0~ynh1 **Demo:** https://demo.yunohost.org/jirafeau/ diff --git a/README_fr.md b/README_fr.md index 982f6ad..7f10759 100644 --- a/README_fr.md +++ b/README_fr.md @@ -14,7 +14,7 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout en toute simplicité. Choisissez un fichier, Jirafeau vous fournira un lien avec beaucoup d'options. Il est possible de protéger vos liens avec mot de passe ainsi que de choisir la durée de rétention du fichier sur le serveur. Le fichier et le lien s'autodétruiront passé ce délai. Les téléchargements des fichiers transmis peuvent être limités à une certaine date, et chaque fichier peut s'autodétruire après le premier téléchargement. Jirafeau permet de configurer les temps maximum de rétention ainsi que la taille maximale par fichier. Le chiffrement est disponible en option. -**Version incluse :** 4.3.0~ynh3 +**Version incluse :** 4.4.0~ynh1 **Démo :** https://demo.yunohost.org/jirafeau/ diff --git a/check_process b/check_process index f0f98f2..7f23d58 100644 --- a/check_process +++ b/check_process @@ -13,6 +13,8 @@ setup_private=1 setup_public=1 upgrade=1 + #4.3.0~ynh3 + upgrade=1 from_commit=0615fbcfa5b163812657b2f291026bf24b5e0667 backup_restore=1 multi_instance=0 change_url=1 @@ -20,7 +22,6 @@ Email= Notification=none ;;; Upgrade options - ; commit= - name= - manifest_arg=domain=DOMAIN&path=PATH&admin_user=USER&upload_password=supersecretpassword&is_public=1& - + ; commit=0615fbcfa5b163812657b2f291026bf24b5e0667 + name=Merge pull request #92 + \ No newline at end of file diff --git a/conf/app.src b/conf/app.src index 16a8307..fd13c6f 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://gitlab.com/mojo42/Jirafeau/-/archive/4.3.0/Jirafeau-4.3.0.tar.gz -SOURCE_SUM=77bd4b69cb822ac8cac9df6890f17a673c978b10d8dd6fce46b60c763b859f74 +SOURCE_URL=https://gitlab.com/mojo42/Jirafeau/-/archive/4.4.0/Jirafeau-4.4.0.tar.gz +SOURCE_SUM=2afd605756e5d61d621092a1f796be63280d7394a9b61aedf9edbf7308c0cdba SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=true diff --git a/conf/cron b/conf/cron index 450ac93..2498395 100644 --- a/conf/cron +++ b/conf/cron @@ -1,4 +1,4 @@ # https://gitlab.com/mojo42/Jirafeau/#how-can-i-automatize-the-cleaning-of-old-expired-files -12 3 * * * __APP__ php__PHPVERSION__ __FINALPATH__/admin.php clean_expired -16 3 * * * __APP__ php__PHPVERSION__ __FINALPATH__/admin.php clean_async +12 3 * * * __APP__ /usr/bin/php__PHPVERSION__ __FINALPATH__/admin.php clean_expired +16 3 * * * __APP__ /usr/bin/php__PHPVERSION__ __FINALPATH__/admin.php clean_async diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf index c55828f..fc8573c 100644 --- a/conf/php-fpm.conf +++ b/conf/php-fpm.conf @@ -110,22 +110,22 @@ pm = dynamic ; forget to tweak pm.* to fit your needs. ; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' ; Note: This value is mandatory. -pm.max_children = 6 +pm.max_children = 5 ; The number of child processes created on startup. ; Note: Used only when pm is set to 'dynamic' ; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2 -pm.start_servers = 3 +pm.start_servers = 2 ; The desired minimum number of idle server processes. ; Note: Used only when pm is set to 'dynamic' ; Note: Mandatory when pm is set to 'dynamic' -pm.min_spare_servers = 3 +pm.min_spare_servers = 1 ; The desired maximum number of idle server processes. ; Note: Used only when pm is set to 'dynamic' ; Note: Mandatory when pm is set to 'dynamic' -pm.max_spare_servers = 5 +pm.max_spare_servers = 3 ; The number of seconds after which an idle process will be killed. ; Note: Used only when pm is set to 'ondemand' @@ -419,8 +419,8 @@ chdir = __FINALPATH__ ;php_admin_value[memory_limit] = 32M ; Common values to change to increase file upload limit -; php_admin_value[upload_max_filesize] = 50M -; php_admin_value[post_max_size] = 50M +php_admin_value[upload_max_filesize] = 10G +php_admin_value[post_max_size] = 10G ; php_admin_flag[mail.add_x_header] = Off ; Other common parameters @@ -428,5 +428,3 @@ chdir = __FINALPATH__ ; php_admin_value[max_input_time] = 300 ; php_admin_value[memory_limit] = 256M ; php_admin_flag[short_open_tag] = On -php_admin_value[upload_max_filesize] = 10G -php_admin_value[post_max_size] = 10G diff --git a/manifest.json b/manifest.json index f520de8..f0dab3d 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Upload a file in a simple way and give a unique link to it", "fr": "Hébergez simplement un fichier et partagez-le avec un lien unique" }, - "version": "4.3.0~ynh3", + "version": "4.4.0~ynh1", "url": "https://gitlab.com/mojo42/Jirafeau", "upstream": { "license": "AGPL-3.0-only", diff --git a/scripts/_common.sh b/scripts/_common.sh index d7614e9..1e50f29 100755 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -6,6 +6,8 @@ YNH_PHP_VERSION="7.3" +pkg_dependencies="" + #================================================= # PERSONAL HELPERS #================================================= diff --git a/scripts/install b/scripts/install index 9891e2e..f6c6ad0 100755 --- a/scripts/install +++ b/scripts/install @@ -25,6 +25,7 @@ path_url=$YNH_APP_ARG_PATH admin_user=$YNH_APP_ARG_ADMIN_USER upload_password=$YNH_APP_ARG_UPLOAD_PASSWORD is_public=$YNH_APP_ARG_IS_PUBLIC +phpversion=$YNH_PHP_VERSION app=$YNH_APP_INSTANCE_NAME @@ -49,6 +50,13 @@ ynh_app_setting_set --app=$app --key=path --value=$path_url ynh_app_setting_set --app=$app --key=admin --value=$admin_user ynh_app_setting_set --app=$app --key=is_public --value=$is_public +#================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Installing dependencies..." --weight=2 + +ynh_install_app_dependencies $pkg_dependencies + #================================================= # CREATE DEDICATED USER #================================================= diff --git a/scripts/remove b/scripts/remove index f7a2c97..94b7191 100755 --- a/scripts/remove +++ b/scripts/remove @@ -57,6 +57,14 @@ ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=2 # Remove the dedicated PHP-FPM config ynh_remove_fpm_config +#================================================= +# REMOVE DEPENDENCIES +#================================================= +ynh_script_progression --message="Removing dependencies..." --weight=3 + +# Remove metapackage and its dependencies +ynh_remove_app_dependencies + #================================================= # REMOVE THE CRON FILE #================================================= diff --git a/scripts/restore b/scripts/restore index 9c38fa6..865213c 100644 --- a/scripts/restore +++ b/scripts/restore @@ -24,7 +24,6 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) path_url=$(ynh_app_setting_get --app=$app --key=path) final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) datadir=$(ynh_app_setting_get --app=$app --key=datadir) @@ -77,6 +76,14 @@ chmod 750 "$datadir" chmod -R o-rwx "$datadir" chown -R $app:www-data "$datadir" +#================================================= +# REINSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Reinstalling dependencies..." --weight=3 + +# Define and install dependencies +ynh_install_app_dependencies $pkg_dependencies + #================================================= # RESTORE THE PHP-FPM CONFIGURATION #================================================= @@ -84,8 +91,6 @@ ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weig ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" -ynh_add_fpm_config - #================================================= # RESTORE THE CRON FILE #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 4fd4e8f..61ca069 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -22,7 +22,7 @@ admin_user=$(ynh_app_setting_get --app=$app --key=admin) is_public=$(ynh_app_setting_get --app=$app --key=is_public) final_path=$(ynh_app_setting_get --app=$app --key=final_path) upload_password=$(ynh_app_setting_get --app=$app --key=upload_password) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) +phpversion=$YNH_PHP_VERSION datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= @@ -62,65 +62,6 @@ if [ -z "$datadir" ]; then ynh_app_setting_set --app=$app --key=datadir --value=$datadir fi -# Migrate files from 3.4.1 to 4.1.1 -current_version="$(ynh_app_upstream_version --manifest="/etc/yunohost/apps/$app/manifest.json")" -update_version="$(ynh_app_upstream_version)" -# If the upgrade if from a version 3 or less to 4 or more. Migrate the files -if [ ${current_version:0:1} -le 3 ] && [ ${update_version:0:1} -ge 4 ] -then - ynh_script_progression --message="Migrating files..." --weight=5 - - # Migrate files and links to the new directory structure - for type in files links - do - while read file - do - # Ignore _count files - if echo "$file" | grep --quiet "_count$"; then - continue - fi - - # Remove all directories before the file name - full_file="$file" - file=$(basename $file) - - # Split the file name every 8 characters - split=0 - full_path="$datadir/$type" - while [ $split -le ${#file} ] - do - part_dir="${file:$split:8}" - # Increment the point where with start reading of 8. - split=$((split+8)) - full_path="$full_path/$part_dir" - done - - # Create the new crazy directory structure - mkdir -p "$full_path" - # And move the file to this place - mv "$full_file" "$full_path/$file" - if [ "$type" = "files" ]; then - mv "${full_file}_count" "$full_path" - fi - done <<< "$(find "$datadir/$type" -type f)" # List all files, without directories - done - - # And clean the old directories - for type in files links - do - while read file - do - # Remove all directories before the last one - dirname="$(basename $file)" - # Delete the directory if it's only one character long - if [ ${#dirname} -eq 1 ] - then - ynh_secure_remove --file="$file" - fi - done <<< "$(find "$datadir/$type" -maxdepth 1 -mindepth 1 -type d)" # List all first level directories - done -fi - #================================================= # CREATE DEDICATED USER #================================================= @@ -140,7 +81,10 @@ then ynh_script_progression --message="Upgrading source files..." --weight=2 # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" + ynh_setup_source --dest_dir="$final_path" --keep="$final_path/lib/config.local.php" + + # Remove the install.php + ynh_secure_remove --file=$final_path/install.php fi chmod 750 "$final_path" @@ -164,47 +108,11 @@ ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=2 ynh_add_fpm_config #================================================= -# SPECIFIC UPGRADE -#================================================= -# SET THE UPLOAD PASSWORD +# UPGRADE DEPENDENCIES #================================================= +ynh_script_progression --message="Upgrading dependencies..." --weight=3 -jirafeauconfigfile="$final_path/lib/config.local.php" - -ynh_backup_if_checksum_is_different --file="$final_path/lib/config.local.php" - -cp "../conf/config.local.php" "$final_path/lib/config.local.php" - -# Set and save upload password, allowing an empty one -if [ -z "$upload_password" ] -then - ynh_replace_string --match_string="__UPLOAD_PASSWORD__" --replace_string="" --target_file="$jirafeauconfigfile" - ynh_app_setting_set --app=$app --key=upload_password --value="" -else - ynh_replace_special_string --match_string="__UPLOAD_PASSWORD__" --replace_string="'$upload_password'" --target_file="$jirafeauconfigfile" - ynh_app_setting_set --app=$app --key=upload_password --value="$upload_password" -fi - -#================================================= -# CONFIGURE JIRAFEAU -#================================================= -ynh_script_progression --message="Upgrading $app configuration..." --weight=2 - -ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$jirafeauconfigfile" -if [ "$path_url" = "/" ] -then - ynh_replace_string --match_string="__PATH__" --replace_string="" --target_file="$jirafeauconfigfile" -else - ynh_replace_string --match_string="__PATH__" --replace_string="$path_url" --target_file="$jirafeauconfigfile" -fi -ynh_replace_string --match_string="__DATADIR__" --replace_string="$datadir" --target_file="$jirafeauconfigfile" -ynh_replace_string --match_string="__ADMIN_USER__" --replace_string="$admin_user" --target_file="$jirafeauconfigfile" - -# Recalculate and store the checksum of the file for the next upgrade. -ynh_store_file_checksum --file="$jirafeauconfigfile" - -# Remove the install.php -ynh_secure_remove --file=$final_path/install.php +ynh_install_app_dependencies $pkg_dependencies #================================================= # SET THE CRON FILE From 2ad16181db8d6cecbf7ab6708dd5f3378681c173 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Wed, 8 Jun 2022 22:35:03 +0000 Subject: [PATCH 02/20] Auto-update README --- README.md | 17 +++++++++-------- README_fr.md | 23 ++++++++++++++--------- 2 files changed, 23 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index fa34d4b..8f12538 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Jirafeau for YunoHost -[![Integration level](https://dash.yunohost.org/integration/jirafeau.svg)](https://dash.yunohost.org/appci/app/jirafeau) ![](https://ci-apps.yunohost.org/ci/badges/jirafeau.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jirafeau.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/jirafeau.svg)](https://dash.yunohost.org/appci/app/jirafeau) ![Working status](https://ci-apps.yunohost.org/ci/badges/jirafeau.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/jirafeau.maintain.svg) [![Install Jirafeau with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jirafeau) *[Lire ce readme en français.](./README_fr.md)* @@ -24,7 +24,7 @@ Jirafeau offers the possibility to host and share your files with ease. Choose a ## Screenshots -![](./doc/screenshots/TPjh48P.png) +![Screenshot of Jirafeau](./doc/screenshots/TPjh48P.png) ## Disclaimers / important information @@ -39,20 +39,21 @@ The license text on the "Terms of Service" page, which is shipped with the defau To administer the files within Jirafeau it is enough to go to the address `jirafeau.domaine.tld/admin.php`. ## Documentation and resources -* Official app website: https://gitlab.com/mojo42/Jirafeau -* Upstream app code repository: https://gitlab.com/mojo42/Jirafeau -* YunoHost documentation for this app: https://yunohost.org/app_jirafeau -* Report a bug: https://github.com/YunoHost-Apps/jirafeau_ynh/issues +* Official app website: +* 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/jirafeau_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/jirafeau_ynh/tree/testing --debug or sudo yunohost app upgrade jirafeau -u https://github.com/YunoHost-Apps/jirafeau_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 7f10759..3fabab6 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # Jirafeau pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/jirafeau.svg)](https://dash.yunohost.org/appci/app/jirafeau) ![](https://ci-apps.yunohost.org/ci/badges/jirafeau.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jirafeau.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/jirafeau.svg)](https://dash.yunohost.org/appci/app/jirafeau) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/jirafeau.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/jirafeau.maintain.svg) [![Installer Jirafeau avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jirafeau) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Jirafeau 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.* @@ -20,7 +24,7 @@ Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout ## Captures d'écran -![](./doc/screenshots/TPjh48P.png) +![Capture d'écran de Jirafeau](./doc/screenshots/TPjh48P.png) ## Avertissements / informations importantes @@ -35,20 +39,21 @@ Le texte de la licence sur la page "Conditions d'utilisation du service", qui es Pour administrer les fichiers présents au sein de Jirafeau il suffit de se rendre à l'adresse `jirafeau.domaine.tld/admin.php`. ## Documentations et ressources -* Site officiel de l'app : https://gitlab.com/mojo42/Jirafeau -* Dépôt de code officiel de l'app : https://gitlab.com/mojo42/Jirafeau -* Documentation YunoHost pour cette app : https://yunohost.org/app_jirafeau -* Signaler un bug : https://github.com/YunoHost-Apps/jirafeau_ynh/issues +* Site officiel de l'app : +* 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/jirafeau_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/jirafeau_ynh/tree/testing --debug ou sudo yunohost app upgrade jirafeau -u https://github.com/YunoHost-Apps/jirafeau_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 1373072c774593a7f0701e3bdc6e55662f4690ed Mon Sep 17 00:00:00 2001 From: yalh76 Date: Thu, 28 Jul 2022 23:32:49 +0200 Subject: [PATCH 03/20] Apply example_ynh --- check_process | 6 +-- conf/config.local.php | 2 +- conf/nginx.conf | 66 +++++++++++------------ manifest.json | 118 +++++++++++++++++++++--------------------- scripts/_common.sh | 1 + scripts/backup | 15 +++--- scripts/install | 73 ++++++++++---------------- scripts/remove | 17 +++--- scripts/restore | 29 ++++++----- scripts/upgrade | 52 +++++++++---------- 10 files changed, 186 insertions(+), 193 deletions(-) diff --git a/check_process b/check_process index 7f23d58..de43600 100644 --- a/check_process +++ b/check_process @@ -2,9 +2,9 @@ ; Manifest domain="domain.tld" path="/path" + is_public=1 admin_user="package_checker" upload_password="supersecretpassword" - is_public=1 ; Checks pkg_linter=1 setup_sub_dir=1 @@ -14,9 +14,10 @@ setup_public=1 upgrade=1 #4.3.0~ynh3 - upgrade=1 from_commit=0615fbcfa5b163812657b2f291026bf24b5e0667 + upgrade=1 from_commit=0615fbcfa5b163812657b2f291026bf24b5e0667 backup_restore=1 multi_instance=0 + port_already_use=0 change_url=1 ;;; Options Email= @@ -24,4 +25,3 @@ Notification=none ;;; Upgrade options ; commit=0615fbcfa5b163812657b2f291026bf24b5e0667 name=Merge pull request #92 - \ No newline at end of file diff --git a/conf/config.local.php b/conf/config.local.php index 80ba5c6..7259a27 100644 --- a/conf/config.local.php +++ b/conf/config.local.php @@ -27,7 +27,7 @@ /* URL of installation, with traling slash (eg. »https://exmaple.com/jirafeau/«) */ -$cfg['web_root'] = 'https://' . '__DOMAIN__' . '__PATH__' . '/'; +$cfg['web_root'] = 'https://' . '__DOMAIN__' . '__JIRAFEAU_PATH__' . '/'; /* Path to data directory, with trailing slash (eg. »/var/www/data/var_314159265358979323846264« */ diff --git a/conf/nginx.conf b/conf/nginx.conf index c92f5a3..0fd8d69 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,42 +1,44 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { - # Path to source - alias __FINALPATH__/ ; + # Path to source + alias __FINALPATH__/; - client_max_body_size 10G; - client_body_timeout 30m; - proxy_read_timeout 30m; + index index.php; - index index.php; - try_files $uri $uri/ index.php; + client_max_body_size 10G; + client_body_timeout 30m; + proxy_read_timeout 30m; - location ~ ^__PATH__/lib/functions.js.php { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; - fastcgi_read_timeout 30m; - fastcgi_send_timeout 30m; - } + try_files $uri $uri/ index.php; - location ~ ^__PATH__/lib/.*\.php { - deny all; - } + location ~ ^__PATH__/lib/functions.js.php { + fastcgi_split_path_info ^(.+?\.php)(/.*)$; + fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; + fastcgi_read_timeout 30m; + fastcgi_send_timeout 30m; + } - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; - } + location ~ ^__PATH__/lib/.*\.php { + deny all; + } - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; + location ~ [^/]\.php(/|$) { + fastcgi_split_path_info ^(.+?\.php)(/.*)$; + fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; + + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; + } + + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; } diff --git a/manifest.json b/manifest.json index f0dab3d..7eb7110 100644 --- a/manifest.json +++ b/manifest.json @@ -1,66 +1,66 @@ { - "name": "Jirafeau", - "id": "jirafeau", - "packaging_format": 1, - "description": { - "en": "Upload a file in a simple way and give a unique link to it", - "fr": "Hébergez simplement un fichier et partagez-le avec un lien unique" - }, - "version": "4.4.0~ynh1", - "url": "https://gitlab.com/mojo42/Jirafeau", - "upstream": { + "name": "Jirafeau", + "id": "jirafeau", + "packaging_format": 1, + "description": { + "en": "Upload a file in a simple way and give a unique link to it", + "fr": "Hébergez simplement un fichier et partagez-le avec un lien unique" + }, + "version": "4.4.0~ynh2", + "url": "https://gitlab.com/mojo42/Jirafeau", + "upstream": { "license": "AGPL-3.0-only", "website": "https://gitlab.com/mojo42/Jirafeau", "demo": "https://demo.yunohost.org/jirafeau/", "code": "https://gitlab.com/mojo42/Jirafeau" }, - "license": "AGPL-3.0-only", - "maintainer": { - "name": "julien", - "email": "julien.malik@paraiso.me" - }, - "requirements": { - "yunohost": ">= 4.3.0" - }, - "multi_instance": false, - "services": [ - "nginx", - "php7.3-fpm" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/jirafeau", - "default": "/jirafeau" - }, - { - "name": "admin_user", - "type": "user", - "ask": { - "en": "Choose an admin user (will be able to access admin.php page)", - "fr": "Choisissez l'administrateur (seul autorisé à accéder à la page admin.php)" - } - }, - { - "name": "upload_password", - "type": "password", - "optional": true, - "ask": { - "en": "Set the password granting upload permissions (leave empty to allow anybody to upload). Please avoid using ' (quotes) in the password as it will fail the app...", - "fr": "Définissez le mot de passe permettant l'accès à l'envoi de fichiers (laissez vide pour autoriser tout le monde). Veuillez éviter d'utiliser ' (guillemets) dans le mot de passe car cela fera échouer l'application..." - } - }, - { - "name": "is_public", - "type": "boolean", - "default": true - } - ] - } + "license": "AGPL-3.0-only", + "maintainer": { + "name": "julien", + "email": "julien.malik@paraiso.me" + }, + "requirements": { + "yunohost": ">= 4.3.0" + }, + "multi_instance": false, + "services": [ + "nginx", + "php7.3-fpm" + ], + "arguments": { + "install": [ + { + "name": "domain", + "type": "domain" + }, + { + "name": "path", + "type": "path", + "example": "/jirafeau", + "default": "/jirafeau" + }, + { + "name": "is_public", + "type": "boolean", + "default": true + }, + { + "name": "admin_user", + "type": "user", + "ask": { + "en": "Choose an admin user (will be able to access admin.php page)", + "fr": "Choisissez l'administrateur (seul autorisé à accéder à la page admin.php)" + } + }, + { + "name": "upload_password", + "type": "password", + "optional": true, + "ask": { + "en": "Set the password granting upload permissions (leave empty to allow anybody to upload). Please avoid using ' (quotes) in the password as it will fail the app...", + "fr": "Définissez le mot de passe permettant l'accès à l'envoi de fichiers (laissez vide pour autoriser tout le monde). Veuillez éviter d'utiliser ' (guillemets) dans le mot de passe car cela fera échouer l'application..." + } + } + ] + } } diff --git a/scripts/_common.sh b/scripts/_common.sh index 1e50f29..aae521c 100755 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -6,6 +6,7 @@ YNH_PHP_VERSION="7.3" +# dependencies used by the app pkg_dependencies="" #================================================= diff --git a/scripts/backup b/scripts/backup index 91246d8..b2de5fd 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,9 +1,12 @@ #!/bin/bash +#================================================= +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -32,31 +35,31 @@ datadir=$(ynh_app_setting_get --app=$app --key=datadir) ynh_print_info --message="Declaring files to be backed up..." #================================================= -# BACKUP OF THE MAIN DIR OF THE APP +# BACKUP THE APP MAIN DIR #================================================= ynh_backup --src_path="$final_path" #================================================= -# BACKUP OF THE DATA DIR +# BACKUP THE DATA DIR #================================================= ynh_backup --src_path="$datadir" --is_big #================================================= -# BACKUP OF THE NGINX CONFIGURATION +# BACKUP THE NGINX CONFIGURATION #================================================= ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= -# BACKUP OF THE PHP-FPM CONFIGURATION +# BACKUP THE PHP-FPM CONFIGURATION #================================================= ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" #================================================= -# BACKUP THE CRON FILE +# BACKUP VARIOUS FILES #================================================= ynh_backup --src_path="/etc/cron.d/$app" @@ -65,4 +68,4 @@ ynh_backup --src_path="/etc/cron.d/$app" # END OF SCRIPT #================================================= -ynh_print_info --message="Backup script completed for Jirafeau. (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)." diff --git a/scripts/install b/scripts/install index f6c6ad0..151a039 100755 --- a/scripts/install +++ b/scripts/install @@ -1,7 +1,7 @@ #!/bin/bash #================================================= -# GENERIC STARTING +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -22,10 +22,9 @@ ynh_abort_if_errors domain=$YNH_APP_ARG_DOMAIN path_url=$YNH_APP_ARG_PATH +is_public=$YNH_APP_ARG_IS_PUBLIC admin_user=$YNH_APP_ARG_ADMIN_USER upload_password=$YNH_APP_ARG_UPLOAD_PASSWORD -is_public=$YNH_APP_ARG_IS_PUBLIC -phpversion=$YNH_PHP_VERSION app=$YNH_APP_INSTANCE_NAME @@ -35,7 +34,7 @@ app=$YNH_APP_INSTANCE_NAME ynh_script_progression --message="Validating installation parameters..." --weight=1 final_path=/var/www/$app -test ! -e "$final_path" || ynh_die "This path already contains a folder" +test ! -e "$final_path" || ynh_die --message="This path already contains a folder" # Register (book) web path ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url @@ -49,7 +48,10 @@ ynh_app_setting_set --app=$app --key=domain --value=$domain ynh_app_setting_set --app=$app --key=path --value=$path_url ynh_app_setting_set --app=$app --key=admin --value=$admin_user ynh_app_setting_set --app=$app --key=is_public --value=$is_public +ynh_app_setting_set --app=$app --key=upload_password --value="$upload_password" +#================================================= +# STANDARD MODIFICATIONS #================================================= # INSTALL DEPENDENCIES #================================================= @@ -65,8 +67,6 @@ ynh_script_progression --message="Configuring system user..." --weight=2 # Create a system user ynh_system_user_create --username=$app --home_dir="$final_path" -#================================================= -# STANDARD MODIFICATIONS #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -76,10 +76,21 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$final_path" +# Remove the install.php +ynh_secure_remove --file=$final_path/install.php + 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=2 + +# Create a dedicated PHP-FPM config +ynh_add_fpm_config + #================================================= # NGINX CONFIGURATION #================================================= @@ -88,34 +99,8 @@ ynh_script_progression --message="Configuring NGINX web server..." # Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring PHP-FPM..." --weight=2 - -# Create a dedicated PHP-FPM config -ynh_add_fpm_config -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) - #================================================= # SPECIFIC SETUP -#================================================= -# SET AND SAVE THE UPLOAD PASSWORD -#================================================= - -jirafeauconfigfile="$final_path/lib/config.local.php" -cp "../conf/config.local.php" "$jirafeauconfigfile" - -# Set and save upload password, allowing an empty one -if [ -z "$upload_password" ] -then - ynh_replace_string --match_string="__UPLOAD_PASSWORD__" --replace_string="" --target_file="$jirafeauconfigfile" - ynh_app_setting_set --app=$app --key=upload_password --value="" -else - ynh_replace_special_string --match_string="__UPLOAD_PASSWORD__" --replace_string="'$upload_password'" --target_file="$jirafeauconfigfile" - ynh_app_setting_set --app=$app --key=upload_password --value="$upload_password" -fi - #================================================= # CREATE DATA DIRECTORY #================================================= @@ -131,28 +116,21 @@ chmod -R o-rwx "$datadir" chown -R $app:www-data "$datadir" #================================================= -# CONFIGURE JIRAFEAU +# ADD A CONFIGURATION #================================================= -ynh_script_progression --message="Configuring Jirafeau..." --weight=2 +ynh_script_progression --message="Adding a configuration file..." --weight=2 -ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$jirafeauconfigfile" if [ "$path_url" = "/" ] then - ynh_replace_string --match_string="__PATH__" --replace_string="" --target_file="$jirafeauconfigfile" + jirafeau_path="" else - ynh_replace_string --match_string="__PATH__" --replace_string="$path_url" --target_file="$jirafeauconfigfile" + jirafeau_path="$path_url" fi -ynh_replace_string --match_string="__DATADIR__" --replace_string="$datadir" --target_file="$jirafeauconfigfile" -ynh_replace_string --match_string="__ADMIN_USER__" --replace_string="$admin_user" --target_file="$jirafeauconfigfile" -# Calculate and store the config file checksum into the app settings -ynh_store_file_checksum --file="$jirafeauconfigfile" +ynh_add_config --template="../conf/config.local.php" --destination="$final_path/lib/config.local.php" -# Remove the install.php -ynh_secure_remove --file=$final_path/install.php - -chmod 400 "$jirafeauconfigfile" -chown $app:$app "$jirafeauconfigfile" +chmod 400 "$final_path/lib/config.local.php" +chown $app:$app "$final_path/lib/config.local.php" #================================================= # SET THE CRON FILE @@ -160,9 +138,12 @@ chown $app:$app "$jirafeauconfigfile" ynh_script_progression --message="Configuring the cron file..." --weight=2 ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app" + chown root: "/etc/cron.d/$app" chmod 644 "/etc/cron.d/$app" +#================================================= +# GENERIC FINALIZATION #================================================= # SETUP SSOWAT #================================================= diff --git a/scripts/remove b/scripts/remove index 94b7191..213ae23 100755 --- a/scripts/remove +++ b/scripts/remove @@ -1,7 +1,7 @@ #!/bin/bash #================================================= -# GENERIC STARTING +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -23,7 +23,7 @@ datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= # STANDARD REMOVE #================================================= -# REMOVE THE MAIN DIR OF THE APP +# REMOVE APP MAIN DIR #================================================= ynh_script_progression --message="Removing app main directory..." --weight=2 @@ -42,7 +42,7 @@ then fi #================================================= -# REMOVE THE NGINX CONFIGURATION +# REMOVE NGINX CONFIGURATION #================================================= ynh_script_progression --message="Removing NGINX web server configuration..." --weight=2 @@ -50,7 +50,7 @@ ynh_script_progression --message="Removing NGINX web server configuration..." -- ynh_remove_nginx_config #================================================= -# REMOVE THE PHP-FPM CONFIGURATION +# REMOVE PHP-FPM CONFIGURATION #================================================= ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=2 @@ -66,14 +66,17 @@ ynh_script_progression --message="Removing dependencies..." --weight=3 ynh_remove_app_dependencies #================================================= -# REMOVE THE CRON FILE +# SPECIFIC REMOVE #================================================= -ynh_script_progression --message="Removing the cron file..." --weight=1 +# REMOVE VARIOUS FILES +#================================================= +ynh_script_progression --message="Removing various files..." --weight=1 +# Remove a cron file ynh_secure_remove --file="/etc/cron.d/$app" #================================================= -# GENERIC FINALISATION +# GENERIC FINALIZATION #================================================= # REMOVE DEDICATED USER #================================================= diff --git a/scripts/restore b/scripts/restore index 865213c..90cc892 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,9 +1,12 @@ #!/bin/bash +#================================================= +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -17,7 +20,7 @@ ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading settings..." --weight=2 +ynh_script_progression --message="Loading installation settings..." --weight=2 app=$YNH_APP_INSTANCE_NAME @@ -36,14 +39,7 @@ test ! -d $final_path \ || ynh_die --message="There is already a directory: $final_path " #================================================= -# STANDARD RESTORE STEPS -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX configuration..." --weight=1 - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" - +# STANDARD RESTORATION STEPS #================================================= # RECREATE THE DEDICATED USER #================================================= @@ -55,7 +51,7 @@ ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= # RESTORE THE APP MAIN DIR #================================================= -ynh_script_progression --message="Restoring $app main directory..." --weight=2 +ynh_script_progression --message="Restoring the app main directory..." --weight=2 ynh_restore_file --origin_path="$final_path" @@ -92,16 +88,23 @@ ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weig ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" #================================================= -# RESTORE THE CRON FILE +# RESTORE THE NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Restoring the cron file..." --weight=1 +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" + +#================================================= +# RESTORE VARIOUS FILES +#================================================= +ynh_script_progression --message="Restoring various files..." --weight=1 ynh_restore_file --origin_path="/etc/cron.d/$app" chown root: "/etc/cron.d/$app" chmod 644 "/etc/cron.d/$app" #================================================= -# GENERIC FINALISATION +# GENERIC FINALIZATION #================================================= # RELOAD NGINX AND PHP-FPM #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 61ca069..5dee9ed 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,7 +1,7 @@ #!/bin/bash #================================================= -# GENERIC STARTING +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -28,23 +28,26 @@ datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= # CHECK VERSION #================================================= +ynh_script_progression --message="Checking version..." upgrade_type=$(ynh_check_app_version_changed) #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= -ynh_script_progression --message="Backing up Jirafeau before upgrading (may take a while)..." --weight=3 +ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=3 # Backup the current version of the app ynh_backup_before_upgrade ynh_clean_setup () { - # restore it if the upgrade fails - ynh_restore_upgradebackup + # 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 #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= @@ -62,6 +65,15 @@ if [ -z "$datadir" ]; then ynh_app_setting_set --app=$app --key=datadir --value=$datadir fi +ynh_permission_update --permission="main" --add="visitors" + +if [ $is_public -eq 0 ] +then + domain_regex=$(echo "$domain" | sed 's@-@.@g') + [ "$path_url" = "/" ] && path_url="" + ynh_app_setting_set --app=$app --key=protected_regex --value="$domain_regex$path_url/$","$domain_regex$path_url/admin.php.*$" +fi + #================================================= # CREATE DEDICATED USER #================================================= @@ -70,8 +82,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 #================================================= @@ -92,12 +102,11 @@ chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" #================================================= -# NGINX CONFIGURATION +# UPGRADE DEPENDENCIES #================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2 +ynh_script_progression --message="Upgrading dependencies..." --weight=3 -# Create a dedicated NGINX config -ynh_add_nginx_config +ynh_install_app_dependencies $pkg_dependencies #================================================= # PHP-FPM CONFIGURATION @@ -108,12 +117,15 @@ ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=2 ynh_add_fpm_config #================================================= -# UPGRADE DEPENDENCIES +# NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=3 +ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2 -ynh_install_app_dependencies $pkg_dependencies +# Create a dedicated NGINX config +ynh_add_nginx_config +#================================================= +# SPECIFIC UPGRADE #================================================= # SET THE CRON FILE #================================================= @@ -124,19 +136,7 @@ chown root: "/etc/cron.d/$app" chmod 644 "/etc/cron.d/$app" #================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=2 - -ynh_permission_update --permission="main" --add="visitors" - -if [ $is_public -eq 0 ] -then - domain_regex=$(echo "$domain" | sed 's@-@.@g') - [ "$path_url" = "/" ] && path_url="" - ynh_app_setting_set --app=$app --key=protected_regex --value="$domain_regex$path_url/$","$domain_regex$path_url/admin.php.*$" -fi - +# GENERIC FINALIZATION #================================================= # RELOAD NGINX #================================================= From 530245950a366947285b19e09f47404f332de5ca Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Thu, 28 Jul 2022 21:32:59 +0000 Subject: [PATCH 04/20] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8f12538..d720fc1 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Jirafeau offers the possibility to host and share your files with ease. Choose a file, Jirafeau will provide you with a link with many options. It is possible to protect your links with a password as well as to choose how long the file will be kept on the server. The file and the link will self-destruct after this time. Downloads of transmitted files can be limited to a certain date, and each file can self-destruct after the first download. Jirafeau allows you to configure maximum retention times and maximum size per file. Encryption is available as an option. -**Shipped version:** 4.4.0~ynh1 +**Shipped version:** 4.4.0~ynh2 **Demo:** https://demo.yunohost.org/jirafeau/ diff --git a/README_fr.md b/README_fr.md index 3fabab6..baf69ba 100644 --- a/README_fr.md +++ b/README_fr.md @@ -18,7 +18,7 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout en toute simplicité. Choisissez un fichier, Jirafeau vous fournira un lien avec beaucoup d'options. Il est possible de protéger vos liens avec mot de passe ainsi que de choisir la durée de rétention du fichier sur le serveur. Le fichier et le lien s'autodétruiront passé ce délai. Les téléchargements des fichiers transmis peuvent être limités à une certaine date, et chaque fichier peut s'autodétruire après le premier téléchargement. Jirafeau permet de configurer les temps maximum de rétention ainsi que la taille maximale par fichier. Le chiffrement est disponible en option. -**Version incluse :** 4.4.0~ynh1 +**Version incluse :** 4.4.0~ynh2 **Démo :** https://demo.yunohost.org/jirafeau/ From 1fce51d141cd8468340b3a83e3e9212ffff360aa Mon Sep 17 00:00:00 2001 From: yalh76 Date: Fri, 29 Jul 2022 17:46:56 +0200 Subject: [PATCH 05/20] Update manifest.json --- manifest.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/manifest.json b/manifest.json index 7eb7110..80debc4 100644 --- a/manifest.json +++ b/manifest.json @@ -16,8 +16,8 @@ }, "license": "AGPL-3.0-only", "maintainer": { - "name": "julien", - "email": "julien.malik@paraiso.me" + "name": "", + "email": "" }, "requirements": { "yunohost": ">= 4.3.0" From b49bab53a29b38bcda4df1607ab83883a433be97 Mon Sep 17 00:00:00 2001 From: YunoHost Bot Date: Sun, 7 Aug 2022 21:07:32 +0200 Subject: [PATCH 06/20] =?UTF-8?q?[autopatch]=20Add=20Common=20Platform?= =?UTF-8?q?=C2=A0Enumeration=20id=20to=20`manifest.json`=20(#99)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Upgrade (#98) * 4.4.0 (#94) * 4.4.0 * Auto-update README * Apply example_ynh * Auto-update README * Update manifest.json Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: yunohost-bot * [autopatch] Add Common Platform Enumeration id to `manifest.json` Co-authored-by: yalh76 Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: Yunohost-Bot <> --- manifest.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/manifest.json b/manifest.json index 80debc4..3c67609 100644 --- a/manifest.json +++ b/manifest.json @@ -12,7 +12,8 @@ "license": "AGPL-3.0-only", "website": "https://gitlab.com/mojo42/Jirafeau", "demo": "https://demo.yunohost.org/jirafeau/", - "code": "https://gitlab.com/mojo42/Jirafeau" + "code": "https://gitlab.com/mojo42/Jirafeau", + "cpe": "cpe:2.3:a:jirafeau:jirafeau" }, "license": "AGPL-3.0-only", "maintainer": { From ff29f629d13e295a703993a4545bdb6651e19c45 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 14 Aug 2022 16:29:57 +0000 Subject: [PATCH 07/20] Auto-update README --- README.md | 1 + README_fr.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d720fc1..b6e4ce2 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Jirafeau offers the possibility to host and share your files with ease. Choose a **Shipped version:** 4.4.0~ynh2 + **Demo:** https://demo.yunohost.org/jirafeau/ ## Screenshots diff --git a/README_fr.md b/README_fr.md index baf69ba..75cc774 100644 --- a/README_fr.md +++ b/README_fr.md @@ -18,7 +18,8 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout en toute simplicité. Choisissez un fichier, Jirafeau vous fournira un lien avec beaucoup d'options. Il est possible de protéger vos liens avec mot de passe ainsi que de choisir la durée de rétention du fichier sur le serveur. Le fichier et le lien s'autodétruiront passé ce délai. Les téléchargements des fichiers transmis peuvent être limités à une certaine date, et chaque fichier peut s'autodétruire après le premier téléchargement. Jirafeau permet de configurer les temps maximum de rétention ainsi que la taille maximale par fichier. Le chiffrement est disponible en option. -**Version incluse :** 4.4.0~ynh2 +**Version incluse :** 4.4.0~ynh2 + **Démo :** https://demo.yunohost.org/jirafeau/ From 80f0d44b7ea85eddcb30785a9c53c26c6c47c000 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Mon, 15 Aug 2022 08:15:56 +0200 Subject: [PATCH 08/20] Bullseye (#100) * Auto-update README * PHP shouldn't allow `array(foobar)` to work if foobar is undefined... * Upgrade to bullseye * Auto-update README * Auto-update README * Fix Co-authored-by: yunohost-bot Co-authored-by: Alexandre Aubin --- README.md | 2 +- README_fr.md | 2 +- conf/config.local.php | 2 +- manifest.json | 4 ++-- scripts/_common.sh | 4 ++-- scripts/install | 4 ++++ scripts/restore | 4 ++++ 7 files changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b6e4ce2..2f88512 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Jirafeau offers the possibility to host and share your files with ease. Choose a file, Jirafeau will provide you with a link with many options. It is possible to protect your links with a password as well as to choose how long the file will be kept on the server. The file and the link will self-destruct after this time. Downloads of transmitted files can be limited to a certain date, and each file can self-destruct after the first download. Jirafeau allows you to configure maximum retention times and maximum size per file. Encryption is available as an option. -**Shipped version:** 4.4.0~ynh2 +**Shipped version:** 4.4.0~ynh3 **Demo:** https://demo.yunohost.org/jirafeau/ diff --git a/README_fr.md b/README_fr.md index 75cc774..ff8f735 100644 --- a/README_fr.md +++ b/README_fr.md @@ -18,7 +18,7 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout en toute simplicité. Choisissez un fichier, Jirafeau vous fournira un lien avec beaucoup d'options. Il est possible de protéger vos liens avec mot de passe ainsi que de choisir la durée de rétention du fichier sur le serveur. Le fichier et le lien s'autodétruiront passé ce délai. Les téléchargements des fichiers transmis peuvent être limités à une certaine date, et chaque fichier peut s'autodétruire après le premier téléchargement. Jirafeau permet de configurer les temps maximum de rétention ainsi que la taille maximale par fichier. Le chiffrement est disponible en option. -**Version incluse :** 4.4.0~ynh2 +**Version incluse :** 4.4.0~ynh3 **Démo :** https://demo.yunohost.org/jirafeau/ diff --git a/conf/config.local.php b/conf/config.local.php index 7259a27..e413d82 100644 --- a/conf/config.local.php +++ b/conf/config.local.php @@ -74,7 +74,7 @@ $cfg['link_name_length'] = 8; * $cfg['upload_password'] = array('psw1'); // One password * $cfg['upload_password'] = array('psw1', 'psw2'); // Two passwords */ -$cfg['upload_password'] = array(__UPLOAD_PASSWORD__); +$cfg['upload_password'] = array('__UPLOAD_PASSWORD__'); /* List of IP allowed to upload a file. * If the list is empty, then there is no upload restriction based on IP. diff --git a/manifest.json b/manifest.json index 3c67609..2087a26 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Upload a file in a simple way and give a unique link to it", "fr": "Hébergez simplement un fichier et partagez-le avec un lien unique" }, - "version": "4.4.0~ynh2", + "version": "4.4.0~ynh3", "url": "https://gitlab.com/mojo42/Jirafeau", "upstream": { "license": "AGPL-3.0-only", @@ -21,7 +21,7 @@ "email": "" }, "requirements": { - "yunohost": ">= 4.3.0" + "yunohost": ">= 11.0.9" }, "multi_instance": false, "services": [ diff --git a/scripts/_common.sh b/scripts/_common.sh index aae521c..eb3783f 100755 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,10 +4,10 @@ # COMMON VARIABLES #================================================= -YNH_PHP_VERSION="7.3" +YNH_PHP_VERSION="8.0" # dependencies used by the app -pkg_dependencies="" +pkg_dependencies="php$YNH_PHP_VERSION-fpm" #================================================= # PERSONAL HELPERS diff --git a/scripts/install b/scripts/install index 151a039..efe088b 100755 --- a/scripts/install +++ b/scripts/install @@ -13,6 +13,10 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= +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 ynh_abort_if_errors diff --git a/scripts/restore b/scripts/restore index 90cc892..c21f1a7 100644 --- a/scripts/restore +++ b/scripts/restore @@ -14,6 +14,10 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= +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 ynh_abort_if_errors From 461777af0cb9722038127523e72f82cfd69a8f58 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Mon, 15 Aug 2022 18:51:49 +0200 Subject: [PATCH 09/20] set relative path for --keep opt --- scripts/upgrade | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/upgrade b/scripts/upgrade index 5dee9ed..72f4792 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -91,7 +91,7 @@ then ynh_script_progression --message="Upgrading source files..." --weight=2 # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" --keep="$final_path/lib/config.local.php" + ynh_setup_source --dest_dir="$final_path" --keep="lib/config.local.php" # Remove the install.php ynh_secure_remove --file=$final_path/install.php From 0223c671b79b1eada96b7ddd47bb3e14a898ba6f Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Wed, 17 Aug 2022 23:17:20 +0200 Subject: [PATCH 10/20] 4.5.0 --- conf/app.src | 4 ++-- manifest.json | 4 ++-- scripts/upgrade | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/conf/app.src b/conf/app.src index fd13c6f..1fc4741 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://gitlab.com/mojo42/Jirafeau/-/archive/4.4.0/Jirafeau-4.4.0.tar.gz -SOURCE_SUM=2afd605756e5d61d621092a1f796be63280d7394a9b61aedf9edbf7308c0cdba +SOURCE_URL=https://gitlab.com/mojo42/Jirafeau/-/archive/4.5.0/Jirafeau-4.5.0.tar.gz +SOURCE_SUM=cc164f086b65c810cefc0eb26bffa6718a12a56ea94b7717d7eba8281d6c66ac SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=true diff --git a/manifest.json b/manifest.json index 2087a26..392464f 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Upload a file in a simple way and give a unique link to it", "fr": "Hébergez simplement un fichier et partagez-le avec un lien unique" }, - "version": "4.4.0~ynh3", + "version": "4.5.0~ynh1", "url": "https://gitlab.com/mojo42/Jirafeau", "upstream": { "license": "AGPL-3.0-only", @@ -26,7 +26,7 @@ "multi_instance": false, "services": [ "nginx", - "php7.3-fpm" + "php8.0-fpm" ], "arguments": { "install": [ diff --git a/scripts/upgrade b/scripts/upgrade index 72f4792..28d6fa1 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -22,7 +22,7 @@ admin_user=$(ynh_app_setting_get --app=$app --key=admin) is_public=$(ynh_app_setting_get --app=$app --key=is_public) final_path=$(ynh_app_setting_get --app=$app --key=final_path) upload_password=$(ynh_app_setting_get --app=$app --key=upload_password) -phpversion=$YNH_PHP_VERSION +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= From 03d63ef496269f175b660abc91a0e7050dc8a8d5 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Wed, 17 Aug 2022 21:17:28 +0000 Subject: [PATCH 11/20] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2f88512..4194252 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Jirafeau offers the possibility to host and share your files with ease. Choose a file, Jirafeau will provide you with a link with many options. It is possible to protect your links with a password as well as to choose how long the file will be kept on the server. The file and the link will self-destruct after this time. Downloads of transmitted files can be limited to a certain date, and each file can self-destruct after the first download. Jirafeau allows you to configure maximum retention times and maximum size per file. Encryption is available as an option. -**Shipped version:** 4.4.0~ynh3 +**Shipped version:** 4.5.0~ynh1 **Demo:** https://demo.yunohost.org/jirafeau/ diff --git a/README_fr.md b/README_fr.md index ff8f735..34b60bf 100644 --- a/README_fr.md +++ b/README_fr.md @@ -18,7 +18,7 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout en toute simplicité. Choisissez un fichier, Jirafeau vous fournira un lien avec beaucoup d'options. Il est possible de protéger vos liens avec mot de passe ainsi que de choisir la durée de rétention du fichier sur le serveur. Le fichier et le lien s'autodétruiront passé ce délai. Les téléchargements des fichiers transmis peuvent être limités à une certaine date, et chaque fichier peut s'autodétruire après le premier téléchargement. Jirafeau permet de configurer les temps maximum de rétention ainsi que la taille maximale par fichier. Le chiffrement est disponible en option. -**Version incluse :** 4.4.0~ynh3 +**Version incluse :** 4.5.0~ynh1 **Démo :** https://demo.yunohost.org/jirafeau/ From a56846433bf6b3c75d86db7fdf6ddc29afacf579 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Tue, 10 Jan 2023 10:52:50 +0000 Subject: [PATCH 12/20] Auto-update README --- README_fr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README_fr.md b/README_fr.md index 685a2c7..5ec6c8f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -17,8 +17,8 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout en toute simplicité. Choisissez un fichier, Jirafeau vous fournira un lien avec beaucoup d'options. Il est possible de protéger vos liens avec mot de passe ainsi que de choisir la durée de rétention du fichier sur le serveur. Le fichier et le lien s'autodétruiront passé ce délai. Les téléchargements des fichiers transmis peuvent être limités à une certaine date, et chaque fichier peut s'autodétruire après le premier téléchargement. Jirafeau permet de configurer les temps maximum de rétention ainsi que la taille maximale par fichier. Le chiffrement est disponible en option. -**Version incluse :** 4.5.0~ynh1 +**Version incluse :** 4.5.0~ynh1 **Démo :** https://demo.yunohost.org/jirafeau/ From a2b1883234acdf306599efda264e0e9f5580be8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Tue, 10 Jan 2023 11:58:07 +0100 Subject: [PATCH 13/20] Fix PHP --- conf/extra_php-fpm.conf | 4 + conf/php-fpm.conf | 430 ---------------------------------------- config_panel.toml | 30 +++ scripts/config | 95 +++++++++ scripts/install | 11 +- scripts/restore | 6 + scripts/upgrade | 25 ++- 7 files changed, 169 insertions(+), 432 deletions(-) create mode 100644 conf/extra_php-fpm.conf delete mode 100644 conf/php-fpm.conf create mode 100644 config_panel.toml create mode 100644 scripts/config diff --git a/conf/extra_php-fpm.conf b/conf/extra_php-fpm.conf new file mode 100644 index 0000000..43f8232 --- /dev/null +++ b/conf/extra_php-fpm.conf @@ -0,0 +1,4 @@ +; Additional php.ini defines, specific to this pool of workers. + +php_admin_value[upload_max_filesize] = 10G +php_admin_value[post_max_size] = 10G diff --git a/conf/php-fpm.conf b/conf/php-fpm.conf deleted file mode 100644 index fc8573c..0000000 --- a/conf/php-fpm.conf +++ /dev/null @@ -1,430 +0,0 @@ -; Start a new pool named 'www'. -; the variable $pool can be used in any directive and will be replaced by the -; pool name ('www' here) -[__NAMETOCHANGE__] - -; Per pool prefix -; It only applies on the following directives: -; - 'access.log' -; - 'slowlog' -; - 'listen' (unixsocket) -; - 'chroot' -; - 'chdir' -; - 'php_values' -; - 'php_admin_values' -; When not set, the global prefix (or /usr) applies instead. -; Note: This directive can also be relative to the global prefix. -; Default Value: none -;prefix = /path/to/pools/$pool - -; Unix user/group of processes -; Note: The user is mandatory. If the group is not set, the default user's group -; will be used. -user = __USER__ -group = __USER__ - -; The address on which to accept FastCGI requests. -; Valid syntaxes are: -; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on -; a specific port; -; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on -; a specific port; -; 'port' - to listen on a TCP socket to all addresses -; (IPv6 and IPv4-mapped) on a specific port; -; '/path/to/unix/socket' - to listen on a unix socket. -; Note: This value is mandatory. -listen = /var/run/php/php__PHPVERSION__-fpm-__NAMETOCHANGE__.sock - -; Set listen(2) backlog. -; Default Value: 511 (-1 on FreeBSD and OpenBSD) -;listen.backlog = 511 - -; Set permissions for unix socket, if one is used. In Linux, read/write -; permissions must be set in order to allow connections from a web server. Many -; BSD-derived systems allow connections regardless of permissions. -; Default Values: user and group are set as the running user -; mode is set to 0660 -listen.owner = www-data -listen.group = www-data -;listen.mode = 0660 -; When POSIX Access Control Lists are supported you can set them using -; these options, value is a comma separated list of user/group names. -; When set, listen.owner and listen.group are ignored -;listen.acl_users = -;listen.acl_groups = - -; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect. -; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original -; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address -; must be separated by a comma. If this value is left blank, connections will be -; accepted from any ip address. -; Default Value: any -;listen.allowed_clients = 127.0.0.1 - -; Specify the nice(2) priority to apply to the pool processes (only if set) -; The value can vary from -19 (highest priority) to 20 (lower priority) -; Note: - It will only work if the FPM master process is launched as root -; - The pool processes will inherit the master process priority -; unless it specified otherwise -; Default Value: no set -; process.priority = -19 - -; Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user -; or group is differrent than the master process user. It allows to create process -; core dump and ptrace the process for the pool user. -; Default Value: no -; process.dumpable = yes - -; Choose how the process manager will control the number of child processes. -; Possible Values: -; static - a fixed number (pm.max_children) of child processes; -; dynamic - the number of child processes are set dynamically based on the -; following directives. With this process management, there will be -; always at least 1 children. -; pm.max_children - the maximum number of children that can -; be alive at the same time. -; pm.start_servers - the number of children created on startup. -; pm.min_spare_servers - the minimum number of children in 'idle' -; state (waiting to process). If the number -; of 'idle' processes is less than this -; number then some children will be created. -; pm.max_spare_servers - the maximum number of children in 'idle' -; state (waiting to process). If the number -; of 'idle' processes is greater than this -; number then some children will be killed. -; ondemand - no children are created at startup. Children will be forked when -; new requests will connect. The following parameter are used: -; pm.max_children - the maximum number of children that -; can be alive at the same time. -; pm.process_idle_timeout - The number of seconds after which -; an idle process will be killed. -; Note: This value is mandatory. -pm = dynamic - -; The number of child processes to be created when pm is set to 'static' and the -; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'. -; This value sets the limit on the number of simultaneous requests that will be -; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. -; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP -; CGI. The below defaults are based on a server without much resources. Don't -; forget to tweak pm.* to fit your needs. -; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' -; Note: This value is mandatory. -pm.max_children = 5 - -; The number of child processes created on startup. -; Note: Used only when pm is set to 'dynamic' -; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2 -pm.start_servers = 2 - -; The desired minimum number of idle server processes. -; Note: Used only when pm is set to 'dynamic' -; Note: Mandatory when pm is set to 'dynamic' -pm.min_spare_servers = 1 - -; The desired maximum number of idle server processes. -; Note: Used only when pm is set to 'dynamic' -; Note: Mandatory when pm is set to 'dynamic' -pm.max_spare_servers = 3 - -; The number of seconds after which an idle process will be killed. -; Note: Used only when pm is set to 'ondemand' -; Default Value: 10s -;pm.process_idle_timeout = 10s; - -; The number of requests each child process should execute before respawning. -; This can be useful to work around memory leaks in 3rd party libraries. For -; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS. -; Default Value: 0 -;pm.max_requests = 500 - -; The URI to view the FPM status page. If this value is not set, no URI will be -; recognized as a status page. It shows the following informations: -; pool - the name of the pool; -; process manager - static, dynamic or ondemand; -; start time - the date and time FPM has started; -; start since - number of seconds since FPM has started; -; accepted conn - the number of request accepted by the pool; -; listen queue - the number of request in the queue of pending -; connections (see backlog in listen(2)); -; max listen queue - the maximum number of requests in the queue -; of pending connections since FPM has started; -; listen queue len - the size of the socket queue of pending connections; -; idle processes - the number of idle processes; -; active processes - the number of active processes; -; total processes - the number of idle + active processes; -; max active processes - the maximum number of active processes since FPM -; has started; -; max children reached - number of times, the process limit has been reached, -; when pm tries to start more children (works only for -; pm 'dynamic' and 'ondemand'); -; Value are updated in real time. -; Example output: -; pool: www -; process manager: static -; start time: 01/Jul/2011:17:53:49 +0200 -; start since: 62636 -; accepted conn: 190460 -; listen queue: 0 -; max listen queue: 1 -; listen queue len: 42 -; idle processes: 4 -; active processes: 11 -; total processes: 15 -; max active processes: 12 -; max children reached: 0 -; -; By default the status page output is formatted as text/plain. Passing either -; 'html', 'xml' or 'json' in the query string will return the corresponding -; output syntax. Example: -; http://www.foo.bar/status -; http://www.foo.bar/status?json -; http://www.foo.bar/status?html -; http://www.foo.bar/status?xml -; -; By default the status page only outputs short status. Passing 'full' in the -; query string will also return status for each pool process. -; Example: -; http://www.foo.bar/status?full -; http://www.foo.bar/status?json&full -; http://www.foo.bar/status?html&full -; http://www.foo.bar/status?xml&full -; The Full status returns for each process: -; pid - the PID of the process; -; state - the state of the process (Idle, Running, ...); -; start time - the date and time the process has started; -; start since - the number of seconds since the process has started; -; requests - the number of requests the process has served; -; request duration - the duration in µs of the requests; -; request method - the request method (GET, POST, ...); -; request URI - the request URI with the query string; -; content length - the content length of the request (only with POST); -; user - the user (PHP_AUTH_USER) (or '-' if not set); -; script - the main script called (or '-' if not set); -; last request cpu - the %cpu the last request consumed -; it's always 0 if the process is not in Idle state -; because CPU calculation is done when the request -; processing has terminated; -; last request memory - the max amount of memory the last request consumed -; it's always 0 if the process is not in Idle state -; because memory calculation is done when the request -; processing has terminated; -; If the process is in Idle state, then informations are related to the -; last request the process has served. Otherwise informations are related to -; the current request being served. -; Example output: -; ************************ -; pid: 31330 -; state: Running -; start time: 01/Jul/2011:17:53:49 +0200 -; start since: 63087 -; requests: 12808 -; request duration: 1250261 -; request method: GET -; request URI: /test_mem.php?N=10000 -; content length: 0 -; user: - -; script: /home/fat/web/docs/php/test_mem.php -; last request cpu: 0.00 -; last request memory: 0 -; -; Note: There is a real-time FPM status monitoring sample web page available -; It's available in: /usr/share/php/7.0/fpm/status.html -; -; Note: The value must start with a leading slash (/). The value can be -; anything, but it may not be a good idea to use the .php extension or it -; may conflict with a real PHP file. -; Default Value: not set -;pm.status_path = /status - -; The ping URI to call the monitoring page of FPM. If this value is not set, no -; URI will be recognized as a ping page. This could be used to test from outside -; that FPM is alive and responding, or to -; - create a graph of FPM availability (rrd or such); -; - remove a server from a group if it is not responding (load balancing); -; - trigger alerts for the operating team (24/7). -; Note: The value must start with a leading slash (/). The value can be -; anything, but it may not be a good idea to use the .php extension or it -; may conflict with a real PHP file. -; Default Value: not set -;ping.path = /ping - -; This directive may be used to customize the response of a ping request. The -; response is formatted as text/plain with a 200 response code. -; Default Value: pong -;ping.response = pong - -; The access log file -; Default: not set -;access.log = log/$pool.access.log - -; The access log format. -; The following syntax is allowed -; %%: the '%' character -; %C: %CPU used by the request -; it can accept the following format: -; - %{user}C for user CPU only -; - %{system}C for system CPU only -; - %{total}C for user + system CPU (default) -; %d: time taken to serve the request -; it can accept the following format: -; - %{seconds}d (default) -; - %{miliseconds}d -; - %{mili}d -; - %{microseconds}d -; - %{micro}d -; %e: an environment variable (same as $_ENV or $_SERVER) -; it must be associated with embraces to specify the name of the env -; variable. Some exemples: -; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e -; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e -; %f: script filename -; %l: content-length of the request (for POST request only) -; %m: request method -; %M: peak of memory allocated by PHP -; it can accept the following format: -; - %{bytes}M (default) -; - %{kilobytes}M -; - %{kilo}M -; - %{megabytes}M -; - %{mega}M -; %n: pool name -; %o: output header -; it must be associated with embraces to specify the name of the header: -; - %{Content-Type}o -; - %{X-Powered-By}o -; - %{Transfert-Encoding}o -; - .... -; %p: PID of the child that serviced the request -; %P: PID of the parent of the child that serviced the request -; %q: the query string -; %Q: the '?' character if query string exists -; %r: the request URI (without the query string, see %q and %Q) -; %R: remote IP address -; %s: status (response code) -; %t: server time the request was received -; it can accept a strftime(3) format: -; %d/%b/%Y:%H:%M:%S %z (default) -; The strftime(3) format must be encapsuled in a %{}t tag -; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t -; %T: time the log has been written (the request has finished) -; it can accept a strftime(3) format: -; %d/%b/%Y:%H:%M:%S %z (default) -; The strftime(3) format must be encapsuled in a %{}t tag -; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t -; %u: remote user -; -; Default: "%R - %u %t \"%m %r\" %s" -;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%" - -; The log file for slow requests -; Default Value: not set -; Note: slowlog is mandatory if request_slowlog_timeout is set -;slowlog = log/$pool.log.slow - -; The timeout for serving a single request after which a PHP backtrace will be -; dumped to the 'slowlog' file. A value of '0s' means 'off'. -; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) -; Default Value: 0 -;request_slowlog_timeout = 0 - -; The timeout for serving a single request after which the worker process will -; be killed. This option should be used when the 'max_execution_time' ini option -; does not stop script execution for some reason. A value of '0' means 'off'. -; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) -; Default Value: 0 -request_terminate_timeout = 1d - -; Set open file descriptor rlimit. -; Default Value: system defined value -;rlimit_files = 1024 - -; Set max core size rlimit. -; Possible Values: 'unlimited' or an integer greater or equal to 0 -; Default Value: system defined value -;rlimit_core = 0 - -; Chroot to this directory at the start. This value must be defined as an -; absolute path. When this value is not set, chroot is not used. -; Note: you can prefix with '$prefix' to chroot to the pool prefix or one -; of its subdirectories. If the pool prefix is not set, the global prefix -; will be used instead. -; Note: chrooting is a great security feature and should be used whenever -; possible. However, all PHP paths will be relative to the chroot -; (error_log, sessions.save_path, ...). -; Default Value: not set -;chroot = - -; Chdir to this directory at the start. -; Note: relative path can be used. -; Default Value: current directory or / when chroot -chdir = __FINALPATH__ - -; Redirect worker stdout and stderr into main error log. If not set, stdout and -; stderr will be redirected to /dev/null according to FastCGI specs. -; Note: on highloaded environement, this can cause some delay in the page -; process time (several ms). -; Default Value: no -;catch_workers_output = yes - -; Clear environment in FPM workers -; Prevents arbitrary environment variables from reaching FPM worker processes -; by clearing the environment in workers before env vars specified in this -; pool configuration are added. -; Setting to "no" will make all environment variables available to PHP code -; via getenv(), $_ENV and $_SERVER. -; Default Value: yes -;clear_env = no - -; Limits the extensions of the main script FPM will allow to parse. This can -; prevent configuration mistakes on the web server side. You should only limit -; FPM to .php extensions to prevent malicious users to use other extensions to -; execute php code. -; Note: set an empty value to allow all extensions. -; Default Value: .php -;security.limit_extensions = .php .php3 .php4 .php5 .php7 - -; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from -; the current environment. -; Default Value: clean env -;env[HOSTNAME] = $HOSTNAME -;env[PATH] = /usr/local/bin:/usr/bin:/bin -;env[TMP] = /tmp -;env[TMPDIR] = /tmp -;env[TEMP] = /tmp - -; Additional php.ini defines, specific to this pool of workers. These settings -; overwrite the values previously defined in the php.ini. The directives are the -; same as the PHP SAPI: -; php_value/php_flag - you can set classic ini defines which can -; be overwritten from PHP call 'ini_set'. -; php_admin_value/php_admin_flag - these directives won't be overwritten by -; PHP call 'ini_set' -; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. - -; Defining 'extension' will load the corresponding shared extension from -; extension_dir. Defining 'disable_functions' or 'disable_classes' will not -; overwrite previously defined php.ini values, but will append the new value -; instead. - -; Note: path INI options can be relative and will be expanded with the prefix -; (pool, global or /usr) - -; Default Value: nothing is defined by default except the values in php.ini and -; specified at startup with the -d argument -;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com -;php_flag[display_errors] = off -;php_admin_value[error_log] = /var/log/fpm-php.www.log -;php_admin_flag[log_errors] = on -;php_admin_value[memory_limit] = 32M - -; Common values to change to increase file upload limit -php_admin_value[upload_max_filesize] = 10G -php_admin_value[post_max_size] = 10G -; php_admin_flag[mail.add_x_header] = Off - -; Other common parameters -; php_admin_value[max_execution_time] = 600 -; php_admin_value[max_input_time] = 300 -; php_admin_value[memory_limit] = 256M -; php_admin_flag[short_open_tag] = On diff --git a/config_panel.toml b/config_panel.toml new file mode 100644 index 0000000..76063aa --- /dev/null +++ b/config_panel.toml @@ -0,0 +1,30 @@ +version = "1.0" + +[main] +name = "Jirafeau configuration" + + [main.php_fpm_config] + name = "PHP-FPM configuration" + + [main.php_fpm_config.fpm_footprint] + ask = "Memory footprint" + type = "select" + choices.low = "Low, <= 20Mb per pool" + choices.medium = "Medium, between 20Mb and 40Mb per pool" + choices.high = "High, > 40Mb per pool" + choices.specific = "Use specific value" + default = "low" + + [main.php_fpm_config.fpm_free_footprint] + visible = "fpm_footprint == 'specific'" + ask = "Memory footprint of the service?" + type = "number" + default = "0" + help = "Free field to specify exactly the footprint in Mb if you don't want to use one of the three previous values." + + [main.php_fpm_config.fpm_usage] + ask = "Expected usage" + type = "select" + choices = ["low", "medium", "high"] + default = "low" + help = "low: Personal usage, behind the SSO. No RAM footprint when not used, but the impact on the processor can be high if many users are using the service.
medium: Low usage, few people or/and publicly accessible. Low RAM footprint, medium processor footprint when used.
high: High usage, frequently visited website. High RAM footprint, but lower on processor usage and quickly responding." diff --git a/scripts/config b/scripts/config new file mode 100644 index 0000000..91c2de7 --- /dev/null +++ b/scripts/config @@ -0,0 +1,95 @@ +#!/bin/bash + +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source _common.sh +source /usr/share/yunohost/helpers + +ynh_abort_if_errors + +#================================================= +# RETRIEVE ARGUMENTS +#================================================= + +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) +current_fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) + +#================================================= +# SPECIFIC GETTERS FOR TOML SHORT KEY +#================================================= + +get__fpm_footprint() { + # Free footprint value for php-fpm + # Check if current_fpm_footprint is an integer + if [ "$current_fpm_footprint" -eq "$current_fpm_footprint" ] 2> /dev/null + then + echo "specific" + else + echo "$current_fpm_footprint" + fi +} + +get__free_footprint() { + # Free footprint value for php-fpm + # Check if current_fpm_footprint is an integer + if [ "$current_fpm_footprint" -eq "$current_fpm_footprint" ] 2> /dev/null + then + # If current_fpm_footprint is an integer, that's a numeric value for the footprint + echo "$current_fpm_footprint" + else + echo "0" + fi +} + +#================================================= +# SPECIFIC SETTERS FOR TOML SHORT KEYS +#================================================= + +set__fpm_footprint() { + if [ "$fpm_footprint" != "specific" ] + then + ynh_app_setting_set --app=$app --key=fpm_footprint --value="$fpm_footprint" + fi +} + +set__fpm_free_footprint() { + if [ "$fpm_footprint" = "specific" ] + then + ynh_app_setting_set --app=$app --key=fpm_footprint --value="$fpm_free_footprint" + fi +} + +#================================================= +# GENERIC FINALIZATION +#================================================= + +ynh_app_config_validate() { + _ynh_app_config_validate + + if [ "${changed[fpm_usage]}" == "true" ] || [ "${changed[fpm_footprint]}" == "true" ] || [ "${changed[fpm_free_footprint]}" == "true" ]; then + # If fpm_footprint is set to 'specific', use $fpm_free_footprint value. + if [ "$fpm_footprint" = "specific" ] + then + fpm_footprint=$fpm_free_footprint + fi + + if [ "$fpm_footprint" == "0" ] + then + ynh_print_err --message="When selecting 'specific', you have to set a footprint value into the field below." + + exit 0 + fi + fi +} + +ynh_app_config_apply() { + _ynh_app_config_apply + + ynh_add_fpm_config --phpversion=$phpversion --usage=$fpm_usage --footprint=$fpm_footprint +} + +ynh_app_config_run $1 diff --git a/scripts/install b/scripts/install index efe088b..f167875 100755 --- a/scripts/install +++ b/scripts/install @@ -29,9 +29,14 @@ path_url=$YNH_APP_ARG_PATH is_public=$YNH_APP_ARG_IS_PUBLIC admin_user=$YNH_APP_ARG_ADMIN_USER upload_password=$YNH_APP_ARG_UPLOAD_PASSWORD +phpversion=$YNH_PHP_VERSION app=$YNH_APP_INSTANCE_NAME +fpm_footprint="low" +fpm_free_footprint=0 +fpm_usage="low" + #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= @@ -53,6 +58,9 @@ ynh_app_setting_set --app=$app --key=path --value=$path_url ynh_app_setting_set --app=$app --key=admin --value=$admin_user ynh_app_setting_set --app=$app --key=is_public --value=$is_public ynh_app_setting_set --app=$app --key=upload_password --value="$upload_password" +ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint +ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint +ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage #================================================= # STANDARD MODIFICATIONS @@ -93,7 +101,8 @@ chown -R $app:www-data "$final_path" ynh_script_progression --message="Configuring PHP-FPM..." --weight=2 # Create a dedicated PHP-FPM config -ynh_add_fpm_config +ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # NGINX CONFIGURATION diff --git a/scripts/restore b/scripts/restore index c21f1a7..24f96cd 100644 --- a/scripts/restore +++ b/scripts/restore @@ -34,6 +34,9 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) datadir=$(ynh_app_setting_get --app=$app --key=datadir) +fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) +fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage) + #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= @@ -91,6 +94,9 @@ ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weig ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" +# Recreate a dedicated php-fpm config +ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint --phpversion=$phpversion + #================================================= # RESTORE THE NGINX CONFIGURATION #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 6b21736..c784aee 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -25,6 +25,10 @@ upload_password=$(ynh_app_setting_get --app=$app --key=upload_password) phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) datadir=$(ynh_app_setting_get --app=$app --key=datadir) +fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) +fpm_free_footprint=$(ynh_app_setting_get --app=$app --key=fpm_free_footprint) +fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage) + #================================================= # CHECK VERSION #================================================= @@ -65,6 +69,24 @@ if [ -z "$datadir" ]; then ynh_app_setting_set --app=$app --key=datadir --value=$datadir fi +# If fpm_footprint doesn't exist, create it +if [ -z "$fpm_footprint" ]; then + fpm_footprint=low + ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint +fi + +# If fpm_free_footprint doesn't exist, create it +if [ -z "$fpm_free_footprint" ]; then + fpm_free_footprint=0 + ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint +fi + +# If fpm_usage doesn't exist, create it +if [ -z "$fpm_usage" ]; then + fpm_usage=low + ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage +fi + ynh_permission_update --permission="main" --add="visitors" if [ $is_public -eq 0 ] @@ -114,7 +136,8 @@ ynh_install_app_dependencies $pkg_dependencies ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=2 # Create a dedicated PHP-FPM config -ynh_add_fpm_config +ynh_add_fpm_config --phpversion=$phpversion --usage=$fpm_usage --footprint=$fpm_footprint +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # NGINX CONFIGURATION From dc7669924595804825fc3755f667bfbf1965911e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Tue, 4 Apr 2023 18:50:46 +0200 Subject: [PATCH 14/20] Version 2 (#105) * v2 * Auto-update README * v2 * Auto-update README * Update upgrade --------- Co-authored-by: yunohost-bot --- README.md | 14 +--- README_fr.md | 30 +++---- check_process | 27 ------ conf/app.src | 5 -- conf/config.local.php | 2 +- conf/cron | 4 +- conf/nginx.conf | 2 +- doc/{DISCLAIMER.md => ADMIN.md} | 2 +- doc/{DISCLAIMER_fr.md => ADMIN_fr.md} | 2 +- manifest.json | 67 --------------- manifest.toml | 67 +++++++++++++++ scripts/_common.sh | 5 -- scripts/backup | 23 +----- scripts/change_url | 87 +------------------- scripts/install | 114 ++------------------------ scripts/remove | 50 ----------- scripts/restore | 68 ++------------- scripts/upgrade | 96 ++-------------------- tests.toml | 14 ++++ 19 files changed, 124 insertions(+), 555 deletions(-) delete mode 100644 check_process delete mode 100644 conf/app.src rename doc/{DISCLAIMER.md => ADMIN.md} (92%) rename doc/{DISCLAIMER_fr.md => ADMIN_fr.md} (91%) delete mode 100644 manifest.json create mode 100644 manifest.toml create mode 100644 tests.toml diff --git a/README.md b/README.md index f5f5463..96a47d5 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ It shall NOT be edited by hand. # Jirafeau for YunoHost -[![Integration level](https://dash.yunohost.org/integration/jirafeau.svg)](https://dash.yunohost.org/appci/app/jirafeau) ![Working status](https://ci-apps.yunohost.org/ci/badges/jirafeau.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/jirafeau.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/jirafeau.svg)](https://dash.yunohost.org/appci/app/jirafeau) ![Working status](https://ci-apps.yunohost.org/ci/badges/jirafeau.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/jirafeau.maintain.svg) + [![Install Jirafeau with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jirafeau) *[Lire ce readme en français.](./README_fr.md)* @@ -26,17 +27,6 @@ Jirafeau offers the possibility to host and share your files with ease. Choose a ![Screenshot of Jirafeau](./doc/screenshots/TPjh48P.png) -## Disclaimers / important information - -## Configuration - -### Changing the conditions of use of the service - -The license text on the "Terms of Service" page, which is shipped with the default installation, is "based on the Open Source Initiative Terms of Service". To change this text simply copy the file `/lib/tos.original.txt`, rename it to `/lib/tos.local.txt` and adapt it to your own needs. If you update the installation, then only the `tos.original.txt` file may change eventually, not your `tos.local.txt file`. - -## Administration - -To administer the files within Jirafeau it is enough to go to the address `jirafeau.domaine.tld/admin.php`. ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 5ec6c8f..61c9d4e 100644 --- a/README_fr.md +++ b/README_fr.md @@ -5,15 +5,16 @@ It shall NOT be edited by hand. # Jirafeau pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/jirafeau.svg)](https://dash.yunohost.org/appci/app/jirafeau) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/jirafeau.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/jirafeau.maintain.svg) +[![Niveau d’intégration](https://dash.yunohost.org/integration/jirafeau.svg)](https://dash.yunohost.org/appci/app/jirafeau) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/jirafeau.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/jirafeau.maintain.svg) + [![Installer Jirafeau avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jirafeau) *[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer Jirafeau 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 Jirafeau 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 +## Vue d’ensemble Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout en toute simplicité. Choisissez un fichier, Jirafeau vous fournira un lien avec beaucoup d'options. Il est possible de protéger vos liens avec mot de passe ainsi que de choisir la durée de rétention du fichier sur le serveur. Le fichier et le lien s'autodétruiront passé ce délai. Les téléchargements des fichiers transmis peuvent être limités à une certaine date, et chaque fichier peut s'autodétruire après le premier téléchargement. Jirafeau permet de configurer les temps maximum de rétention ainsi que la taille maximale par fichier. Le chiffrement est disponible en option. @@ -22,25 +23,14 @@ Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout **Démo :** https://demo.yunohost.org/jirafeau/ -## Captures d'écran +## Captures d’écran -![Capture d'écran de Jirafeau](./doc/screenshots/TPjh48P.png) +![Capture d’écran de Jirafeau](./doc/screenshots/TPjh48P.png) -## Avertissements / informations importantes - -## Configuration - -### Changer les conditions d'utilisation du service - -Le texte de la licence sur la page "Conditions d'utilisation du service", qui est livrée avec l'installation par défaut, est basé sur les "Conditions d'utilisation du service de l'Initiative Open Source". Pour modifier ce texte, il suffit de copier le fichier `/lib/tos.original.txt`, de le renommer en `/lib/tos.local.txt` et de l'adapter à vos propres besoins. Si vous mettez à jour l'installation, alors seul le fichier `tos.original.txt` peut changer éventuellement, et non votre fichier `tos.local.txt`. - -## Administration - -Pour administrer les fichiers présents au sein de Jirafeau il suffit de se rendre à l'adresse `jirafeau.domaine.tld/admin.php`. ## Documentations et ressources -* Site officiel de l'app : -* Dépôt de code officiel de l'app : +* Site officiel de l’app : +* Dépôt de code officiel de l’app : * Documentation YunoHost pour cette app : * Signaler un bug : @@ -56,4 +46,4 @@ ou sudo yunohost app upgrade jirafeau -u https://github.com/YunoHost-Apps/jirafeau_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file diff --git a/check_process b/check_process deleted file mode 100644 index de43600..0000000 --- a/check_process +++ /dev/null @@ -1,27 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - is_public=1 - admin_user="package_checker" - upload_password="supersecretpassword" - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - #4.3.0~ynh3 - upgrade=1 from_commit=0615fbcfa5b163812657b2f291026bf24b5e0667 - backup_restore=1 - multi_instance=0 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none -;;; Upgrade options - ; commit=0615fbcfa5b163812657b2f291026bf24b5e0667 - name=Merge pull request #92 diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index 1fc4741..0000000 --- a/conf/app.src +++ /dev/null @@ -1,5 +0,0 @@ -SOURCE_URL=https://gitlab.com/mojo42/Jirafeau/-/archive/4.5.0/Jirafeau-4.5.0.tar.gz -SOURCE_SUM=cc164f086b65c810cefc0eb26bffa6718a12a56ea94b7717d7eba8281d6c66ac -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true diff --git a/conf/config.local.php b/conf/config.local.php index e413d82..5d9833f 100644 --- a/conf/config.local.php +++ b/conf/config.local.php @@ -31,7 +31,7 @@ $cfg['web_root'] = 'https://' . '__DOMAIN__' . '__JIRAFEAU_PATH__' . '/'; /* Path to data directory, with trailing slash (eg. »/var/www/data/var_314159265358979323846264« */ -$cfg['var_root'] = '__DATADIR__' . '/'; +$cfg['var_root'] = '__DATA_DIR__' . '/'; /* Language - choice between 'auto' or any language located in the /lib/locales/ folder. * The mode »auto« will cause the script to detect the user's browser information diff --git a/conf/cron b/conf/cron index 2498395..1911e81 100644 --- a/conf/cron +++ b/conf/cron @@ -1,4 +1,4 @@ # https://gitlab.com/mojo42/Jirafeau/#how-can-i-automatize-the-cleaning-of-old-expired-files -12 3 * * * __APP__ /usr/bin/php__PHPVERSION__ __FINALPATH__/admin.php clean_expired -16 3 * * * __APP__ /usr/bin/php__PHPVERSION__ __FINALPATH__/admin.php clean_async +12 3 * * * __APP__ /usr/bin/php__PHPVERSION__ __INSTALL_DIR__/admin.php clean_expired +16 3 * * * __APP__ /usr/bin/php__PHPVERSION__ __INSTALL_DIR__/admin.php clean_async diff --git a/conf/nginx.conf b/conf/nginx.conf index 0fd8d69..b2c4482 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -2,7 +2,7 @@ location __PATH__/ { # Path to source - alias __FINALPATH__/; + alias __INSTALL_DIR__/; index index.php; diff --git a/doc/DISCLAIMER.md b/doc/ADMIN.md similarity index 92% rename from doc/DISCLAIMER.md rename to doc/ADMIN.md index e2c3b48..e05b4dc 100644 --- a/doc/DISCLAIMER.md +++ b/doc/ADMIN.md @@ -6,4 +6,4 @@ The license text on the "Terms of Service" page, which is shipped with the defau ## Administration -To administer the files within Jirafeau it is enough to go to the address `jirafeau.domaine.tld/admin.php`. \ No newline at end of file +To administer the files within Jirafeau it is enough to go to the address `__DOMAIN__/admin.php`. \ No newline at end of file diff --git a/doc/DISCLAIMER_fr.md b/doc/ADMIN_fr.md similarity index 91% rename from doc/DISCLAIMER_fr.md rename to doc/ADMIN_fr.md index 1e3e5db..69070fb 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/ADMIN_fr.md @@ -6,4 +6,4 @@ Le texte de la licence sur la page "Conditions d'utilisation du service", qui es ## Administration -Pour administrer les fichiers présents au sein de Jirafeau il suffit de se rendre à l'adresse `jirafeau.domaine.tld/admin.php`. \ No newline at end of file +Pour administrer les fichiers présents au sein de Jirafeau il suffit de se rendre à l'adresse `__DOMAIN__/admin.php`. \ No newline at end of file diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 392464f..0000000 --- a/manifest.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "name": "Jirafeau", - "id": "jirafeau", - "packaging_format": 1, - "description": { - "en": "Upload a file in a simple way and give a unique link to it", - "fr": "Hébergez simplement un fichier et partagez-le avec un lien unique" - }, - "version": "4.5.0~ynh1", - "url": "https://gitlab.com/mojo42/Jirafeau", - "upstream": { - "license": "AGPL-3.0-only", - "website": "https://gitlab.com/mojo42/Jirafeau", - "demo": "https://demo.yunohost.org/jirafeau/", - "code": "https://gitlab.com/mojo42/Jirafeau", - "cpe": "cpe:2.3:a:jirafeau:jirafeau" - }, - "license": "AGPL-3.0-only", - "maintainer": { - "name": "", - "email": "" - }, - "requirements": { - "yunohost": ">= 11.0.9" - }, - "multi_instance": false, - "services": [ - "nginx", - "php8.0-fpm" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/jirafeau", - "default": "/jirafeau" - }, - { - "name": "is_public", - "type": "boolean", - "default": true - }, - { - "name": "admin_user", - "type": "user", - "ask": { - "en": "Choose an admin user (will be able to access admin.php page)", - "fr": "Choisissez l'administrateur (seul autorisé à accéder à la page admin.php)" - } - }, - { - "name": "upload_password", - "type": "password", - "optional": true, - "ask": { - "en": "Set the password granting upload permissions (leave empty to allow anybody to upload). Please avoid using ' (quotes) in the password as it will fail the app...", - "fr": "Définissez le mot de passe permettant l'accès à l'envoi de fichiers (laissez vide pour autoriser tout le monde). Veuillez éviter d'utiliser ' (guillemets) dans le mot de passe car cela fera échouer l'application..." - } - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..12c8f01 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,67 @@ +packaging_format = 2 + +id = "jirafeau" +name = "Jirafeau" +description.en = "Upload a file in a simple way and give a unique link to it" +description.fr = "Hébergez simplement un fichier et partagez-le avec un lien unique" + +version = "4.5.0~ynh1" + +maintainers = [] + +[upstream] +license = "AGPL-3.0-only" +website = "https://gitlab.com/mojo42/Jirafeau" +demo = "https://demo.yunohost.org/jirafeau/" +code = "https://gitlab.com/mojo42/Jirafeau" + +[integration] +yunohost = ">= 11.1.16" +architectures = "all" +multi_instance = false +ldap = false +sso = false +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/jirafeau" + + [install.init_main_permission] + type = "group" + default = "visitors" + + [install.admin_user] + ask.en = "Choose an admin user (will be able to access admin.php page)" + ask.fr = "Choisissez l'administrateur (seul autorisé à accéder à la page admin.php)" + type = "user" + + [install.upload_password] + ask.en = "Set the password granting upload permissions (leave empty to allow anybody to upload). Please avoid using ' (quotes) in the password as it will fail the app..." + ask.fr = "Définissez le mot de passe permettant l'accès à l'envoi de fichiers (laissez vide pour autoriser tout le monde). Veuillez éviter d'utiliser ' (guillemets) dans le mot de passe car cela fera échouer l'application..." + type = "password" + optional = true + +[resources] + [resources.sources.main] + url = "https://gitlab.com/mojo42/Jirafeau/-/archive/4.5.0/Jirafeau-4.5.0.tar.gz" + sha256 = "cc164f086b65c810cefc0eb26bffa6718a12a56ea94b7717d7eba8281d6c66ac" + + [resources.system_user] + + [resources.install_dir] + + [resources.data_dir] + subdirs = ["files", "links", "async", "block"] + + [resources.permissions] + main.url = "/" + + [resources.apt] + packages = "php8.0-fpm" diff --git a/scripts/_common.sh b/scripts/_common.sh index eb3783f..944a65e 100755 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,11 +4,6 @@ # COMMON VARIABLES #================================================= -YNH_PHP_VERSION="8.0" - -# dependencies used by the app -pkg_dependencies="php$YNH_PHP_VERSION-fpm" - #================================================= # PERSONAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index b2de5fd..3d4fbfa 100644 --- a/scripts/backup +++ b/scripts/backup @@ -10,25 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -38,13 +19,13 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP THE DATA DIR #================================================= -ynh_backup --src_path="$datadir" --is_big +ynh_backup --src_path="$data_dir" --is_big #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index 03c62f8..024ad3a 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,58 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. - ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -68,45 +16,14 @@ fi #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2 -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# Change the path in the NGINX config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original NGINX config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated NGINX config - ynh_add_nginx_config -fi - -# Change the domain for nginx -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location - ynh_delete_file_checksum --file="$nginx_conf_path" - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location - ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi +ynh_change_url_nginx_config #================================================= # SPECIFIC MODIFICATIONS #================================================= # Change domain name in parameters.yml -ynh_replace_string --match_string="\$cfg\['web_root'\] = .*" --replace_string="\$cfg['web_root'] = 'https://' . '$new_domain' . '${new_path%/}' . '/';" --target_file="$final_path/lib/config.local.php" - -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." - -ynh_systemd_action --service_name=nginx --action=reload +ynh_replace_string --match_string="\$cfg\['web_root'\] = .*" --replace_string="\$cfg['web_root'] = 'https://' . '$new_domain' . '${new_path%/}' . '/';" --target_file="$install_dir/lib/config.local.php" #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index f167875..a128137 100755 --- a/scripts/install +++ b/scripts/install @@ -9,91 +9,35 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -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 -ynh_abort_if_errors - #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC -admin_user=$YNH_APP_ARG_ADMIN_USER -upload_password=$YNH_APP_ARG_UPLOAD_PASSWORD -phpversion=$YNH_PHP_VERSION - -app=$YNH_APP_INSTANCE_NAME - fpm_footprint="low" fpm_free_footprint=0 fpm_usage="low" -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - #================================================= # STORE SETTINGS FROM MANIFEST #================================================= -ynh_script_progression --message="Storing installation settings..." --weight=1 -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url -ynh_app_setting_set --app=$app --key=admin --value=$admin_user -ynh_app_setting_set --app=$app --key=is_public --value=$is_public -ynh_app_setting_set --app=$app --key=upload_password --value="$upload_password" ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." --weight=2 - -ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=2 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=3 -ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$final_path" +ynh_setup_source --dest_dir="$install_dir" # Remove the install.php -ynh_secure_remove --file=$final_path/install.php +ynh_secure_remove --file=$install_dir/install.php -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # PHP-FPM CONFIGURATION @@ -102,7 +46,6 @@ ynh_script_progression --message="Configuring PHP-FPM..." --weight=2 # Create a dedicated PHP-FPM config ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # NGINX CONFIGURATION @@ -112,38 +55,22 @@ ynh_script_progression --message="Configuring NGINX web server..." # Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# SPECIFIC SETUP -#================================================= -# CREATE DATA DIRECTORY -#================================================= -ynh_script_progression --message="Creating a data directory..." --weight=1 - -datadir=/home/yunohost.app/$app -ynh_app_setting_set --app=$app --key=datadir --value=$datadir - -mkdir -p $datadir/{files,links,async,block} - -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" - #================================================= # ADD A CONFIGURATION #================================================= ynh_script_progression --message="Adding a configuration file..." --weight=2 -if [ "$path_url" = "/" ] +if [ "$path" = "/" ] then jirafeau_path="" else - jirafeau_path="$path_url" + jirafeau_path="$path" fi -ynh_add_config --template="../conf/config.local.php" --destination="$final_path/lib/config.local.php" +ynh_add_config --template="../conf/config.local.php" --destination="$install_dir/lib/config.local.php" -chmod 400 "$final_path/lib/config.local.php" -chown $app:$app "$final_path/lib/config.local.php" +chmod 400 "$install_dir/lib/config.local.php" +chown $app:$app "$install_dir/lib/config.local.php" #================================================= # SET THE CRON FILE @@ -155,29 +82,6 @@ ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app" chown root: "/etc/cron.d/$app" chmod 644 "/etc/cron.d/$app" -#================================================= -# GENERIC FINALIZATION -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=2 - -ynh_permission_update --permission="main" --add="visitors" - -if [ $is_public -eq 0 ] -then - domain_regex=$(echo "$domain" | sed 's@-@.@g') - [ "$path_url" = "/" ] && path_url="" - ynh_app_setting_set --app=$app --key=protected_regex --value="$domain_regex$path_url/$","$domain_regex$path_url/admin.php.*$" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index 213ae23..f049192 100755 --- a/scripts/remove +++ b/scripts/remove @@ -9,38 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation 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) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=2 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - -#================================================= -# REMOVE DATA DIR -#================================================= - -# Remove the data directory if --purge option is used -if [ "${YNH_APP_PURGE:-0}" -eq 1 ] -then - ynh_script_progression --message="Removing app data directory..." --weight=1 - ynh_secure_remove --file="$datadir" -fi - #================================================= # REMOVE NGINX CONFIGURATION #================================================= @@ -57,14 +25,6 @@ ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=2 # Remove the dedicated PHP-FPM config ynh_remove_fpm_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=3 - -# Remove metapackage and its dependencies -ynh_remove_app_dependencies - #================================================= # SPECIFIC REMOVE #================================================= @@ -75,16 +35,6 @@ ynh_script_progression --message="Removing various files..." --weight=1 # Remove a cron file ynh_secure_remove --file="/etc/cron.d/$app" -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=2 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index 24f96cd..cef09fb 100644 --- a/scripts/restore +++ b/scripts/restore @@ -10,82 +10,24 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -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 -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=2 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) - -fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) -fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=1 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -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" - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=2 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # RESTORE THE DATA DIRECTORY #================================================= ynh_script_progression --message="Restoring the data directory..." --weight=1 -ynh_restore_file --origin_path="$datadir" --not_mandatory +ynh_restore_file --origin_path="$data_dir" --not_mandatory -mkdir -p "$datadir/{files,links,async,block}" - -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" - -#================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=3 - -# Define and install dependencies -ynh_install_app_dependencies $pkg_dependencies +chown -R $app:www-data "$data_dir" #================================================= # RESTORE THE PHP-FPM CONFIGURATION diff --git a/scripts/upgrade b/scripts/upgrade index c784aee..ce0cdae 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,47 +9,12 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=2 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -admin_user=$(ynh_app_setting_get --app=$app --key=admin) -is_public=$(ynh_app_setting_get --app=$app --key=is_public) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -upload_password=$(ynh_app_setting_get --app=$app --key=upload_password) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) - -fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) -fpm_free_footprint=$(ynh_app_setting_get --app=$app --key=fpm_free_footprint) -fpm_usage=$(ynh_app_setting_get --app=$app --key=fpm_usage) - #================================================= # CHECK VERSION #================================================= -ynh_script_progression --message="Checking version..." upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=3 - -# 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 - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -57,53 +22,24 @@ ynh_abort_if_errors #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -# If final_path doesn't exist, create it -if [ -z "$final_path" ]; then - final_path=/var/www/$app - ynh_app_setting_set --app=$app --key=final_path --value=$final_path -fi - -# If datadir doesn't exist, create it -if [ -z "$datadir" ]; then - datadir=/home/yunohost.app/$app - ynh_app_setting_set --app=$app --key=datadir --value=$datadir -fi - # If fpm_footprint doesn't exist, create it -if [ -z "$fpm_footprint" ]; then +if [ -z "${fpm_footprint:-}" ]; then fpm_footprint=low ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint fi # If fpm_free_footprint doesn't exist, create it -if [ -z "$fpm_free_footprint" ]; then +if [ -z "${fpm_free_footprint:-}" ]; then fpm_free_footprint=0 ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint fi # If fpm_usage doesn't exist, create it -if [ -z "$fpm_usage" ]; then +if [ -z "${fpm_usage:-}" ]; then fpm_usage=low ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage fi -ynh_permission_update --permission="main" --add="visitors" - -if [ $is_public -eq 0 ] -then - domain_regex=$(echo "$domain" | sed 's@-@.@g') - [ "$path_url" = "/" ] && path_url_="" || path_url_="$path_url" - ynh_app_setting_set --app=$app --key=protected_regex --value="$domain_regex$path_url_/$","$domain_regex$path_url_/admin.php.*$" -fi - -#================================================= -# 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 --home_dir="$final_path" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -113,22 +49,14 @@ then ynh_script_progression --message="Upgrading source files..." --weight=2 # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" --keep="lib/config.local.php" + ynh_setup_source --dest_dir="$install_dir" --keep="lib/config.local.php" # Remove the install.php - ynh_secure_remove --file=$final_path/install.php + ynh_secure_remove --file=$install_dir/install.php fi -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=3 - -ynh_install_app_dependencies $pkg_dependencies +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # PHP-FPM CONFIGURATION @@ -137,7 +65,6 @@ ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=2 # Create a dedicated PHP-FPM config ynh_add_fpm_config --phpversion=$phpversion --usage=$fpm_usage --footprint=$fpm_footprint -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # NGINX CONFIGURATION @@ -158,15 +85,6 @@ ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app" chown root: "/etc/cron.d/$app" chmod 644 "/etc/cron.d/$app" -#================================================= -# GENERIC FINALIZATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..b41e35a --- /dev/null +++ b/tests.toml @@ -0,0 +1,14 @@ +test_format = 1.0 + +[default] + + + args.admin_user = "package_checker" + args.upload_password = "supersecretpassword" + + + # ------------------------------- + # Commits to test upgrade from + # ------------------------------- + + test_upgrade_from.0615fbcf.name = "Upgrade from 4.3.0~ynh3" \ No newline at end of file From 7166dba946db36b7144e29d2d5b061f7e958e092 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Fri, 28 Jul 2023 07:46:15 +0100 Subject: [PATCH 15/20] add crypt (#106) * add crypt * Update manifest.toml * Update install * cleaning --- conf/config.local.php | 2 +- config_panel.toml | 11 +++++++++++ doc/ADMIN.md | 4 +--- doc/ADMIN_fr.md | 4 +--- manifest.toml | 2 +- scripts/install | 3 +++ scripts/upgrade | 6 ++++++ 7 files changed, 24 insertions(+), 8 deletions(-) diff --git a/conf/config.local.php b/conf/config.local.php index 5d9833f..038428c 100644 --- a/conf/config.local.php +++ b/conf/config.local.php @@ -62,7 +62,7 @@ $cfg['preview'] = true; /* Enable the encryption feature * By enabling it, file-level deduplication won't work anymore. See FAQ. */ -$cfg['enable_crypt'] = false; +$cfg['enable_crypt'] = __ENABLE_CRYPT__; /* Length of link reference */ diff --git a/config_panel.toml b/config_panel.toml index 76063aa..165603d 100644 --- a/config_panel.toml +++ b/config_panel.toml @@ -3,6 +3,17 @@ version = "1.0" [main] name = "Jirafeau configuration" + [main.encrypt] + name = "Encryption feature" + + [main.encrypt.enable_crypt] + ask = "Enable the encryption feature" + type = "boolean" + yes = true + no = false + help = "By enabling encryption feature, file-level deduplication won't work anymore." + bind = "ENABLE_CRYPT:__INSTALL_DIR__/lib/config.local.php" + [main.php_fpm_config] name = "PHP-FPM configuration" diff --git a/doc/ADMIN.md b/doc/ADMIN.md index e05b4dc..ae32d51 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -1,9 +1,7 @@ -## Configuration - ### Changing the conditions of use of the service The license text on the "Terms of Service" page, which is shipped with the default installation, is "based on the Open Source Initiative Terms of Service". To change this text simply copy the file `/lib/tos.original.txt`, rename it to `/lib/tos.local.txt` and adapt it to your own needs. If you update the installation, then only the `tos.original.txt` file may change eventually, not your `tos.local.txt file`. -## Administration +### Administration To administer the files within Jirafeau it is enough to go to the address `__DOMAIN__/admin.php`. \ No newline at end of file diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md index 69070fb..29e7548 100644 --- a/doc/ADMIN_fr.md +++ b/doc/ADMIN_fr.md @@ -1,9 +1,7 @@ -## Configuration - ### Changer les conditions d'utilisation du service Le texte de la licence sur la page "Conditions d'utilisation du service", qui est livrée avec l'installation par défaut, est basé sur les "Conditions d'utilisation du service de l'Initiative Open Source". Pour modifier ce texte, il suffit de copier le fichier `/lib/tos.original.txt`, de le renommer en `/lib/tos.local.txt` et de l'adapter à vos propres besoins. Si vous mettez à jour l'installation, alors seul le fichier `tos.original.txt` peut changer éventuellement, et non votre fichier `tos.local.txt`. -## Administration +### Administration Pour administrer les fichiers présents au sein de Jirafeau il suffit de se rendre à l'adresse `__DOMAIN__/admin.php`. \ No newline at end of file diff --git a/manifest.toml b/manifest.toml index 12c8f01..5371920 100644 --- a/manifest.toml +++ b/manifest.toml @@ -16,7 +16,7 @@ demo = "https://demo.yunohost.org/jirafeau/" code = "https://gitlab.com/mojo42/Jirafeau" [integration] -yunohost = ">= 11.1.16" +yunohost = ">= 11.1.17" architectures = "all" multi_instance = false ldap = false diff --git a/scripts/install b/scripts/install index a128137..5b23b68 100755 --- a/scripts/install +++ b/scripts/install @@ -13,6 +13,8 @@ source /usr/share/yunohost/helpers # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= +enable_crypt="false" + fpm_footprint="low" fpm_free_footprint=0 fpm_usage="low" @@ -21,6 +23,7 @@ fpm_usage="low" # STORE SETTINGS FROM MANIFEST #================================================= +ynh_app_setting_set --app=$app --key=enable_crypt --value=$enable_crypt ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage diff --git a/scripts/upgrade b/scripts/upgrade index ce0cdae..854cc85 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -22,6 +22,12 @@ upgrade_type=$(ynh_check_app_version_changed) #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 +# If enable_crypt doesn't exist, create it +if [ -z "${enable_crypt:-}" ]; then + enable_crypt=false + ynh_app_setting_set --app=$app --key=enable_crypt --value=$enable_crypt +fi + # If fpm_footprint doesn't exist, create it if [ -z "${fpm_footprint:-}" ]; then fpm_footprint=low From 89ee58969e73d1f7ac6625f6e35323f90ca52e94 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sat, 29 Jul 2023 07:12:18 +0000 Subject: [PATCH 16/20] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96a47d5..126dcf5 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Jirafeau offers the possibility to host and share your files with ease. Choose a file, Jirafeau will provide you with a link with many options. It is possible to protect your links with a password as well as to choose how long the file will be kept on the server. The file and the link will self-destruct after this time. Downloads of transmitted files can be limited to a certain date, and each file can self-destruct after the first download. Jirafeau allows you to configure maximum retention times and maximum size per file. Encryption is available as an option. -**Shipped version:** 4.5.0~ynh1 +**Shipped version:** 4.5.0~ynh2 **Demo:** https://demo.yunohost.org/jirafeau/ diff --git a/README_fr.md b/README_fr.md index 61c9d4e..0515a78 100644 --- a/README_fr.md +++ b/README_fr.md @@ -19,7 +19,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po Jirafeau offre la possibilité d'héberger et de partager vos fichiers, le tout en toute simplicité. Choisissez un fichier, Jirafeau vous fournira un lien avec beaucoup d'options. Il est possible de protéger vos liens avec mot de passe ainsi que de choisir la durée de rétention du fichier sur le serveur. Le fichier et le lien s'autodétruiront passé ce délai. Les téléchargements des fichiers transmis peuvent être limités à une certaine date, et chaque fichier peut s'autodétruire après le premier téléchargement. Jirafeau permet de configurer les temps maximum de rétention ainsi que la taille maximale par fichier. Le chiffrement est disponible en option. -**Version incluse :** 4.5.0~ynh1 +**Version incluse :** 4.5.0~ynh2 **Démo :** https://demo.yunohost.org/jirafeau/ From 8015d6ae549a0b9865c72cbd7e1ced0148514d58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Tue, 26 Sep 2023 23:45:03 +0200 Subject: [PATCH 17/20] cleaning --- scripts/remove | 12 ------------ scripts/restore | 12 +----------- scripts/upgrade | 14 +------------- 3 files changed, 2 insertions(+), 36 deletions(-) diff --git a/scripts/remove b/scripts/remove index f049192..fca489d 100755 --- a/scripts/remove +++ b/scripts/remove @@ -17,21 +17,9 @@ ynh_script_progression --message="Removing NGINX web server configuration..." -- # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=2 - # Remove the dedicated PHP-FPM config ynh_remove_fpm_config -#================================================= -# SPECIFIC REMOVE -#================================================= -# REMOVE VARIOUS FILES -#================================================= -ynh_script_progression --message="Removing various files..." --weight=1 - # Remove a cron file ynh_secure_remove --file="/etc/cron.d/$app" diff --git a/scripts/restore b/scripts/restore index cef09fb..4ee169e 100644 --- a/scripts/restore +++ b/scripts/restore @@ -37,20 +37,10 @@ ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weig ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" # Recreate a dedicated php-fpm config -ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint --phpversion=$phpversion - -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1 +ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# RESTORE VARIOUS FILES -#================================================= -ynh_script_progression --message="Restoring various files..." --weight=1 - ynh_restore_file --origin_path="/etc/cron.d/$app" chown root: "/etc/cron.d/$app" chmod 644 "/etc/cron.d/$app" diff --git a/scripts/upgrade b/scripts/upgrade index 854cc85..d1f9961 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -70,23 +70,11 @@ chown -R $app:www-data "$install_dir" ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=2 # Create a dedicated PHP-FPM config -ynh_add_fpm_config --phpversion=$phpversion --usage=$fpm_usage --footprint=$fpm_footprint - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2 +ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint # Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# SPECIFIC UPGRADE -#================================================= -# SET THE CRON FILE -#================================================= -ynh_script_progression --message="Configuring the cron file..." --weight=1 - ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app" chown root: "/etc/cron.d/$app" chmod 644 "/etc/cron.d/$app" From 40bed806ffe0e6636403a25afc8ca17e2f94842b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Mon, 2 Oct 2023 09:44:28 +0200 Subject: [PATCH 18/20] cleaning --- scripts/change_url | 2 +- scripts/install | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/change_url b/scripts/change_url index 024ad3a..3dfeef1 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -29,4 +29,4 @@ ynh_replace_string --match_string="\$cfg\['web_root'\] = .*" --replace_string="\ # END OF SCRIPT #================================================= -ynh_script_progression --message="Change of URL completed for Jirafeau" --last +ynh_script_progression --message="Change of URL completed for $app" --last diff --git a/scripts/install b/scripts/install index 5b23b68..888abf2 100755 --- a/scripts/install +++ b/scripts/install @@ -89,4 +89,4 @@ chmod 644 "/etc/cron.d/$app" # END OF SCRIPT #================================================= -ynh_script_progression --message="Installation of Jirafeau completed" --last +ynh_script_progression --message="Installation of $app completed" --last From d8827aaa545e3e5faa4a17fb6fc1480dbeb2e419 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sat, 9 Dec 2023 21:59:39 +0100 Subject: [PATCH 19/20] cleaning --- manifest.toml | 3 +++ scripts/install | 9 ++------- scripts/upgrade | 2 +- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/manifest.toml b/manifest.toml index 7a35066..67844d3 100644 --- a/manifest.toml +++ b/manifest.toml @@ -19,8 +19,11 @@ code = "https://gitlab.com/mojo42/Jirafeau" yunohost = ">= 11.2" architectures = "all" multi_instance = false + ldap = false + sso = false + disk = "50M" ram.build = "50M" ram.runtime = "50M" diff --git a/scripts/install b/scripts/install index 888abf2..45deacd 100755 --- a/scripts/install +++ b/scripts/install @@ -50,11 +50,6 @@ ynh_script_progression --message="Configuring PHP-FPM..." --weight=2 # Create a dedicated PHP-FPM config ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring NGINX web server..." - # Create a dedicated NGINX config ynh_add_nginx_config @@ -70,7 +65,7 @@ else jirafeau_path="$path" fi -ynh_add_config --template="../conf/config.local.php" --destination="$install_dir/lib/config.local.php" +ynh_add_config --template="config.local.php" --destination="$install_dir/lib/config.local.php" chmod 400 "$install_dir/lib/config.local.php" chown $app:$app "$install_dir/lib/config.local.php" @@ -80,7 +75,7 @@ chown $app:$app "$install_dir/lib/config.local.php" #================================================= ynh_script_progression --message="Configuring the cron file..." --weight=2 -ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app" +ynh_add_config --template="cron" --destination="/etc/cron.d/$app" chown root: "/etc/cron.d/$app" chmod 644 "/etc/cron.d/$app" diff --git a/scripts/upgrade b/scripts/upgrade index d1f9961..f23456d 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -75,7 +75,7 @@ ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint # Create a dedicated NGINX config ynh_add_nginx_config -ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app" +ynh_add_config --template="cron" --destination="/etc/cron.d/$app" chown root: "/etc/cron.d/$app" chmod 644 "/etc/cron.d/$app" From 98bee0138d9130b08c5b6f1bd9c6aa11d2fb8427 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Wed, 14 Feb 2024 23:04:34 +0100 Subject: [PATCH 20/20] autoupdate.strategy = "latest_gitlab_tag" --- manifest.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/manifest.toml b/manifest.toml index 67844d3..2c8edf1 100644 --- a/manifest.toml +++ b/manifest.toml @@ -55,6 +55,7 @@ ram.runtime = "50M" [resources.sources.main] url = "https://gitlab.com/mojo42/Jirafeau/-/archive/4.5.0/Jirafeau-4.5.0.tar.gz" sha256 = "cc164f086b65c810cefc0eb26bffa6718a12a56ea94b7717d7eba8281d6c66ac" + autoupdate.strategy = "latest_gitlab_tag" [resources.system_user]