v2

manifest.toml

@@ -0,0 +1,42 @@
+packaging_format = 2
+
+id = "samba"
+name = "Samba"
+description.en = "Share directories on your private network thanks to SMB protocol"
+description.fr = "Partager des dossiers sur un réseau privé via le protocole SMB"
+
+version = "4.13.13~ynh1"
+
+maintainers = ["Galette"]
+
+[upstream]
+license = "AGPL-3.0-only"
+website = "https://www.samba.org/"
+admindoc = "https://www.samba.org/samba/docs/"
+code = "https://git.samba.org/?p=samba.git;a=summary"
+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.2"
+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 = false
+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.warning]
+    ask.en = "I understand this app is only for private network purpose and i should not install it on a server with a public IP or open the 445 port on my home router."
+    ask.fr = "Je comprends que cette application est uniquement à des fins de réseau privé et que je ne dois pas l'installer sur un serveur avec une adresse IP publique ou ouvrir le port 445 sur mon routeur."
+    type = "display_text"
+
+[resources]
+    [resources.system_user]
+
+    [resources.install_dir]
+
+    [resources.data_dir]
+
+    [resources.permissions]

scripts/_common.sh

@@ -5,7 +5,7 @@
 #=================================================
 
 # dependencies used by the app
-pkg_dependencies="samba"
+#REMOVEME? pkg_dependencies="samba"
 
 #=================================================
 # PERSONAL HELPERS

scripts/backup

@@ -15,18 +15,18 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 # 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
@@ -37,13 +37,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
 
 #=================================================
 # END OF SCRIPT

scripts/install

@@ -14,31 +14,31 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 # 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
 #=================================================
 
-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..."
+#REMOVEME? ynh_script_progression --message="Validating installation parameters..."
 
-final_path="/etc/samba"
+#REMOVEME? install_dir="/etc/samba"
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
-ynh_script_progression --message="Storing installation settings..." --weight=1
+#REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=1
 
 ynh_app_setting_set --app=$app --key=directories --value=shared
 ynh_app_setting_set --app=$app --key=advanced --value=0
 ynh_app_setting_set --app=$app --key=readonly_dir --value=''
 ynh_app_setting_set --app=$app --key=unbrowseable --value=''
-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
 
 #=================================================
 # STANDARD MODIFICATIONS
@@ -52,52 +52,52 @@ ynh_exec_warn_less yunohost firewall allow Both 445 --no-upnp
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Installing dependencies..." --weight=10
+#REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=10
 
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # SPECIFIC SETUP
 #=================================================
 # SETUP SSOWAT 
 #=================================================
-ynh_script_progression --message="Configuring permissions..."
+#REMOVEME? ynh_script_progression --message="Configuring permissions..."
 
 # We define the permission in advance to be able to use the group
 # in unix permission
-ynh_permission_create --permission="share" --allowed=all_users
+#REMOVEME? ynh_permission_create --permission="share" --allowed=all_users
 #=================================================
 # CREATE DATA DIRECTORY
 #=================================================
 ynh_script_progression --message="Creating a data directory..." --weight=1
 
-datadir=/home/yunohost.app/samba
+#REMOVEME? data_dir=/home/yunohost.app/samba
-ynh_app_setting_set --app=samba --key=datadir --value=$datadir
+#REMOVEME? ynh_app_setting_set --app=samba --key=data_dir --value=$data_dir
 
-mkdir -p $datadir/share
+mkdir -p $data_dir/share
 
-chmod 750 "$datadir/share"
+chmod 750 "$data_dir/share"
-chmod -R o-rwx "$datadir/share"
+chmod -R o-rwx "$data_dir/share"
-chown -R root:root "$datadir/share"
+chown -R root:root "$data_dir/share"
-setfacl -R -m g:samba.share:rwx,d:g:samba.share:rwx $datadir/share
+setfacl -R -m g:samba.share:rwx,d:g:samba.share:rwx $data_dir/share
 
 #=================================================
 # ADD A CONFIGURATION
 #=================================================
 ynh_script_progression --message="Adding a configuration file..." --weight=1
 
-mkdir -p $final_path/smb.conf.d
+mkdir -p $install_dir/smb.conf.d
-ynh_add_config --template="global-smb.conf" --destination="$final_path/smb.conf.d/0-global.conf"
+ynh_add_config --template="global-smb.conf" --destination="$install_dir/smb.conf.d/0-global.conf"
-ynh_add_config --template="share-smb.conf" --destination="$final_path/smb.conf.d/share.conf"
+ynh_add_config --template="share-smb.conf" --destination="$install_dir/smb.conf.d/share.conf"
 
-    cat > $final_path/smb.conf <<EOF
+    cat > $install_dir/smb.conf <<EOF
 # ================================================= 
 # DO NOT EDIT THIS FILE
 # EDIT SUBPARTS IN /etc/samba/smb.conf.d
 # =================================================
 
 EOF
-cat $final_path/smb.conf.d/*.conf >> $final_path/smb.conf
+cat $install_dir/smb.conf.d/*.conf >> $install_dir/smb.conf
 
 #=================================================
 # GENERIC FINALIZATION

scripts/remove

@@ -12,12 +12,12 @@ 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
 
-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
@@ -35,10 +35,10 @@ fi
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Removing dependencies..." --weight=2
+#REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=2
 
 # Remove metapackage and its dependencies
-ynh_remove_app_dependencies
+#REMOVEME? ynh_remove_app_dependencies
 
 #=================================================
 # REMOVE DATA DIR
@@ -48,8 +48,8 @@ ynh_remove_app_dependencies
 if [ "${YNH_APP_PURGE:-0}" -eq 1 ]
 then
 	ynh_script_progression --message="Removing app data directory..." --weight=10
-	ynh_secure_remove --file="$datadir"
+#REMOVEME? 	ynh_secure_remove --file="$data_dir"
-	ynh_secure_remove --file="$final_path"
+#REMOVEME? 	ynh_secure_remove --file="$install_dir"
 fi
 
 #=================================================

scripts/restore

@@ -14,30 +14,30 @@ 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..." --weight=1
+#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1
 
-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)
-datadir=$(ynh_app_setting_get --app=$app --key=datadir)
+#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
-directories=$(ynh_app_setting_get --app=$app --key=directories)
+#REMOVEME? directories=$(ynh_app_setting_get --app=$app --key=directories)
-advanced=$(ynh_app_setting_get --app=$app --key=advanced)
+#REMOVEME? advanced=$(ynh_app_setting_get --app=$app --key=advanced)
-readonly_dir=$(ynh_app_setting_get --app=$app --key=readonly_dir)
+#REMOVEME? readonly_dir=$(ynh_app_setting_get --app=$app --key=readonly_dir)
-unbrowseable=$(ynh_app_setting_get --app=$app --key=unbrowseable)
+#REMOVEME? unbrowseable=$(ynh_app_setting_get --app=$app --key=unbrowseable)
 
 #=================================================
 # 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
 
 #=================================================
 # STANDARD RESTORATION STEPS
@@ -46,34 +46,34 @@ ynh_script_progression --message="Validating restoration parameters..." --weight
 #=================================================
 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 root:root "$final_path"
+chown -R root:root "$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
+mkdir -p $data_dir
 
-chmod 750 "$datadir"
+chmod 750 "$data_dir"
-chmod -R o-rwx "$datadir"
+chmod -R o-rwx "$data_dir"
-chown -R root:root "$datadir"
+chown -R root:root "$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
 
 #=================================================
 # FIND AND OPEN A PORT

scripts/upgrade

@@ -12,9 +12,9 @@ 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
 
 #=================================================
 # CHECK VERSION
@@ -26,17 +26,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)..." --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
+#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
@@ -55,9 +55,9 @@ ynh_script_progression --message="Ensuring downward compatibility..."
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Upgrading dependencies..." --weight=12
+#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=12
 
-ynh_install_app_dependencies $pkg_dependencies
+#REMOVEME? ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # GENERIC FINALIZATION