v2

conf/msg_install

@@ -1,5 +1,5 @@
 vaultwarden was successfully installed :)
-Please open https://__DOMAIN____PATH_URL__/admin
+Please open https://__DOMAIN____PATH__/admin
 The admin token is: __ADMIN_TOKEN__
 You will be able to invite users to your vaultwarden instance.
 If you facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/vaultwarden_ynh

conf/nginx.conf

@@ -2,7 +2,7 @@
 location __PATH__/ {
 
   # Path to source
-  alias __FINALPATH__/;
+  alias __INSTALL_DIR__/;
 
   # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file
   client_max_body_size 100M;
@@ -17,7 +17,7 @@ location __PATH__/ {
   include conf.d/yunohost_panel.conf.inc;
 }
 
-location __FINALPATH__/notifications/hub {
+location __INSTALL_DIR__/notifications/hub {
   proxy_set_header Host $host;
   proxy_set_header X-Real-IP $remote_addr;
   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -26,6 +26,6 @@ location __FINALPATH__/notifications/hub {
   proxy_pass http://127.0.0.1:__WEBSOCKET_PORT__;
 }
 
-location __FINALPATH__/notifications/hub/negotiate {
+location __INSTALL_DIR__/notifications/hub/negotiate {
   proxy_pass http://127.0.0.1:__ROCKET_PORT__;
 }

conf/systemd.service

@@ -7,10 +7,10 @@ After=network.target
 # The user/group vaultwarden is run under. the working directory (see below) should allow write and read access to this user/group
 User=__APP__
 Group=__APP__
-WorkingDirectory=__FINALPATH__/live/
+WorkingDirectory=__INSTALL_DIR__/live/
-ReadWriteDirectories=__FINALPATH__/live/ __DATADIR__/ /var/log/__APP__/
+ReadWriteDirectories=__INSTALL_DIR__/live/ __DATA_DIR__/ /var/log/__APP__/
-EnvironmentFile=__FINALPATH__/live/.env
+EnvironmentFile=__INSTALL_DIR__/live/.env
-ExecStart=__FINALPATH__/live/vaultwarden
+ExecStart=__INSTALL_DIR__/live/vaultwarden
 
 # Set reasonable connection and process limits
 LimitNOFILE=1048576

conf/vaultwarden.env

@@ -10,7 +10,7 @@
 ## vaultwarden.
 
 ## Main data folder
-DATA_FOLDER=__DATADIR__
+DATA_FOLDER=__DATA_DIR__
 
 ## Database URL
 ## When using SQLite, this is the path to the DB file, default to %DATA_FOLDER%/db.sqlite3
@@ -283,7 +283,7 @@ ADMIN_TOKEN=__ADMIN_TOKEN__
 ## It's recommended to configure this value, otherwise certain functionality might not work,
 ## like attachment downloads, email links and U2F.
 ## For U2F to work, the server must use HTTPS, you can use Let's Encrypt for free certs
-DOMAIN=https://__DOMAIN____PATH_URL__
+DOMAIN=https://__DOMAIN____PATH__
 
 ## Allowed iframe ancestors (Know the risks!)
 ## https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors

manifest.toml

@@ -0,0 +1,58 @@
+packaging_format = 2
+
+id = "vaultwarden"
+name = "Vaultwarden"
+description.en = "Manage passwords and other sensitive informations"
+description.fr = "Gérez les mots de passe et autres informations sensibles"
+
+version = "1.28.1~ynh1"
+
+maintainers = ["yalh76"]
+
+[upstream]
+license = "GPL-3.0-or-later"
+demo = "https://vault.bitwarden.com/#/register"
+admindoc = "https://github.com/dani-garcia/vaultwarden/wiki"
+userdoc = "https://help.bitwarden.com/"
+code = "https://github.com/dani-garcia/vaultwarden"
+website = "https://github.com/dani-garcia/vaultwarden"
+cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number)
+fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin.
+
+[integration]
+yunohost = ">= 11.0.0"
+architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"]
+multi_instance = true
+ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials.
+sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal.
+disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ...
+ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
+ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
+
+[install]
+    [install.domain]
+    # this is a generic question - ask strings are automatically handled by Yunohost's core
+    type = "domain"
+
+    [install.path]
+    # this is a generic question - ask strings are automatically handled by Yunohost's core
+    type = "path"
+    default = "/vaultwarden"
+
+    [install.init_main_permission]
+    type = "group"
+    default = "visitors"
+
+    [install.admin]
+    # this is a generic question - ask strings are automatically handled by Yunohost's core
+    type = "user"
+
+[resources]
+    [resources.system_user]
+
+    [resources.install_dir]
+
+    [resources.data_dir]
+
+    [resources.permissions]
+    main.url = "/"

scripts/_common.sh

@@ -5,7 +5,7 @@
 #=================================================
 
 # dependencies used by the app
-pkg_dependencies="libpq5"
+#REMOVEME? pkg_dependencies="libpq5"
 
 pkg_image="vaultwarden/server"
 

scripts/backup

@@ -14,22 +14,22 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-ynh_clean_setup () {
+#REMOVEME? ynh_clean_setup () {
 	true
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info --message="Loading installation settings..."
+#REMOVEME? ynh_print_info --message="Loading installation settings..."
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
 
 #=================================================
 # DECLARE DATA AND CONF FILES TO BACKUP
@@ -40,13 +40,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

scripts/change_url

@@ -13,60 +13,60 @@ source /usr/share/yunohost/helpers
 # RETRIEVE ARGUMENTS
 #=================================================
 
-old_domain=$YNH_APP_OLD_DOMAIN
+#REMOVEME? old_domain=$YNH_APP_OLD_DOMAIN
-old_path=$YNH_APP_OLD_PATH
+#REMOVEME? old_path=$YNH_APP_OLD_PATH
 
-new_domain=$YNH_APP_NEW_DOMAIN
+#REMOVEME? new_domain=$YNH_APP_NEW_DOMAIN
-new_path=$YNH_APP_NEW_PATH
+#REMOVEME? new_path=$YNH_APP_NEW_PATH
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..."
+#REMOVEME? ynh_script_progression --message="Loading installation settings..."
 
-# Needed for helper "ynh_add_nginx_config"
+#REMOVEME? # Needed for helper "ynh_add_nginx_config"
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
 
 # Add settings here as needed by your application
-#db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? #db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 #db_user=$db_name
-#db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
+#REMOVEME? #db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
-rocket_port=$(ynh_app_setting_get --app=$app --key=rocket_port)
+#REMOVEME? rocket_port=$(ynh_app_setting_get --app=$app --key=rocket_port)
-websocket_port=$(ynh_app_setting_get --app=$app --key=websocket_port)
+#REMOVEME? websocket_port=$(ynh_app_setting_get --app=$app --key=websocket_port)
 
 #=================================================
 # BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..."
+#REMOVEME? 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
+#REMOVEME? ynh_backup_before_upgrade
-ynh_clean_setup () {
+#REMOVEME? 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"
+#REMOVEME? 	ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 
 	# Restore it if the upgrade fails
-	ynh_restore_upgradebackup
+#REMOVEME? 	ynh_restore_upgradebackup
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # CHECK WHICH PARTS SHOULD BE CHANGED
 #=================================================
 
-change_domain=0
+#REMOVEME? change_domain=0
-if [ "$old_domain" != "$new_domain" ]
+#REMOVEME? if [ "$old_domain" != "$new_domain" ]
 then
-	change_domain=1
+	#REMOVEME? change_domain=1
 fi
 
-change_path=0
+#REMOVEME? change_path=0
-if [ "$old_path" != "$new_path" ]
+#REMOVEME? if [ "$old_path" != "$new_path" ]
 then
-	change_path=1
+	#REMOVEME? change_path=1
 fi
 
 #=================================================
@@ -83,28 +83,30 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --li
 #=================================================
 ynh_script_progression --message="Updating NGINX web server configuration..."
 
-nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
+ynh_change_url_nginx_config
+
+#REMOVEME? 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"
+#REMOVEME? 	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
 	# Set global variables for NGINX helper
-	domain="$old_domain"
+#REMOVEME? 	domain="$old_domain"
-	path_url="$new_path"
+#REMOVEME? 	path="$new_path"
 	# Create a dedicated NGINX config
-	ynh_add_nginx_config
+#REMOVEME? 	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"
+#REMOVEME? 	ynh_delete_file_checksum --file="$nginx_conf_path"
-	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
+#REMOVEME? 	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"
+#REMOVEME? 	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 fi
 
 #=================================================
@@ -114,7 +116,7 @@ fi
 #=================================================
 ynh_script_progression --message="Modifying a config file..."
 
-config="$final_path/live/.env"
+config="$install_dir/live/.env"
 
 ynh_backup_if_checksum_is_different --file="$config"
 
@@ -136,9 +138,9 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --l
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..."
+#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..."
 
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT

scripts/install

@@ -15,22 +15,22 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-ynh_clean_setup () {
+#REMOVEME? ynh_clean_setup () {
 	ynh_clean_check_starting
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
 
-domain=$YNH_APP_ARG_DOMAIN
+#REMOVEME? domain=$YNH_APP_ARG_DOMAIN
-path_url=$YNH_APP_ARG_PATH
+#REMOVEME? path=$YNH_APP_ARG_PATH
-is_public=$YNH_APP_ARG_IS_PUBLIC
+#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC
-admin=$YNH_APP_ARG_ADMIN
+#REMOVEME? admin=$YNH_APP_ARG_ADMIN
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
 admin_mail=$(ynh_user_get_info --username=$admin --key=mail)
 admin_token=$(ynh_string_random --length=48 | base64)
@@ -38,72 +38,72 @@ admin_token=$(ynh_string_random --length=48 | base64)
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
-ynh_script_progression --message="Validating installation parameters..."
+#REMOVEME? ynh_script_progression --message="Validating installation parameters..."
 
-final_path=/var/www/$app
+#REMOVEME? install_dir=/var/www/$app
-test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
+#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder"
 
 # Register (book) web path
-ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
+#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
-ynh_script_progression --message="Storing installation settings..."
+#REMOVEME? ynh_script_progression --message="Storing installation settings..."
 
-ynh_app_setting_set --app=$app --key=domain --value=$domain
+#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain
-ynh_app_setting_set --app=$app --key=path --value=$path_url
+#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path
-ynh_app_setting_set --app=$app --key=admin --value=$admin
+#REMOVEME? ynh_app_setting_set --app=$app --key=admin --value=$admin
-ynh_app_setting_set --app=$app --key=admin_token --value=$admin_token
+#REMOVEME? ynh_app_setting_set --app=$app --key=admin_token --value=$admin_token
 
 #=================================================
 # STANDARD MODIFICATIONS
 #=================================================
 # FIND AND OPEN A PORT
 #=================================================
-ynh_script_progression --message="Finding an available port..."
+#REMOVEME? ynh_script_progression --message="Finding an available port..."
 
 # Find an available port
-websocket_port=$(ynh_find_port --port=3012)
+#REMOVEME? websocket_port=$(ynh_find_port --port=3012)
-ynh_app_setting_set --app=$app --key=websocket_port --value="$websocket_port"
+#REMOVEME? ynh_app_setting_set --app=$app --key=websocket_port --value="$websocket_port"
 
 # Find an available port
-rocket_port=$(ynh_find_port --port=8095)
+#REMOVEME? rocket_port=$(ynh_find_port --port=8095)
-ynh_app_setting_set --app=$app --key=rocket_port --value="$rocket_port"
+#REMOVEME? ynh_app_setting_set --app=$app --key=rocket_port --value="$rocket_port"
 
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Installing dependencies..."
+#REMOVEME? ynh_script_progression --message="Installing dependencies..."
 
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Configuring system user..."
+#REMOVEME? ynh_script_progression --message="Configuring system user..."
 
 # Create a system user
-ynh_system_user_create --username=$app --home_dir="$final_path"
+#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
 ynh_script_progression --message="Setting up source files..."
 
-ynh_app_setting_set --app=$app --key=final_path --value=$final_path
+#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
 # Download, check integrity, uncompress and patch the source from app.src
 docker_arg=""
 if [ $YNH_ARCH == "armhf" ] 
 then
 	docker_arg="--os_arch_variant=linux/arm/v7"
 fi
-ynh_docker_image_extract --dest_dir="$final_path/build/" --image_spec="$pkg_image:$(ynh_app_upstream_version)" $docker_arg
+ynh_docker_image_extract --dest_dir="$install_dir/build/" --image_spec="$pkg_image:$(ynh_app_upstream_version)" $docker_arg
-mkdir -p "$final_path/live/"
+mkdir -p "$install_dir/live/"
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:$app "$final_path"
+chown -R $app:$app "$install_dir"
 
 #=================================================
 # NGINX CONFIGURATION
@@ -120,37 +120,37 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Creating a data directory..."
 
-datadir=/home/yunohost.app/$app
+#REMOVEME? data_dir=/home/yunohost.app/$app
-ynh_app_setting_set --app=$app --key=datadir --value=$datadir
+#REMOVEME? ynh_app_setting_set --app=$app --key=data_dir --value=$data_dir
 
-mkdir -p $datadir
+mkdir -p $data_dir
 
-chmod 750 "$datadir"
+chmod 750 "$data_dir"
-chmod -R o-rwx "$datadir"
+chmod -R o-rwx "$data_dir"
-chown -R $app:$app "$datadir"
+chown -R $app:$app "$data_dir"
 
 #=================================================
 # MAKE INSTALL
 #=================================================
 ynh_script_progression --message="Making install..."
 
-mv -f "$final_path/build/vaultwarden" "$final_path/live/vaultwarden"
+mv -f "$install_dir/build/vaultwarden" "$install_dir/live/vaultwarden"
-rsync -a "$final_path/build/web-vault/" "$final_path/live/web-vault/"
+rsync -a "$install_dir/build/web-vault/" "$install_dir/live/web-vault/"
-ynh_secure_remove --file="$final_path/build"
+#REMOVEME? ynh_secure_remove --file="$install_dir/build"
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:$app "$final_path"
+chown -R $app:$app "$install_dir"
 
 #=================================================
 # ADD A CONFIGURATION
 #=================================================
 ynh_script_progression --message="Adding a configuration file..."
 
-ynh_add_config --template="../conf/vaultwarden.env" --destination="$final_path/live/.env"
+ynh_add_config --template="../conf/vaultwarden.env" --destination="$install_dir/live/.env"
 
-chmod 400 "$final_path/live/.env"
+chmod 400 "$install_dir/live/.env"
-chown $app:$app "$final_path/live/.env"
+chown $app:$app "$install_dir/live/.env"
 
 #=================================================
 # SETUP SYSTEMD
@@ -201,25 +201,25 @@ ynh_add_fail2ban_config --logpath="/var/log/$app/$app.log" --failregex="^.*Usern
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_script_progression --message="Configuring permissions..."
+#REMOVEME? ynh_script_progression --message="Configuring permissions..."
 
 # Make app public if necessary
-if [ $is_public -eq 1 ]
+#REMOVEME? if [ $is_public -eq 1 ]
 then
 	# Everyone can access the app.
 	# The "main" permission is automatically created before the install script.
-	ynh_permission_update --permission="main" --add="visitors"
+#REMOVEME? 	ynh_permission_update --permission="main" --add="visitors"
 fi
 
-ynh_permission_create --permission="api" --url="/api" --additional_urls="/identity/connect/token" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
+#REMOVEME? ynh_permission_create --permission="api" --url="/api" --additional_urls="/identity/connect/token" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
-ynh_permission_create --permission="admin" --url="/admin" --allowed="$admin" --show_tile="false"
+#REMOVEME? ynh_permission_create --permission="admin" --url="/admin" --allowed="$admin" --show_tile="false"
 
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..."
+#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..."
 
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # SEND A README FOR THE ADMIN

scripts/remove

@@ -12,13 +12,13 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..."
+#REMOVEME? ynh_script_progression --message="Loading installation settings..."
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
 
 #=================================================
 # STANDARD REMOVE
@@ -44,10 +44,10 @@ ynh_remove_systemd_config
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Removing app main directory..."
+#REMOVEME? ynh_script_progression --message="Removing app main directory..."
 
 # Remove the app directory securely
-ynh_secure_remove --file="$final_path"
+#REMOVEME? ynh_secure_remove --file="$install_dir"
 
 #=================================================
 # REMOVE DATA DIR
@@ -57,7 +57,7 @@ ynh_secure_remove --file="$final_path"
 if [ "${YNH_APP_PURGE:-0}" -eq 1 ]
 then
 	ynh_script_progression --message="Removing app data directory..."
-	ynh_secure_remove --file="$datadir"
+#REMOVEME? 	ynh_secure_remove --file="$data_dir"
 fi
 
 #=================================================
@@ -71,10 +71,10 @@ ynh_remove_nginx_config
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Removing dependencies..."
+#REMOVEME? ynh_script_progression --message="Removing dependencies..."
 
 # Remove metapackage and its dependencies
-ynh_remove_app_dependencies
+#REMOVEME? ynh_remove_app_dependencies
 
 #=================================================
 # REMOVE FAIL2BAN CONFIGURATION
@@ -99,10 +99,10 @@ ynh_secure_remove --file="/var/log/$app"
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Removing the dedicated system user..."
+#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..."
 
 # Delete a system user
-ynh_system_user_delete --username=$app
+#REMOVEME? ynh_system_user_delete --username=$app
 
 #=================================================
 # END OF SCRIPT

scripts/restore

@@ -14,65 +14,65 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-ynh_clean_setup () {
+#REMOVEME? ynh_clean_setup () {
 	ynh_clean_check_starting
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..."
+#REMOVEME? ynh_script_progression --message="Loading installation settings..."
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
+#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
 
 #=================================================
 # CHECK IF THE APP CAN BE RESTORED
 #=================================================
-ynh_script_progression --message="Validating restoration parameters..."
+#REMOVEME? ynh_script_progression --message="Validating restoration parameters..."
 
-test ! -d $final_path \
+#REMOVEME? test ! -d $install_dir \
-	|| ynh_die --message="There is already a directory: $final_path "
+	|| ynh_die --message="There is already a directory: $install_dir "
 
 #=================================================
 # STANDARD RESTORATION STEPS
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Recreating the dedicated system user..."
+#REMOVEME? 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
+#REMOVEME? ynh_system_user_create --username=$app --home_dir=$install_dir
 
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
 ynh_script_progression --message="Restoring the app main directory..."
 
-ynh_restore_file --origin_path="$final_path"
+ynh_restore_file --origin_path="$install_dir"
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:$app "$final_path"
+chown -R $app:$app "$install_dir"
 
 #=================================================
 # RESTORE THE DATA DIRECTORY
 #=================================================
 ynh_script_progression --message="Restoring the data directory..."
 
-ynh_restore_file --origin_path="$datadir" --not_mandatory
+ynh_restore_file --origin_path="$data_dir" --not_mandatory
 
-mkdir -p $datadir
+mkdir -p $data_dir
 
-chmod 750 "$datadir"
+chmod 750 "$data_dir"
-chmod -R o-rwx "$datadir"
+chmod -R o-rwx "$data_dir"
-chown -R $app:$app "$datadir"
+chown -R $app:$app "$data_dir"
 
 #=================================================
 # RESTORE FAIL2BAN CONFIGURATION
@@ -93,10 +93,10 @@ ynh_systemd_action --action=restart --service_name=fail2ban
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Reinstalling dependencies..."
+#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..."
 
 # Define and install dependencies
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # RESTORE THE NGINX CONFIGURATION

scripts/upgrade

@@ -14,19 +14,19 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..."
+#REMOVEME? ynh_script_progression --message="Loading installation settings..."
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
+#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
-admin=$(ynh_app_setting_get --app=$app --key=admin)
+#REMOVEME? admin=$(ynh_app_setting_get --app=$app --key=admin)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
 
-admin_token=$(ynh_app_setting_get --app=$app --key=admin_token)
+#REMOVEME? admin_token=$(ynh_app_setting_get --app=$app --key=admin_token)
-rocket_port=$(ynh_app_setting_get --app=$app --key=rocket_port)
+#REMOVEME? rocket_port=$(ynh_app_setting_get --app=$app --key=rocket_port)
-websocket_port=$(ynh_app_setting_get --app=$app --key=websocket_port)
+#REMOVEME? websocket_port=$(ynh_app_setting_get --app=$app --key=websocket_port)
 
 #=================================================
 # CHECK VERSION
@@ -38,17 +38,17 @@ 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)..."
+#REMOVEME? 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
+#REMOVEME? ynh_backup_before_upgrade
-ynh_clean_setup () {
+#REMOVEME? ynh_clean_setup () {
 	ynh_clean_check_starting
 	# Restore it if the upgrade fails
-	ynh_restore_upgradebackup
+#REMOVEME? 	ynh_restore_upgradebackup
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # STANDARD UPGRADE STEPS
@@ -69,18 +69,18 @@ if [ $migration_process -eq 1 ]
 then
 	# If a migration has been perform
 	# Reload some values changed by the migration process
-	final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? 	install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-	db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? 	db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 
 	# Move config file
-	mv $final_path/live/bitwarden_rs.env $final_path/live/.env
+	mv $install_dir/live/bitwarden_rs.env $install_dir/live/.env
 	ynh_delete_file_checksum --file="/var/www/$old_app/live/bitwarden_rs.env"
-	ynh_store_file_checksum --file="$final_path/live/.env" 
+	ynh_store_file_checksum --file="$install_dir/live/.env" 
-	ynh_secure_remove --file="$final_path/live/bitwarden_rs"
+#REMOVEME? 	ynh_secure_remove --file="$install_dir/live/bitwarden_rs"
 
 	# Manage permissions
-	ynh_permission_update --permission="main" --add="all_users"
+#REMOVEME? 	ynh_permission_update --permission="main" --add="all_users"
-	ynh_permission_update --permission="main" --add="visitors"
+#REMOVEME? 	ynh_permission_update --permission="main" --add="visitors"
 
 	# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
 	if ynh_exec_warn_less yunohost service status $old_app >/dev/null
@@ -96,43 +96,43 @@ fi
 ynh_script_progression --message="Ensuring downward compatibility..."
 
 # Cleaning legacy permissions
-if ynh_legacy_permissions_exists; then
+#REMOVEME? if ynh_legacy_permissions_exists; then
-	ynh_legacy_permissions_delete_all
+#REMOVEME? 	ynh_legacy_permissions_delete_all
 
 	ynh_app_setting_delete --app=$app --key=is_public
 fi
 
-if ! ynh_permission_exists --permission="admin"; then
+#REMOVEME? if ! ynh_permission_exists --permission="admin"; then
 	# Create the required permissions
-	ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin --show_tile="false"
+#REMOVEME? 	ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin --show_tile="false"
 fi
 
 # Create a permission if needed
-if ! ynh_permission_exists --permission="api"; then
+#REMOVEME? if ! ynh_permission_exists --permission="api"; then
-	ynh_permission_create --permission="api" --url="/api" --additional_urls="/identity/connect/token" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
+#REMOVEME? 	ynh_permission_create --permission="api" --url="/api" --additional_urls="/identity/connect/token" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
 fi
 
-# If datadir doesn't exist, create it
+# If data_dir doesn't exist, create it
-if [ -z $datadir ]; then
+if [ -z $data_dir ]; then
 	ynh_script_progression --message="Making sure data directory exists..."
-	datadir=/home/yunohost.app/$app
+	data_dir=/home/yunohost.app/$app
-	ynh_app_setting_set --app=$app --key=datadir --value=$datadir
+#REMOVEME? 	ynh_app_setting_set --app=$app --key=data_dir --value=$data_dir
-	mkdir -p $datadir
+	mkdir -p $data_dir
-	rsync -arz "$final_path/live/data/" "$datadir/" --delete-after --remove-source-files
+	rsync -arz "$install_dir/live/data/" "$data_dir/" --delete-after --remove-source-files
-	ynh_secure_remove --file="$final_path/live/data"
+#REMOVEME? 	ynh_secure_remove --file="$install_dir/live/data"
-	ynh_system_user_create --username=$app --home_dir="$final_path"
+#REMOVEME? 	ynh_system_user_create --username=$app --home_dir="$install_dir"
-	chmod 750 "$datadir"
+	chmod 750 "$data_dir"
-	chmod -R o-rwx "$datadir"
+	chmod -R o-rwx "$data_dir"
-	chown -R $app:$app "$datadir"
+	chown -R $app:$app "$data_dir"
 fi
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..."
+#REMOVEME? 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"
+#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -148,20 +148,20 @@ then
 	then
 		docker_arg="--os_arch_variant=linux/arm/v7"
 	fi
-	ynh_docker_image_extract --dest_dir="$final_path/build/" --image_spec="$pkg_image:$(ynh_app_upstream_version)" $docker_arg
+	ynh_docker_image_extract --dest_dir="$install_dir/build/" --image_spec="$pkg_image:$(ynh_app_upstream_version)" $docker_arg
-	mkdir -p "$final_path/live/"
+	mkdir -p "$install_dir/live/"
 fi
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:$app "$final_path"
+chown -R $app:$app "$install_dir"
 
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Upgrading dependencies..."
+#REMOVEME? ynh_script_progression --message="Upgrading dependencies..."
 
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # NGINX CONFIGURATION
@@ -180,25 +180,25 @@ ynh_script_progression --message="Making upgrade..."
 
 if [ "$upgrade_type" == "UPGRADE_APP" ]
 then
-	mv -f "$final_path/build/vaultwarden" "$final_path/live/vaultwarden"
+	mv -f "$install_dir/build/vaultwarden" "$install_dir/live/vaultwarden"
-	ynh_secure_remove --file="$final_path/live/web-vault/"
+#REMOVEME? 	ynh_secure_remove --file="$install_dir/live/web-vault/"
-	rsync -a "$final_path/build/web-vault/" "$final_path/live/web-vault/"
+	rsync -a "$install_dir/build/web-vault/" "$install_dir/live/web-vault/"
-	ynh_secure_remove --file="$final_path/build"
+#REMOVEME? 	ynh_secure_remove --file="$install_dir/build"
 fi
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:$app "$final_path"
+chown -R $app:$app "$install_dir"
 
 #=================================================
 # UPDATE A CONFIG FILE
 #=================================================
 ynh_script_progression --message="Updating a configuration file..."
 
-ynh_add_config --template="../conf/vaultwarden.env" --destination="$final_path/live/.env"
+ynh_add_config --template="../conf/vaultwarden.env" --destination="$install_dir/live/.env"
 
-chmod 400 "$final_path/live/.env"
+chmod 400 "$install_dir/live/.env"
-chown $app:$app "$final_path/live/.env"
+chown $app:$app "$install_dir/live/.env"
 
 #=================================================
 # SETUP SYSTEMD
@@ -248,9 +248,9 @@ ynh_add_fail2ban_config --logpath="/var/log/$app/$app.log" --failregex="^.*Usern
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..."
+#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..."
 
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # FINISH MIGRATION PROCESS