From d69e287532d4c713e03b3abbb6e5b5fd64615a07 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89ric=20Gaspar?=
<46165813+ericgaspar@users.noreply.github.com>
Date: Fri, 4 Nov 2022 17:24:16 +0100
Subject: [PATCH] v2
---
conf/ldap.service | 4 +-
conf/systemd.service | 4 +-
manifest.toml | 77 +++++++++++++++++++++++
scripts/_common.sh | 2 +-
scripts/backup | 18 +++---
scripts/install | 140 +++++++++++++++++++++---------------------
scripts/remove | 26 ++++----
scripts/restore | 52 ++++++++--------
scripts/upgrade | 142 +++++++++++++++++++++----------------------
9 files changed, 271 insertions(+), 194 deletions(-)
create mode 100644 manifest.toml
diff --git a/conf/ldap.service b/conf/ldap.service
index 6efb10d..29ca25f 100644
--- a/conf/ldap.service
+++ b/conf/ldap.service
@@ -7,8 +7,8 @@ After=network.target
Type=simple
User=__APP__
Group=__APP__
-WorkingDirectory=__FINALPATH__/live_ldap/
-ExecStart=__FINALPATH__/live_ldap/galene-ldap -data __FINALPATH__/live_ldap/data/
+WorkingDirectory=__INSTALL_DIR__/live_ldap/
+ExecStart=__INSTALL_DIR__/live_ldap/galene-ldap -data __INSTALL_DIR__/live_ldap/data/
LimitNOFILE=65536
[Install]
diff --git a/conf/systemd.service b/conf/systemd.service
index 1417126..6b112ed 100644
--- a/conf/systemd.service
+++ b/conf/systemd.service
@@ -7,8 +7,8 @@ After=network.target
Type=simple
User=__APP__
Group=__APP__
-WorkingDirectory=__FINALPATH__/live/
-ExecStart=__FINALPATH__/live/galene -http "127.0.0.1:__PORT__" -insecure -turn __PUBLIC_IP4__:__TURN_PORT__ -udp-range 49152-65535 -groups __DATADIR__/groups -recordings __DATADIR__/recordings -data __FINALPATH__/live/data/
+WorkingDirectory=__INSTALL_DIR__/live/
+ExecStart=__INSTALL_DIR__/live/galene -http "127.0.0.1:__PORT__" -insecure -turn __PUBLIC_IP4__:__TURN_PORT__ -udp-range 49152-65535 -groups __DATA_DIR__/groups -recordings __DATA_DIR__/recordings -data __INSTALL_DIR__/live/data/
LimitNOFILE=65536
[Install]
diff --git a/manifest.toml b/manifest.toml
new file mode 100644
index 0000000..3004492
--- /dev/null
+++ b/manifest.toml
@@ -0,0 +1,77 @@
+packaging_format = 2
+
+id = "galene"
+name = "Galène"
+description.en = "Videoconferencing server that is easy to deploy"
+description.fr = "Serveur de visioconférence facile à déployer"
+
+version = "0.6.1~ynh4"
+
+maintainers = ["eric_G"]
+
+[upstream]
+license = "MIT"
+website = "https://galene.org/"
+demo = "https://galene.org:8443/"
+admindoc = "https://galene.org/"
+userdoc = "https://galene.org/faq.html"
+code = "https://github.com/jech/galene"
+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.9"
+architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64/armel), for example: ["amd64", "i386"]
+multi_instance = false
+ldap = "?" # FIXME: replace with true, false, or "not_relevant"
+sso = "?" # FIXME: replace with true, false, or "not_relevant"
+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"
+ full_domain = true
+
+ [install.init_main_permission]
+ help.en = "If enabled, Galène 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, Galène sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin."
+ type = "group"
+ default = "visitors"
+
+ [install.admin]
+ # this is a generic question - ask strings are automatically handled by Yunohost's core
+ type = "user"
+
+ [install.password]
+ # this is a generic question - ask strings are automatically handled by Yunohost's core
+ help.en = "Set the administrator password (between 8 and 30 characters)"
+ help.fr = "Définissez le mot de passe administrateur (entre 8 et 30 caractères)"
+ type = "password"
+
+ [install.group_name]
+ ask.en = "Choose a name for the group you want to create"
+ ask.fr = "Choisissez un nom pour le groupe que vous voulez créer"
+ type = "string"
+ default = "public"
+ example = "public"
+
+ [install.group_description]
+ ask.en = "Choose a description for the group you want to create"
+ ask.fr = "Décrivez le groupe que vous souhaitez créer"
+ help.en = "Add a human-readable description of the group; this is displayed on the landing page for public groups."
+ help.fr = "Ajoutez une description du groupe; ceci est affiché sur la page de destination des groupes publics."
+ type = "string"
+ optional = true
+
+[resources]
+ [resources.system_user]
+
+ [resources.install_dir]
+
+ [resources.data_dir]
+
+ [resources.permissions]
+ main.url = "/"
diff --git a/scripts/_common.sh b/scripts/_common.sh
index 87199a3..79dcd7a 100755
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -7,7 +7,7 @@
go_version=1.19
# dependencies used by the app (must be on a single line)
-pkg_dependencies="jose"
+#REMOVEME? pkg_dependencies="jose"
#=================================================
# PERSONAL HELPERS
diff --git a/scripts/backup b/scripts/backup
index cf11da9..ce9e622 100755
--- a/scripts/backup
+++ b/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)
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
+#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
diff --git a/scripts/install b/scripts/install
index 591fc3f..6a66c68 100755
--- a/scripts/install
+++ b/scripts/install
@@ -14,46 +14,46 @@ 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
#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================
-domain=$YNH_APP_ARG_DOMAIN
-path_url="/"
-is_public=$YNH_APP_ARG_IS_PUBLIC
-admin=$YNH_APP_ARG_ADMIN
-password=$YNH_APP_ARG_PASSWORD
-group_name=$YNH_APP_ARG_GROUP_NAME
-group_description=$YNH_APP_ARG_GROUP_DESCRIPTION
+#REMOVEME? domain=$YNH_APP_ARG_DOMAIN
+path="/"
+#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC
+#REMOVEME? admin=$YNH_APP_ARG_ADMIN
+#REMOVEME? password=$YNH_APP_ARG_PASSWORD
+#REMOVEME? group_name=$YNH_APP_ARG_GROUP_NAME
+#REMOVEME? group_description=$YNH_APP_ARG_GROUP_DESCRIPTION
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
-ynh_script_progression --message="Validating installation parameters..." --weight=1
+#REMOVEME? 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"
+#REMOVEME? install_dir=/var/www/$app
+#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..." --weight=4
+#REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=4
-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
-ynh_app_setting_set --app=$app --key=password --value="$password"
+#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain
+#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path
+#REMOVEME? ynh_app_setting_set --app=$app --key=admin --value=$admin
+#REMOVEME? ynh_app_setting_set --app=$app --key=password --value="$password"
ynh_app_setting_set --app=$app --key=group_name --value="$group_name"
ynh_app_setting_set --app=$app --key=group_description --value="$group_description"
@@ -62,18 +62,18 @@ ynh_app_setting_set --app=$app --key=group_description --value="$group_descripti
#=================================================
# FIND AND OPEN A PORT
#=================================================
-ynh_script_progression --message="Finding an available port..." --weight=3
+#REMOVEME? ynh_script_progression --message="Finding an available port..." --weight=3
# Find an available port
-port=$(ynh_find_port --port=8095)
-ynh_app_setting_set --app=$app --key=port --value=$port
+#REMOVEME? port=$(ynh_find_port --port=8095)
+#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$port
-ldap_port=$(ynh_find_port --port=$(($port + 1)))
-ynh_app_setting_set --app=$app --key=port --value=$ldap_port
+#REMOVEME? ldap_port=$(ynh_find_port --port=$(($port + 1)))
+#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$ldap_port
# Find an available port for TURN
-turn_port=$(ynh_find_port --port=1194)
-ynh_app_setting_set --app=$app --key=turn_port --value=$turn_port
+#REMOVEME? turn_port=$(ynh_find_port --port=1194)
+#REMOVEME? ynh_app_setting_set --app=$app --key=turn_port --value=$turn_port
# Open TURN port
ynh_script_progression --message="Configuring firewall..." --weight=1
@@ -86,35 +86,35 @@ ynh_exec_warn_less yunohost firewall allow UDP -4 49152:65535
#=================================================
# INSTALL DEPENDENCIES
#=================================================
-ynh_script_progression --message="Installing dependencies..." --weight=1
+#REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=1
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
#=================================================
# CREATE DEDICATED USER
#=================================================
-ynh_script_progression --message="Configuring system user..." --weight=3
+#REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=3
# 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..." --weight=1
-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
-ynh_setup_source --dest_dir="$final_path/build"
-ynh_setup_source --dest_dir="$final_path/build_ldap" --source_id="ldap"
+ynh_setup_source --dest_dir="$install_dir/build"
+ynh_setup_source --dest_dir="$install_dir/build_ldap" --source_id="ldap"
-mkdir -p "$final_path/live/data"
-mkdir -p "$final_path/live_ldap/data"
-cp -r "$final_path/build/static/" "$final_path/live/"
-ynh_replace_string --match_string="
" --replace_string="" --target_file="$final_path/live/static/galene.html"
-chmod 750 "$final_path"
-chmod -R o-rwx "$final_path"
-chown -R $app:www-data "$final_path"
+mkdir -p "$install_dir/live/data"
+mkdir -p "$install_dir/live_ldap/data"
+cp -r "$install_dir/build/static/" "$install_dir/live/"
+ynh_replace_string --match_string="" --replace_string="" --target_file="$install_dir/live/static/galene.html"
+chmod 750 "$install_dir"
+chmod -R o-rwx "$install_dir"
+chown -R $app:www-data "$install_dir"
#=================================================
# NGINX CONFIGURATION
@@ -133,32 +133,32 @@ ynh_script_progression --message="Building app..." --weight=1
ynh_exec_warn_less ynh_install_go --go_version=$go_version
ynh_use_go
-pushd $final_path/build/
- ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $final_path/live/
+pushd $install_dir/build/
+ ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $install_dir/live/
popd
-pushd $final_path/build_ldap/
- ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $final_path/live_ldap/
+pushd $install_dir/build_ldap/
+ ynh_exec_warn_less ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $install_dir/live_ldap/
popd
ynh_remove_go
-ynh_secure_remove --file="$final_path/build/"
-ynh_secure_remove --file="$final_path/build_ldap/"
-ynh_secure_remove --file="$final_path/.cache/"
-ynh_secure_remove --file="$final_path/go/"
-ynh_secure_remove --file="$final_path/.go-version"
+#REMOVEME? ynh_secure_remove --file="$install_dir/build/"
+#REMOVEME? ynh_secure_remove --file="$install_dir/build_ldap/"
+#REMOVEME? ynh_secure_remove --file="$install_dir/.cache/"
+#REMOVEME? ynh_secure_remove --file="$install_dir/go/"
+#REMOVEME? ynh_secure_remove --file="$install_dir/.go-version"
#=================================================
# 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
+#REMOVEME? data_dir=/home/yunohost.app/$app
+#REMOVEME? ynh_app_setting_set --app=$app --key=data_dir --value=$data_dir
-mkdir -p $datadir/{groups,recordings}
+mkdir -p $data_dir/{groups,recordings}
-chmod 750 "$datadir"
-chmod -R o-rwx "$datadir"
-chown -R $app:www-data "$datadir"
+chmod 750 "$data_dir"
+chmod -R o-rwx "$data_dir"
+chown -R $app:www-data "$data_dir"
#=================================================
# ADD A CONFIGURATION
@@ -166,26 +166,26 @@ chown -R $app:www-data "$datadir"
ynh_script_progression --message="Adding a configuration file..." --weight=1
# Configure Galène
-ynh_add_config --template="../conf/config.json" --destination="$final_path/live/data/config.json"
-chmod 400 "$final_path/live/data/config.json"
-chown $app:$app "$final_path/live/data/config.json"
+ynh_add_config --template="../conf/config.json" --destination="$install_dir/live/data/config.json"
+chmod 400 "$install_dir/live/data/config.json"
+chown $app:$app "$install_dir/live/data/config.json"
# Configure Galène LDAP
key=$(jose jwk gen -i '{"kty":"oct","alg":"HS256"}')
ynh_app_setting_set --app=$app --key=key --value="$key"
-ynh_add_config --template="../conf/galene-ldap.json" --destination="$final_path/live_ldap/data/galene-ldap.json"
-chmod 400 "$final_path/live_ldap/data/galene-ldap.json"
-chown $app:$app "$final_path/live_ldap/data/galene-ldap.json"
+ynh_add_config --template="../conf/galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
+chmod 400 "$install_dir/live_ldap/data/galene-ldap.json"
+chown $app:$app "$install_dir/live_ldap/data/galene-ldap.json"
# Create a group name config
-ynh_add_config --template="../conf/groupname.json" --destination="$datadir/groups/$group_name.json"
-chmod 400 "$datadir/groups/$group_name.json"
-chown $app:$app "$datadir/groups/$group_name.json"
+ynh_add_config --template="../conf/groupname.json" --destination="$data_dir/groups/$group_name.json"
+chmod 400 "$data_dir/groups/$group_name.json"
+chown $app:$app "$data_dir/groups/$group_name.json"
# Create a group name authenticated on LDAP
-ynh_add_config --template="../conf/groupname-ldap.json" --destination="$datadir/groups/YunoHost_Users.json"
-chmod 400 "$datadir/groups/YunoHost_Users.json"
-chown $app:$app "$datadir/groups/YunoHost_Users.json"
+ynh_add_config --template="../conf/groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
+chmod 400 "$data_dir/groups/YunoHost_Users.json"
+chown $app:$app "$data_dir/groups/YunoHost_Users.json"
#=================================================
# SETUP SYSTEMD
@@ -220,14 +220,14 @@ ynh_systemd_action --service_name=${app}_ldap --action="start" --log_path="syste
#=================================================
# SETUP SSOWAT
#=================================================
-ynh_script_progression --message="Configuring permissions..." --weight=2
+#REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=2
# 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
#=================================================
diff --git a/scripts/remove b/scripts/remove
index dc1df05..dc8698e 100755
--- a/scripts/remove
+++ b/scripts/remove
@@ -12,14 +12,14 @@ source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-turn_port=$(ynh_app_setting_get --app=$app --key=turn_port)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? turn_port=$(ynh_app_setting_get --app=$app --key=turn_port)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
#=================================================
# STANDARD REMOVE
@@ -52,10 +52,10 @@ ynh_remove_systemd_config --service=${app}_ldap
#=================================================
# REMOVE APP MAIN DIR
#=================================================
-ynh_script_progression --message="Removing app main directory..." --weight=2
+#REMOVEME? ynh_script_progression --message="Removing app main directory..." --weight=2
# Remove the app directory securely
-ynh_secure_remove --file="$final_path"
+#REMOVEME? ynh_secure_remove --file="$install_dir"
#=================================================
# REMOVE DATA DIR
@@ -65,7 +65,7 @@ ynh_secure_remove --file="$final_path"
if [ "${YNH_APP_PURGE:-0}" -eq 1 ]
then
ynh_script_progression --message="Removing app data directory..." --weight=1
- ynh_secure_remove --file="$datadir"
+#REMOVEME? ynh_secure_remove --file="$data_dir"
fi
#=================================================
@@ -79,10 +79,10 @@ ynh_remove_nginx_config
#=================================================
# REMOVE DEPENDENCIES
#=================================================
-ynh_script_progression --message="Removing dependencies..." --weight=1
+#REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=1
# Remove metapackage and its dependencies
-ynh_remove_app_dependencies
+#REMOVEME? ynh_remove_app_dependencies
#=================================================
# CLOSE A PORT
@@ -107,10 +107,10 @@ fi
#=================================================
# REMOVE DEDICATED USER
#=================================================
-ynh_script_progression --message="Removing the dedicated system user..." --weight=1
+#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." --weight=1
# Delete a system user
-ynh_system_user_delete --username=$app
+#REMOVEME? ynh_system_user_delete --username=$app
#=================================================
# END OF SCRIPT
diff --git a/scripts/restore b/scripts/restore
index 3ab3d80..7aa61fd 100755
--- a/scripts/restore
+++ b/scripts/restore
@@ -14,77 +14,77 @@ 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_script_progression --message="Loading installation settings..." --weight=1
+#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? 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)
-group_name=$(ynh_app_setting_get --app=$app --key=group_name)
-turn_port=$(ynh_app_setting_get --app=$app --key=turn_port)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
+#REMOVEME? group_name=$(ynh_app_setting_get --app=$app --key=group_name)
+#REMOVEME? turn_port=$(ynh_app_setting_get --app=$app --key=turn_port)
+#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..." --weight=1
+#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." --weight=1
-test ! -d $final_path \
- || ynh_die --message="There is already a directory: $final_path "
+#REMOVEME? test ! -d $install_dir \
+ || 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..." --weight=2
+#REMOVEME? 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"
+#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..." --weight=1
-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 750 "$install_dir"
+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/{groups,recordings}
+mkdir -p $data_dir/{groups,recordings}
-chmod 750 "$datadir"
-chmod -R o-rwx "$datadir"
-chown -R $app:www-data "$datadir"
+chmod 750 "$data_dir"
+chmod -R o-rwx "$data_dir"
+chown -R $app:www-data "$data_dir"
#=================================================
# SPECIFIC RESTORATION
#=================================================
# REINSTALL DEPENDENCIES
#=================================================
-ynh_script_progression --message="Reinstalling dependencies..." --weight=1
+#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." --weight=1
# Define and install dependencies
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
#=================================================
# RESTORE THE NGINX CONFIGURATION
diff --git a/scripts/upgrade b/scripts/upgrade
index bcc8364..77e4277 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -13,22 +13,22 @@ source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? 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=$(ynh_app_setting_get --app=$app --key=admin)
-password=$(ynh_app_setting_get --app=$app --key=password)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-group_name=$(ynh_app_setting_get --app=$app --key=group_name)
-group_description=$(ynh_app_setting_get --app=$app --key=group_description)
-port=$(ynh_app_setting_get --app=$app --key=port)
-ldap_port=$(ynh_app_setting_get --app=$app --key=ldap_port)
-key=$(ynh_app_setting_get --app=$app --key=key)
-turn_port=$(ynh_app_setting_get --app=$app --key=turn_port)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
+#REMOVEME? admin=$(ynh_app_setting_get --app=$app --key=admin)
+#REMOVEME? password=$(ynh_app_setting_get --app=$app --key=password)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
+#REMOVEME? group_name=$(ynh_app_setting_get --app=$app --key=group_name)
+#REMOVEME? group_description=$(ynh_app_setting_get --app=$app --key=group_description)
+#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port)
+#REMOVEME? ldap_port=$(ynh_app_setting_get --app=$app --key=ldap_port)
+#REMOVEME? key=$(ynh_app_setting_get --app=$app --key=key)
+#REMOVEME? turn_port=$(ynh_app_setting_get --app=$app --key=turn_port)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
if ynh_compare_current_package_version --comparison le --version 0.3.5~ynh3
then
@@ -45,16 +45,16 @@ 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=1
+#REMOVEME? ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1
# Backup the current version of the app
-ynh_backup_before_upgrade
-ynh_clean_setup () {
+#REMOVEME? ynh_backup_before_upgrade
+#REMOVEME? ynh_clean_setup () {
# 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
@@ -77,50 +77,50 @@ then
ynh_exec_warn_less yunohost firewall disallow TCP $port
fi
-# If final_path doesn't exist, create it
-if [ -z "$final_path" ]; then
- final_path=/var/www/$app
- mkdir -p $final_path
- ynh_app_setting_set --app=$app --key=final_path --value=$final_path
+# If install_dir doesn't exist, create it
+if [ -z "$install_dir" ]; then
+#REMOVEME? install_dir=/var/www/$app
+ mkdir -p $install_dir
+#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
fi
# If ldap_port doesn't exist, create it
if [ -z "$ldap_port" ]; then
- ldap_port=$(ynh_find_port --port=$(($port + 1)))
- ynh_app_setting_set --app=$app --key=port --value=$ldap_port
+#REMOVEME? ldap_port=$(ynh_find_port --port=$(($port + 1)))
+#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$ldap_port
fi
# Cleaning legacy permissions
-if ynh_legacy_permissions_exists; then
- ynh_legacy_permissions_delete_all
+#REMOVEME? if ynh_legacy_permissions_exists; then
+#REMOVEME? ynh_legacy_permissions_delete_all
ynh_app_setting_delete --app=$app --key=is_public
fi
# We remove the old admin/password file if present
-if [ -f "$final_path/data/passwd" ] ; then
- ynh_secure_remove --file="$final_path/data/passwd"
+if [ -f "$install_dir/data/passwd" ] ; then
+#REMOVEME? ynh_secure_remove --file="$install_dir/data/passwd"
fi
# For version 0.6~ynh1 and before
-if [[ ! -d "$final_path/live" ]]
+if [[ ! -d "$install_dir/live" ]]
then
tempdir="$(mktemp -d)"
- mv $final_path $tempdir
- mkdir -p "$final_path/live"
- mv $tempdir/$app/galene "$final_path/live/"
- mv $tempdir/$app/data/ "$final_path/live/"
- mv $tempdir/$app/static/ "$final_path/live/"
+ mv $install_dir $tempdir
+ mkdir -p "$install_dir/live"
+ mv $tempdir/$app/galene "$install_dir/live/"
+ mv $tempdir/$app/data/ "$install_dir/live/"
+ mv $tempdir/$app/static/ "$install_dir/live/"
ynh_secure_remove --file="$tempdir"
fi
#=================================================
# CREATE DEDICATED USER
#=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
+#REMOVEME? 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"
+#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -128,24 +128,24 @@ ynh_system_user_create --username=$app --home_dir="$final_path"
ynh_script_progression --message="Upgrading source files..." --weight=2
-ynh_setup_source --dest_dir="$final_path/build"
-ynh_setup_source --dest_dir="$final_path/build_ldap" --source_id="ldap"
-mkdir -p "$final_path/live/data"
-mkdir -p "$final_path/live_ldap/data"
-ynh_secure_remove --file="$final_path/live/static/"
-cp -r "$final_path/build/static/" "$final_path/live/"
-ynh_replace_string --match_string="" --replace_string="" --target_file="$final_path/live/static/galene.html"
+ynh_setup_source --dest_dir="$install_dir/build"
+ynh_setup_source --dest_dir="$install_dir/build_ldap" --source_id="ldap"
+mkdir -p "$install_dir/live/data"
+mkdir -p "$install_dir/live_ldap/data"
+#REMOVEME? ynh_secure_remove --file="$install_dir/live/static/"
+cp -r "$install_dir/build/static/" "$install_dir/live/"
+ynh_replace_string --match_string="" --replace_string="" --target_file="$install_dir/live/static/galene.html"
-chmod 750 "$final_path"
-chmod -R o-rwx "$final_path"
-chown -R $app:www-data "$final_path"
+chmod 750 "$install_dir"
+chmod -R o-rwx "$install_dir"
+chown -R $app:www-data "$install_dir"
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
-ynh_script_progression --message="Upgrading dependencies..." --weight=1
+#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=1
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
#=================================================
# NGINX CONFIGURATION
@@ -166,18 +166,18 @@ if [ "$upgrade_type" == "UPGRADE_APP" ]
then
ynh_exec_warn_less ynh_install_go --go_version=$go_version
ynh_use_go
- pushd $final_path/build/
- ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $final_path/live/
+ pushd $install_dir/build/
+ ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $install_dir/live/
popd
- pushd $final_path/build_ldap/
- ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $final_path/live_ldap/
+ pushd $install_dir/build_ldap/
+ ynh_exec_as $app CGO_ENABLED=0 $ynh_go build -ldflags='-s -w' -o $install_dir/live_ldap/
popd
ynh_remove_go
- ynh_secure_remove --file="$final_path/build/"
- ynh_secure_remove --file="$final_path/build_ldap/"
- ynh_secure_remove --file="$final_path/.cache/"
- ynh_secure_remove --file="$final_path/go/"
- ynh_secure_remove --file="$final_path/.go-version"
+#REMOVEME? ynh_secure_remove --file="$install_dir/build/"
+#REMOVEME? ynh_secure_remove --file="$install_dir/build_ldap/"
+#REMOVEME? ynh_secure_remove --file="$install_dir/.cache/"
+#REMOVEME? ynh_secure_remove --file="$install_dir/go/"
+#REMOVEME? ynh_secure_remove --file="$install_dir/.go-version"
fi
#=================================================
@@ -186,9 +186,9 @@ fi
ynh_script_progression --message="Updating a configuration file..." --weight=2
# Configure Galène
-ynh_add_config --template="../conf/config.json" --destination="$final_path/live/data/config.json"
-chmod 400 "$final_path/live/data/config.json"
-chown $app:$app "$final_path/live/data/config.json"
+ynh_add_config --template="../conf/config.json" --destination="$install_dir/live/data/config.json"
+chmod 400 "$install_dir/live/data/config.json"
+chown $app:$app "$install_dir/live/data/config.json"
# Configure Galène LDAP
# If key doesn't exist, create it
@@ -196,19 +196,19 @@ if [ -z "$key" ]; then
key=$(jose jwk gen -i '{"kty":"oct","alg":"HS256"}')
ynh_app_setting_set --app=$app --key=key --value=$key
fi
-ynh_add_config --template="../conf/galene-ldap.json" --destination="$final_path/live_ldap/data/galene-ldap.json"
-chmod 400 "$final_path/live_ldap/data/galene-ldap.json"
-chown $app:$app "$final_path/live_ldap/data/galene-ldap.json"
+ynh_add_config --template="../conf/galene-ldap.json" --destination="$install_dir/live_ldap/data/galene-ldap.json"
+chmod 400 "$install_dir/live_ldap/data/galene-ldap.json"
+chown $app:$app "$install_dir/live_ldap/data/galene-ldap.json"
# Create a group name config
-ynh_add_config --template="../conf/groupname.json" --destination="$datadir/groups/$group_name.json"
-chmod 400 "$datadir/groups/$group_name.json"
-chown $app:$app "$datadir/groups/$group_name.json"
+ynh_add_config --template="../conf/groupname.json" --destination="$data_dir/groups/$group_name.json"
+chmod 400 "$data_dir/groups/$group_name.json"
+chown $app:$app "$data_dir/groups/$group_name.json"
# Create a group name authenticated on LDAP
-ynh_add_config --template="../conf/groupname-ldap.json" --destination="$datadir/groups/YunoHost_Users.json"
-chmod 400 "$datadir/groups/YunoHost_Users.json"
-chown $app:$app "$datadir/groups/YunoHost_Users.json"
+ynh_add_config --template="../conf/groupname-ldap.json" --destination="$data_dir/groups/YunoHost_Users.json"
+chmod 400 "$data_dir/groups/YunoHost_Users.json"
+chown $app:$app "$data_dir/groups/YunoHost_Users.json"
#=================================================
# SETUP SYSTEMD