diff --git a/check_process b/check_process deleted file mode 100644 index 63badee..0000000 --- a/check_process +++ /dev/null @@ -1,24 +0,0 @@ -;; Full test on Keeweb - ; Manifest - domain="domain.tld" - path="/path" - is_public=1 - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - upgrade=1 from_commit=6ec03114172c5de3291059756a38d57c63ffb4f2 - backup_restore=1 - multi_instance=1 - change_url=1 -;;; Options -Email= -Notification=down -;;; Upgrade options - ; commit=6ec03114172c5de3291059756a38d57c63ffb4f2 - name=Merge pull request #17 from YunoHost-Apps/testing - manifest_arg=domain=DOMAIN&path=PATH&is_public=1 diff --git a/conf/nginx.conf b/conf/nginx.conf index 108281b..94df68c 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,7 +1,7 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { - alias __FINALPATH__/; + alias __INSTALL_DIR__/; index index.html ; diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 6db04b6..0000000 --- a/manifest.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "name": "Keeweb", - "id": "keeweb", - "packaging_format": 1, - "description": { - "en": "Password manager compatible with KeePass", - "fr": "Gestionnaire de mots de passe compatible avec KeePass" - }, - "version": "1.18.8~ynh1", - "url": "https://keeweb.info/", - "upstream": { - "license": "MIT", - "website": "https://keeweb.info/", - "demo": "https://app.keeweb.info/", - "admindoc": "https://github.com/keeweb/keeweb/wiki", - "code": "https://github.com/keeweb/keeweb" - }, - "license": "MIT", - "maintainer": { - "name": "kay0u", - "email": "pierre@kayou.io" - }, - "requirements": { - "yunohost": ">= 4.3.0" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/keeweb", - "default": "/keeweb" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "If enabled, KeeWeb will be accessible by people who do not have an account. This can be changed later via the webadmin.", - "fr": "Si cette case est cochée, KeeWeb sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." - }, - "default": false - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..c39a3d2 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,49 @@ +packaging_format = 2 + +id = "keeweb" +name = "Keeweb" +description.en = "Password manager compatible with KeePass" +description.fr = "Gestionnaire de mots de passe compatible avec KeePass" + +version = "1.18.8~ynh1" + +maintainers = ["kay0u"] + +[upstream] +license = "MIT" +website = "https://keeweb.info/" +demo = "https://app.keeweb.info/" +admindoc = "https://github.com/keeweb/keeweb/wiki" +code = "https://github.com/keeweb/keeweb" + +[integration] +yunohost = ">= 11.2" +architectures = "all" +multi_instance = true +ldap = false +sso = false +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/keeweb" + + [install.init_main_permission] + help.en = "If enabled, KeeWeb will be accessible by people who do not have an account. This can be changed later via the webadmin." + help.fr = "Si cette case est cochée, KeeWeb sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." + type = "group" + default = false + +[resources] + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" diff --git a/scripts/backup b/scripts/backup index 149cafd..5669879 100644 --- a/scripts/backup +++ b/scripts/backup @@ -9,23 +9,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) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -35,7 +18,7 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP OF THE MAIN DIR OF THE APP #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP OF THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index 8352d11..6a52cf0 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 CHANGE URL THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." - -# 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,44 +16,7 @@ fi #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." -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 "$nginx_conf_path" - - # Set global variables for nginx helper - domain="$old_domain" - path_url="$new_path" - - # Store path_url setting - ynh_app_setting_set $app path "$path_url" - - # 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 "$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 "/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi - -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." - -ynh_systemd_action --service_name=nginx --action=reload +ynh_change_url_nginx_config #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 2e949fd..a938a1c 100644 --- a/scripts/install +++ b/scripts/install @@ -9,55 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE FAILURE OF THE SCRIPT -#================================================= - -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 - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." - -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..." - -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=final_path --value=$final_path - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -67,8 +18,8 @@ ynh_script_progression --message="Setting up source files..." # To avoid a complete rebuild, I downloaded the gh-pages as explained here: https://github.com/keeweb/keeweb#self-hosting # and put all files in "../sources/extra_files/app/", like that I can assure the version install in YunoHost is the version described in the manifest -mkdir -p "$final_path" -cp -r ../sources/extra_files/app/* "$final_path" +mkdir -p "$install_dir" +cp -r ../sources/extra_files/app/* "$install_dir" #================================================= # NGINX CONFIGURATION @@ -83,14 +34,14 @@ ynh_add_nginx_config # USE THE CONFIG FILE #================================================= -ynh_replace_string "(no-config)" "config.json" "$final_path/index.html" +ynh_replace_string "(no-config)" "config.json" "$install_dir/index.html" #================================================= # COPY THE CONFIG FILE #================================================= ynh_script_progression --message="Adding a configuration file..." -ynh_add_config --template="../conf/config.json" --destination="$final_path/config.json" +ynh_add_config --template="config.json" --destination="$install_dir/config.json" #================================================= # GENERIC FINALISATION @@ -99,27 +50,9 @@ ynh_add_config --template="../conf/config.json" --destination="$final_path/confi #================================================= # Les fichiers appartiennent à root -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." - -# Make app public if necessary -if [ $is_public -eq 1 ] -then - ynh_permission_update --permission="main" --add="visitors" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." - -ynh_systemd_action --service_name=nginx --action=reload +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index cd69123..bd9719d 100644 --- a/scripts/remove +++ b/scripts/remove @@ -9,26 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get $app domain) -final_path=$(ynh_app_setting_get $app final_path) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - #================================================= # REMOVE NGINX CONFIGURATION #================================================= @@ -37,14 +17,6 @@ ynh_script_progression --message="Removing NGINX web server configuration..." # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index 0b93315..8527c73 100644 --- a/scripts/restore +++ b/scripts/restore @@ -10,31 +10,16 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# RESTORE OF THE MAIN DIR OF THE APP #================================================= +ynh_script_progression --message="Restoring the app main directory..." -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors +ynh_restore_file --origin_path="$install_dir" -#================================================= -# LOAD SETTINGS -#================================================= +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get $app domain) -path_url=$(ynh_app_setting_get $app path) -final_path=$(ynh_app_setting_get $app final_path) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." - -test ! -d $final_path || ynh_die "There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORE STEPS #================================================= # RESTORE OF THE NGINX CONFIGURATION #================================================= @@ -42,25 +27,6 @@ ynh_script_progression --message="Restoring the NGINX configuration..." ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - -#================================================= -# RESTORE OF THE MAIN DIR OF THE APP -#================================================= -ynh_script_progression --message="Restoring the app main directory..." - -ynh_restore_file --origin_path="$final_path" - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - #================================================= # GENERIC FINALISATION #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 8046a9d..2026407 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,61 +9,12 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= - -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) - #================================================= # CHECK 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)..." - -# 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 - -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." - -if [ -z "$final_path" ]; then - final_path=/var/www/$app - ynh_app_setting_set $app final_path $final_path -fi - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -#================================================= -# CREATE DEDICATED USER -#================================================= -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 #================================================= @@ -75,8 +26,8 @@ then ynh_script_progression --message="Upgrading source files..." # Download, check integrity, uncompress and patch the source from app.src - mkdir -p "$final_path" - cp -r ../sources/extra_files/app/* "$final_path" + mkdir -p "$install_dir" + cp -r ../sources/extra_files/app/* "$install_dir" fi #================================================= @@ -91,14 +42,14 @@ ynh_add_nginx_config # USE THE CONFIG FILE #================================================= -ynh_replace_string "(no-config)" "config.json" "$final_path/index.html" +ynh_replace_string "(no-config)" "config.json" "$install_dir/index.html" #================================================= # COPY THE CONFIG FILE #================================================= # Copie ou modification d'un fichier de config -ynh_add_config --template="../conf/config.json" --destination="$final_path/config.json" +ynh_add_config --template="config.json" --destination="$install_dir/config.json" #================================================= # GENERIC FINALISATION @@ -106,16 +57,9 @@ ynh_add_config --template="../conf/config.json" --destination="$final_path/confi # SECURING FILES AND DIRECTORIES #================================================= -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." - -ynh_systemd_action --service_name=nginx --action=reload +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..cbbeef1 --- /dev/null +++ b/tests.toml @@ -0,0 +1,3 @@ +test_format = 1.0 + +[default]