diff --git a/README.md b/README.md index a37e805..4f7d99f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ -Custom Webapp -------------- +# Custom Webapp + +[![Integration level](https://dash.yunohost.org/integration/my_webapp.svg)](https://ci-apps.yunohost.org/jenkins/job/my_webapp%20%28Community%29/lastBuild/consoleFull) +[![Install my_webapp with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=my_webapp) + Empty application with SFTP access to the Web directory. diff --git a/conf/nginx.conf b/conf/nginx.conf index 2d343ab..c69065d 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,6 +1,10 @@ -location __PATH__ { - alias __FINALPATH__/www/; - +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; +location __PATH__/ { + + # Path to source + alias __FINALPATH__/www/ ; + + # Force usage of https if ($scheme = http) { rewrite ^ https://$server_name$request_uri? permanent; } @@ -29,12 +33,14 @@ location __PATH__ { location ~ [^/]\.php(/|$) { fastcgi_split_path_info ^(.+?\.php)(/.*)$; fastcgi_pass unix:/var/run/php5-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; } +### End of PHP configuration part # Include SSOWAT user panel. include conf.d/yunohost_panel.conf.inc; diff --git a/manifest.json b/manifest.json index 1152e2a..4da5d54 100644 --- a/manifest.json +++ b/manifest.json @@ -42,15 +42,6 @@ "example": "/site", "default": "/site" }, - { - "name": "password", - "type": "password", - "ask": { - "en": "Set the password for the SFTP access. ≥ 5 character", - "fr": "Définissez le mot de passe pour l'accès SFTP. ≥ cinq charactères" - }, - "example": "myreallystrengthpassword" - }, { "name": "is_public", "type": "boolean", @@ -60,6 +51,15 @@ }, "default": true }, + { + "name": "password", + "type": "password", + "ask": { + "en": "Set the password for the SFTP access. ≥ 5 character", + "fr": "Définissez le mot de passe pour l'accès SFTP. ≥ cinq charactères" + }, + "example": "myreallystrengthpassword" + }, { "name": "with_mysql", "type": "boolean", diff --git a/scripts/backup b/scripts/backup index 13b9193..be17d69 100644 --- a/scripts/backup +++ b/scripts/backup @@ -2,19 +2,24 @@ #================================================= # GENERIC START -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit on command errors and treat access to unset variables as an error -set -eu - #================================================= # IMPORT GENERIC HELPERS #================================================= +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 #================================================= diff --git a/scripts/install b/scripts/install index 9b32084..4369898 100644 --- a/scripts/install +++ b/scripts/install @@ -6,12 +6,17 @@ # IMPORT GENERIC HELPERS #================================================= +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 @@ -21,10 +26,21 @@ ynh_abort_if_errors domain=$YNH_APP_ARG_DOMAIN path_url=$YNH_APP_ARG_PATH -password=$YNH_APP_ARG_PASSWORD is_public=$YNH_APP_ARG_IS_PUBLIC +password=$YNH_APP_ARG_PASSWORD + with_mysql=$YNH_APP_ARG_WITH_MYSQL +### If it's a multi-instance app, meaning it can be installed several times independently +### The id of the app as stated in the manifest is available as $YNH_APP_ID +### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...) +### The app instance name is available as $YNH_APP_INSTANCE_NAME +### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample +### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2 +### - ynhexample__{N} for the subsequent installations, with N=3,4, ... +### The app instance name is probably what interests you most, since this is +### guaranteed to be unique. This is a good unique identifier to define installation path, +### db names, ... app=$YNH_APP_INSTANCE_NAME app_nb=$YNH_APP_INSTANCE_NUMBER @@ -32,6 +48,8 @@ app_nb=$YNH_APP_INSTANCE_NUMBER # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= +### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app". +### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app" final_path=/var/www/$app test ! -e "$final_path" || ynh_die "This path already contains a folder" @@ -66,6 +84,15 @@ ynh_app_setting_set $app final_path $final_path # CREATE A MYSQL DATABASE #================================================= +### Use these lines if you need a database for the application. +### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password. +### The password will be stored as 'mysqlpwd' into the app settings, +### and will be available as $db_pwd +### If you're not using these lines: +### - Remove the section "BACKUP THE MYSQL DATABASE" in the backup script +### - Remove also the section "REMOVE THE MYSQL DATABASE" in the remove script +### - As well as the section "RESTORE THE MYSQL DATABASE" in the restore script + if [ $with_mysql -eq 1 ]; then db_name=$(ynh_sanitize_dbid $app) ynh_app_setting_set $app db_name $db_name @@ -76,6 +103,8 @@ fi # NGINX CONFIGURATION #================================================= +### `ynh_add_nginx_config` will use the file conf/nginx.conf + # Create a dedicated nginx config ynh_add_nginx_config @@ -83,16 +112,24 @@ ynh_add_nginx_config # CREATE DEDICATED USER #================================================= -# Create a standard user (not a system user for sftp) -ynh_system_user_exists "$user" || \ - useradd -d "$final_path" -M --user-group "$user" -# Add the password to this user -chpasswd <<< "${user}:${password}" +# Create a system user +ynh_system_user_create $app #================================================= # PHP-FPM CONFIGURATION #================================================= +### `ynh_add_fpm_config` is used to set up a PHP config. +### You can remove it if your app doesn't use PHP. +### `ynh_add_fpm_config` will use the files conf/php-fpm.conf and conf/php-fpm.ini +### If you're not using these lines: +### - You can remove these files in conf/. +### - Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup script +### - Remove also the section "REMOVE PHP-FPM CONFIGURATION" in the remove script +### - As well as the section "RESTORE THE PHP-FPM CONFIGURATION" in the restore script +### With the reload at the end of the script. +### - And the section "PHP-FPM CONFIGURATION" in the upgrade script + # Create a dedicated php-fpm config ynh_replace_string "__USER__" "$user" "../conf/php-fpm.conf" ynh_add_fpm_config @@ -117,9 +154,12 @@ Match User ${user} systemctl reload ssh #================================================= -# FILL AND COPY SOURCE FILES +# MODIFY A CONFIG FILE #================================================= +### `ynh_replace_string` is used to replace a string in a file. +### (It's compatible with sed regular expressions syntax) + ynh_replace_string "{DOMAIN}" "$domain" ../sources/www/index.html ynh_replace_string "{USER}" "$user" ../sources/www/index.html @@ -138,11 +178,12 @@ cp -r ../sources "$final_path" # SECURE FILES AND DIRECTORIES #================================================= +### For security reason, any app should set the permissions to root: before anything else. +### Then, if write authorization is needed, any access should be given only to directories +### that really need such authorization. + # Set permissions to app files -chown -R $user: "$final_path" -# Home directory of the user needs to be owned by root to allow -# SFTP connections -chown root: "$final_path" +chown -R root: $final_path #================================================= # SETUP SSOWAT diff --git a/scripts/remove b/scripts/remove index 83e2ef3..05d2085 100644 --- a/scripts/remove +++ b/scripts/remove @@ -6,6 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= +source _common.sh source /usr/share/yunohost/helpers #================================================= @@ -15,10 +16,12 @@ source /usr/share/yunohost/helpers app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get $app domain) + +db_name=$(ynh_app_setting_get $app db_name) +db_user=$db_name +final_path=$(ynh_app_setting_get $app final_path) with_mysql=$(ynh_app_setting_get $app with_mysql) user=$(ynh_app_setting_get $app user) -db_name=$(ynh_app_setting_get $app db_name) -final_path=$(ynh_app_setting_get $app final_path) #================================================= # STANDARD REMOVE @@ -28,7 +31,7 @@ final_path=$(ynh_app_setting_get $app final_path) if [ $with_mysql -eq 1 ]; then # Remove a database if it exists, along with the associated user - ynh_mysql_remove_db $db_name $db_name + ynh_mysql_remove_db $db_user $db_name fi #================================================= diff --git a/scripts/restore b/scripts/restore index 6c5a219..dca448d 100644 --- a/scripts/restore +++ b/scripts/restore @@ -2,19 +2,24 @@ #================================================= # GENERIC START -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit on command errors and treat access to unset variables as an error -set -eu - #================================================= # IMPORT GENERIC HELPERS #================================================= +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 #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index abacad4..0ecf32b 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -6,6 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= +source _common.sh source /usr/share/yunohost/helpers #================================================= @@ -16,8 +17,10 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get $app domain) path_url=$(ynh_app_setting_get $app path) + is_public=$(ynh_app_setting_get $app is_public) final_path=$(ynh_app_setting_get $app final_path) + db_name=$(ynh_app_setting_get $app db_name) with_mysql=$(ynh_app_setting_get $app with_mysql) password=$(ynh_app_setting_get $app password) @@ -36,6 +39,15 @@ https://github.com/YunoHost-Apps/my_webapp_ynh#upgrade" # ENSURE DOWNWARD COMPATIBILITY #================================================= +# Fix is_public as a boolean value +if [ "$is_public" = "Yes" ]; then + ynh_app_setting_set $app is_public 1 + is_public=1 +elif [ "$is_public" = "No" ]; then + ynh_app_setting_set $app is_public 0 + is_public=0 +fi + # If db_name doesn't exist, create it if [ -z $db_name ]; then db_name=$(ynh_sanitize_dbid $app) @@ -52,11 +64,14 @@ fi # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= -ynh_backup_before_upgrade # Backup the current version of the app +# Backup the current version of the app +ynh_backup_before_upgrade ynh_clean_setup () { - ynh_restore_upgradebackup # restore it if the upgrade fails + # restore it if the upgrade fails + ynh_restore_upgradebackup } -ynh_abort_if_errors # Exit if an error occurs during the execution of the script +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors #================================================= # CHECK THE PATH