From 2ef5d205b59176533ef1537e6a15055e261cff8c Mon Sep 17 00:00:00 2001 From: Galette Date: Tue, 22 Feb 2022 14:12:51 +0100 Subject: [PATCH 1/9] change the manifest --- manifest.json | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/manifest.json b/manifest.json index 30cb9f5..3825fb6 100644 --- a/manifest.json +++ b/manifest.json @@ -3,14 +3,14 @@ "id": "samba", "packaging_format": 1, "description": { - "en": "Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)", - "fr": "Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)" + "en": "", + "fr": "Un apllication pour partage des dossiers sur un reseaux privé via le protocole SMB" }, - "version": "1.0~ynh1", - "url": "https://example.com", + "version": "4.9.5~ynh1", + "url": "https://www.samba.org/", "upstream": { "license": "free", - "website": "https://example.com", + "website": "https://www.samba.org/", "demo": "https://demo.example.com", "admindoc": "https://yunohost.org/packaging_apps", "userdoc": "https://yunohost.org/apps", @@ -18,22 +18,16 @@ }, "license": "free", "maintainer": { - "name": "John doe", - "email": "john.doe@example.com" + "name": "Galette", + "email": "" }, "requirements": { "yunohost": ">= 4.3.0" }, - "multi_instance": true, - "services": [ - "nginx" - ], + "multi_instance": false, + "services": [], "arguments": { "install" : [ - { - "name": "domain", - "type": "domain" - } ] } } From 2584774a41784ef403ee4d3dd2f603c1baae3f11 Mon Sep 17 00:00:00 2001 From: root Date: Tue, 22 Feb 2022 17:45:17 +0100 Subject: [PATCH 2/9] setup default share directory --- conf/post_user_create | 6 + conf/post_user_delete | 3 + conf/post_user_update | 6 + conf/smb.conf | 258 ++++-------------------------------------- scripts/_common.sh | 2 +- scripts/install | 53 +++++---- 6 files changed, 69 insertions(+), 259 deletions(-) create mode 100644 conf/post_user_create create mode 100644 conf/post_user_delete create mode 100644 conf/post_user_update diff --git a/conf/post_user_create b/conf/post_user_create new file mode 100644 index 0000000..51f04ad --- /dev/null +++ b/conf/post_user_create @@ -0,0 +1,6 @@ +#!/bin/bash + + +echo "${YNH_USER_PASSWORD} +${YNH_USER_PASSWORD} +" | sudo smbpasswd -a $YNH_USER_USERNAME diff --git a/conf/post_user_delete b/conf/post_user_delete new file mode 100644 index 0000000..659412d --- /dev/null +++ b/conf/post_user_delete @@ -0,0 +1,3 @@ +#!/bin/bash + +user=$1 diff --git a/conf/post_user_update b/conf/post_user_update new file mode 100644 index 0000000..0cad18f --- /dev/null +++ b/conf/post_user_update @@ -0,0 +1,6 @@ +#!/bin/bash + +echo "${YNH_USER_PASSWORD} +${YNH_USER_PASSWORD} +" | sudo smbpasswd -a $YNH_USER_USERNAME + diff --git a/conf/smb.conf b/conf/smb.conf index 919876a..2a57f80 100644 --- a/conf/smb.conf +++ b/conf/smb.conf @@ -1,250 +1,40 @@ -# This is the main Samba configuration file. You should read the -# smb.conf(5) manual page in order to understand the options listed -# here. Samba has a huge number of configurable options most of which -# are not shown in this example -# -# Some options that are often worth tuning have been included as -# commented-out examples in this file. -# - When such options are commented with ";", the proposed setting -# differs from the default Samba behaviour -# - When commented with "#", the proposed setting is the default -# behaviour of Samba but the option is considered important -# enough to be mentioned here -# -# NOTE: Whenever you modify this file you should run the command -# "testparm" to check that you have not made any basic syntactic -# errors. - -#======================= Global Settings ======================= - [global] -## Browsing/Identification ### - -# Change this to the workgroup/NT-domain name your Samba server will part of - workgroup = __WORKGROUP__ - -# server string is the equivalent of the NT Description field - server string = Toaster Data - - security = user - map to guest = Bad User - -# This will prevent nmbd to search for NetBIOS names through DNS. - dns proxy = no - -#### Networking #### - -# The specific set of interfaces / networks to bind to -# This can be either the interface name or an IP address/netmask; -# interface names are normally preferred -# interfaces = 0.0.0.0/32 - - -# Only bind to the named interfaces and/or networks; you must use the -# 'interfaces' option above to use this. -# It is recommended that you enable this feature if your Samba machine is -# not protected by a firewall or is a firewall itself. However, this -# option cannot handle dynamic or non-broadcast interfaces correctly. - bind interfaces only = yes - - - -#### Debugging/Accounting #### - -# This tells Samba to use a separate log file for each machine -# that connects log file = /var/log/samba/log.%m - -# Cap the size of the individual log files (in KiB). max log size = 1000 + logging = file + panic action = /usr/share/samba/panic-action %d -####### Authentication ####### - -# Server role. Defines in which mode Samba will operate. Possible -# values are "standalone server", "member server", "classic primary -# domain controller", "classic backup domain controller", "active -# directory domain controller". -# -# Most people will want "standalone sever" or "member server". -# Running as "active directory domain controller" will require first -# running "samba-tool domain provision" to wipe databases and create a -# new domain. server role = standalone server -# If you are using encrypted passwords, Samba will need to know what -# password database type you are using. - passdb backend = tdbsam - obey pam restrictions = yes - -# This boolean parameter controls whether Samba attempts to sync the Unix -# password with the SMB password when the encrypted SMB password in the -# passdb is changed. unix password sync = yes - -# For Unix password sync to work on a Debian GNU/Linux system, the following -# parameters must be set (thanks to Ian Kahan < for -# sending the correct chat script for the passwd program in Debian Sarge). passwd program = /usr/bin/passwd %u passwd chat = *Enter\snew\s*\spassword:* %n\n *Retype\snew\s*\spassword:* %n\n *password\supdated\ssuccessfully* . - -# This boolean controls whether PAM will be used for password changes -# when requested by an SMB client instead of the program listed in -# 'passwd program'. The default is 'no'. pam password change = yes + map to guest = bad user -########## Domains ########### + usershare allow guests = yes -# -# The following settings only takes effect if 'server role = primary -# classic domain controller', 'server role = backup domain controller' -# or 'domain logons' is set -# -# It specifies the location of the user's -# profile directory from the client point of view) The following -# required a [profiles] share to be setup on the samba server (see -# below) -; logon path = \\%N\profiles\%U -# Another common choice is storing the profile in the user's home directory -# (this is Samba's default) -# logon path = \\%N\%U\profile +[homes] + comment = Home Directories + browseable = yes + read only = yes + create mask = 0700 + directory mask = 0700 + valid users = %S -# The following setting only takes effect if 'domain logons' is set -# It specifies the location of a user's home directory (from the client -# point of view) -; logon drive = H: -# logon home = \\%N\%U - -# The following setting only takes effect if 'domain logons' is set -# It specifies the script to run during logon. The script must be stored -# in the [netlogon] share -# NOTE: Must be store in 'DOS' file format convention -; logon script = logon.cmd - -# This allows Unix users to be created on the domain controller via the SAMR -# RPC pipe. The example command creates a user account with a disabled Unix -# password; please adapt to your needs -; add user script = /usr/sbin/adduser --quiet --disabled-password --gecos "" %u - -# This allows machine accounts to be created on the domain controller via the -# SAMR RPC pipe. -# The following assumes a "machines" group exists on the system -; add machine script = /usr/sbin/useradd -g machines -c "%u machine account" -d /var/lib/samba -s /bin/false %u - -# This allows Unix groups to be created on the domain controller via the SAMR -# RPC pipe. -; add group script = /usr/sbin/addgroup --force-badname %g - -############ Misc ############ - -# Using the following line enables you to customise your configuration -# on a per machine basis. The %m gets replaced with the netbios name -# of the machine that is connecting -; include = /home/samba/etc/smb.conf.%m - -# Some defaults for winbind (make sure you're not using the ranges -# for something else.) -; idmap uid = 10000-20000 -; idmap gid = 10000-20000 -; template shell = /bin/bash - -# Setup usershare options to enable non-root users to share folders -# with the net usershare command. - -# Maximum number of usershare. 0 (default) means that usershare is disabled. -; usershare max shares = 100 - -# Allow users who've been granted usershare privileges to create -# public shares, not just authenticated ones -# usershare allow guests = yes - -#======================= Share Definitions ======================= - -# Un-comment the following (and tweak the other settings below to suit) -# to enable the default home directory shares. This will share each -# user's home directory as \\server\username -;[homes] -; comment = Home Directories -; browseable = no - -# By default, the home directories are exported read-only. Change the -# next parameter to 'no' if you want to be able to write to them. -; read only = yes - -# File creation mask is set to 0700 for security reasons. If you want to -# create files with group=rw permissions, set next parameter to 0775. -; create mask = 0700 - -# Directory creation mask is set to 0700 for security reasons. If you want to -# create dirs. with group=rw permissions, set next parameter to 0775. -; directory mask = 0700 - -# By default, \\server\username shares can be connected to by anyone -# with access to the samba server. -# Un-comment the following parameter to make sure that only "username" -# can connect to \\server\username -# This might need tweaking when using external authentication schemes -; valid users = %S - -# Un-comment the following and create the netlogon directory for Domain Logons -# (you need to configure Samba to act as a domain controller too.) -;[netlogon] -; comment = Network Logon Service -; path = /home/samba/netlogon -; guest ok = yes -; read only = yes - -# Un-comment the following and create the profiles directory to store -# users profiles (see the "logon path" option above) -# (you need to configure Samba to act as a domain controller too.) -# The path below should be writable by all users so that their -# profile directory may be created the first time they log on -;[profiles] -; comment = Users profiles -; path = /home/samba/profiles -; guest ok = no -; browseable = no -; create mask = 0600 -; directory mask = 0700 - -;[printers] -; comment = All Printers -; browseable = no -; path = /var/spool/samba -; printable = yes -; guest ok = no -; read only = yes -; create mask = 0700 - -# Windows clients look for this share name as a source of downloadable -# printer drivers -;[print$] -; comment = Printer Drivers -; path = /var/lib/samba/printers -; browseable = yes -; read only = yes -; guest ok = no -# Uncomment to allow remote administration of Windows print drivers. -# You may need to replace 'lpadmin' with the name of the group your -# admin users are members of. -# Please note that you also need to set appropriate Unix permissions -# to the drivers directory for these users to have write rights in it -; write list = root, @lpadmin - -[workdir] - path = /workdir - public = yes - case sensitive = yes - map archive = no - only guest = yes - writable = yes - force user = smbuser - force group = smbuser - -[sambashare] - comment = Samba YunoHost - path = __DATADIR__ - read only = no - browsable = yes \ No newline at end of file +[share] + comment = share (D) + read only = no + path = /home/yunhost.app/samba/share + guest ok = no + browsable = yes + valid users = @samba.share + directory mask = 770 + create mask = 0660 + vfs objects = dfs_samba4 acl_xattr recycle + recycle:repository = .recycle + recycle:keeptree = yes + recycle:versions = yes diff --git a/scripts/_common.sh b/scripts/_common.sh index 67ac18f..54e3926 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -5,7 +5,7 @@ #================================================= # dependencies used by the app -pkg_dependencies="samba smbfs" +pkg_dependencies="samba" #================================================= # PERSONAL HELPERS diff --git a/scripts/install b/scripts/install index 7112563..d741b54 100755 --- a/scripts/install +++ b/scripts/install @@ -20,30 +20,19 @@ ynh_abort_if_errors # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -admin=$YNH_APP_ARG_ADMIN - app=$YNH_APP_INSTANCE_NAME -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --time --weight=1 - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - #================================================= # STORE SETTINGS FROM MANIFEST #================================================= ynh_script_progression --message="Storing installation settings..." --time --weight=1 -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url +#================================================= +# FIND AND OPEN A PORT +#================================================= + +ynh_exec_warn_less yunohost firewall allow Both 445 --no-upnp + #================================================= # INSTALL DEPENDENCIES @@ -57,21 +46,31 @@ ynh_install_app_dependencies $pkg_dependencies #================================================= ynh_script_progression --message="Creating a data directory..." --time --weight=1 -datadir=/home/yunohost.app/$app -ynh_app_setting_set --app=$app --key=datadir --value=$datadir +datadir=/home/yunohost.app/samba +ynh_app_setting_set --app=samba --key=datadir --value=$datadir -mkdir -p $datadir +mkdir -p $datadir/share -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" +chmod 750 "$datadir/share" +chmod -R o-rwx "$datadir/share" +chown -R root:root "$datadir/share" +setfacl -R -m g:all_users:rwx,d:g:all_users:rwx $datadir/share #================================================= # ADD A CONFIGURATION #================================================= ynh_script_progression --message="Adding a configuration file..." --time --weight=1 -echo -e "[sambashare]\ncomment = YunoHost\npath = ${datadir}\nread only = no\nbrowsable = yes" >> /etc/samba/smb.conf +ynh_add_config --template="smb.conf" --destination="/etc/samba/smb.conf" +ynh_add_config --template="post_user_create" --destination="/etc/yunohost/hooks.d/post_user_create/$app" +ynh_add_config --template="post_user_delete" --destination="/etc/yunohost/hooks.d/post_user_delete/$app" +ynh_add_config --template="post_user_update" --destination="/etc/yunohost/hooks.d/post_user_update/$app" + +#================================================ +# INTEGRATE SERVICE IN YUNOHOST +#================================================ + +yunohost service add smbd --description="Samba service" --log="/var/log/smbd/smbd.log" #================================================= # START SYSTEMD SERVICE @@ -81,6 +80,12 @@ ynh_script_progression --message="Starting a systemd service..." --time --weight # Start a systemd service ynh_systemd_action --service_name=smbd --action="start" +#================================================= +# SETUP SSOWAT +#================================================= + +ynh_permission_create --permission="share" --allowed=all_users + #================================================= # END OF SCRIPT #================================================= From 7f75aeb461fe1f24263495adae511da9bbfd451a Mon Sep 17 00:00:00 2001 From: root Date: Tue, 22 Feb 2022 18:18:57 +0100 Subject: [PATCH 3/9] [fix] Use hooks directory --- {conf => hooks}/post_user_create | 0 {conf => hooks}/post_user_delete | 0 {conf => hooks}/post_user_update | 0 scripts/install | 3 --- 4 files changed, 3 deletions(-) rename {conf => hooks}/post_user_create (100%) rename {conf => hooks}/post_user_delete (100%) rename {conf => hooks}/post_user_update (100%) diff --git a/conf/post_user_create b/hooks/post_user_create similarity index 100% rename from conf/post_user_create rename to hooks/post_user_create diff --git a/conf/post_user_delete b/hooks/post_user_delete similarity index 100% rename from conf/post_user_delete rename to hooks/post_user_delete diff --git a/conf/post_user_update b/hooks/post_user_update similarity index 100% rename from conf/post_user_update rename to hooks/post_user_update diff --git a/scripts/install b/scripts/install index d741b54..eafdab8 100755 --- a/scripts/install +++ b/scripts/install @@ -62,9 +62,6 @@ setfacl -R -m g:all_users:rwx,d:g:all_users:rwx $datadir/share ynh_script_progression --message="Adding a configuration file..." --time --weight=1 ynh_add_config --template="smb.conf" --destination="/etc/samba/smb.conf" -ynh_add_config --template="post_user_create" --destination="/etc/yunohost/hooks.d/post_user_create/$app" -ynh_add_config --template="post_user_delete" --destination="/etc/yunohost/hooks.d/post_user_delete/$app" -ynh_add_config --template="post_user_update" --destination="/etc/yunohost/hooks.d/post_user_update/$app" #================================================ # INTEGRATE SERVICE IN YUNOHOST From ca18c963099f0fe1c67e73fdf10762430d8f57b7 Mon Sep 17 00:00:00 2001 From: Galettofraise Date: Thu, 24 Feb 2022 16:14:35 +0100 Subject: [PATCH 4/9] [fix] the path of share --- conf/smb.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf/smb.conf b/conf/smb.conf index 2a57f80..71776ad 100644 --- a/conf/smb.conf +++ b/conf/smb.conf @@ -31,7 +31,7 @@ path = /home/yunhost.app/samba/share guest ok = no browsable = yes - valid users = @samba.share + valid users = @samba.local, @samba, @samba.share directory mask = 770 create mask = 0660 vfs objects = dfs_samba4 acl_xattr recycle From 75b1c80032dbab2a34834187a08fe711d6a0e72e Mon Sep 17 00:00:00 2001 From: Galettofraise Date: Thu, 24 Feb 2022 17:58:28 +0100 Subject: [PATCH 5/9] [fix] cp smb.conf --- conf/smb.conf | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/conf/smb.conf b/conf/smb.conf index 71776ad..ce005b5 100644 --- a/conf/smb.conf +++ b/conf/smb.conf @@ -14,13 +14,14 @@ pam password change = yes map to guest = bad user - usershare allow guests = yes + usershare allow guests = yes + browseable = yes [homes] comment = Home Directories - browseable = yes - read only = yes + browseable = no + read only = no create mask = 0700 directory mask = 0700 valid users = %S @@ -28,12 +29,12 @@ [share] comment = share (D) read only = no - path = /home/yunhost.app/samba/share + path = /home/yunohost.app/samba/share guest ok = no browsable = yes - valid users = @samba.local, @samba, @samba.share - directory mask = 770 + valid users = @samba.share create mask = 0660 + directory mask = 770 vfs objects = dfs_samba4 acl_xattr recycle recycle:repository = .recycle recycle:keeptree = yes From 2159874de37c48690f3b722645398c34bedd14bc Mon Sep 17 00:00:00 2001 From: Galettofraise Date: Fri, 25 Feb 2022 12:34:23 +0100 Subject: [PATCH 6/9] [Add] Add config_panel --- config_panel.toml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 config_panel.toml diff --git a/config_panel.toml b/config_panel.toml new file mode 100644 index 0000000..d5904a3 --- /dev/null +++ b/config_panel.toml @@ -0,0 +1,26 @@ +version = "1.0" + +[main] +name = "shared directory" + +[main.main] + name = "" + optional = true + +[main.main.directory] + ask = "List of share directory" + type = "tags" + +[main.main.advanced] + ask = "Advanced parameter" + type = "boolean" + +[main.main.readonly] + ask = "List of read only directory" + type = "tags" + visible = "advanced" + +[main.main.unbrowseable] + ask = "List of invisible directory" + type = "tags" + visible = "advanced" From 14edb35381953858342763cbc55aea3c6110272a Mon Sep 17 00:00:00 2001 From: Galettofraise Date: Fri, 25 Feb 2022 12:52:27 +0100 Subject: [PATCH 7/9] [fix] fix the panel --- config_panel.toml | 2 +- scripts/install | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/config_panel.toml b/config_panel.toml index d5904a3..bac863d 100644 --- a/config_panel.toml +++ b/config_panel.toml @@ -15,7 +15,7 @@ name = "shared directory" ask = "Advanced parameter" type = "boolean" -[main.main.readonly] +[main.main.readonly_dir] ask = "List of read only directory" type = "tags" visible = "advanced" diff --git a/scripts/install b/scripts/install index eafdab8..5e9731c 100755 --- a/scripts/install +++ b/scripts/install @@ -27,6 +27,16 @@ app=$YNH_APP_INSTANCE_NAME #================================================= ynh_script_progression --message="Storing installation settings..." --time --weight=1 +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= +ynh_script_progression --message="Storing installation settings..." --time --weight=1 + +ynh_app_setting_set --app=$app --key=directory --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='' + #================================================= # FIND AND OPEN A PORT #================================================= From 673345749ac19d05b8d97756f7154206fb78e303 Mon Sep 17 00:00:00 2001 From: Galettofraise Date: Fri, 25 Feb 2022 14:04:21 +0100 Subject: [PATCH 8/9] [fix] upgrade the smb config for directories questions --- conf/global-smb.conf | 27 +++++++++++++ conf/shared-smb.conf | 13 +++++++ config_panel.toml | 11 ++++-- scripts/config | 90 +++++++++++++++++--------------------------- scripts/install | 6 ++- 5 files changed, 87 insertions(+), 60 deletions(-) create mode 100644 conf/global-smb.conf create mode 100644 conf/shared-smb.conf diff --git a/conf/global-smb.conf b/conf/global-smb.conf new file mode 100644 index 0000000..1f3ef6f --- /dev/null +++ b/conf/global-smb.conf @@ -0,0 +1,27 @@ +[global] + + log file = /var/log/samba/log.%m + max log size = 1000 + logging = file + panic action = /usr/share/samba/panic-action %d + + server role = standalone server + + obey pam restrictions = yes + unix password sync = yes + passwd program = /usr/bin/passwd %u + passwd chat = *Enter\snew\s*\spassword:* %n\n *Retype\snew\s*\spassword:* %n\n *password\supdated\ssuccessfully* . + pam password change = yes + map to guest = bad user + + usershare allow guests = yes + browseable = yes + + +[homes] + comment = Home Directories + browseable = no + read only = no + create mask = 0700 + directory mask = 0700 + valid users = %S diff --git a/conf/shared-smb.conf b/conf/shared-smb.conf new file mode 100644 index 0000000..3c30c36 --- /dev/null +++ b/conf/shared-smb.conf @@ -0,0 +1,13 @@ +[share] + comment = share (D) + read only = no + path = /home/yunohost.app/samba/share + guest ok = no + browsable = yes + valid users = @samba.share + create mask = 0660 + directory mask = 770 + vfs objects = dfs_samba4 acl_xattr recycle + recycle:repository = .recycle + recycle:keeptree = yes + recycle:versions = yes diff --git a/config_panel.toml b/config_panel.toml index bac863d..71ade83 100644 --- a/config_panel.toml +++ b/config_panel.toml @@ -2,25 +2,28 @@ version = "1.0" [main] name = "shared directory" +services = ["samba"] [main.main] name = "" optional = true -[main.main.directory] - ask = "List of share directory" +[main.main.directories] + ask = "List of shared directories" type = "tags" + pattern.regexp = '^[a-z0-9_]+$' + pattern.error = "Directories names can caontain lowercase alphabetic characters, numbers and underscore." [main.main.advanced] ask = "Advanced parameter" type = "boolean" [main.main.readonly_dir] - ask = "List of read only directory" + ask = "List of readonly directories" type = "tags" visible = "advanced" [main.main.unbrowseable] - ask = "List of invisible directory" + ask = "List of invisible directories" type = "tags" visible = "advanced" diff --git a/scripts/config b/scripts/config index b9e79f8..20d20c4 100644 --- a/scripts/config +++ b/scripts/config @@ -18,82 +18,62 @@ source /usr/share/yunohost/helpers ynh_abort_if_errors -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -final_path=$(ynh_app_setting_get $app final_path) - #================================================= # SPECIFIC GETTERS FOR TOML SHORT KEY #================================================= -get__amount() { - # Here we can imagine to have an API call to stripe to know the amount of donation during a month - local amount = 200 - - # It's possible to change some properties of the question by overriding it: - if [ $amount -gt 100 ] - then - cat << EOF -style: success -value: $amount -ask: - en: A lot of donation this month: **$amount €** -EOF - else - cat << EOF -style: danger -value: $amount -ask: - en: Not so much donation this month: $amount € -EOF - fi -} - -get__prices() { - local prices = "$(grep "DONATION\['" "$final_path/settings.py" | sed -r "s@^DONATION\['([^']*)'\]\['([^']*)'\] = '([^']*)'@\1/\2/\3@g" | sed -z 's/\n/,/g;s/,$/\n/')" - if [ "$prices" == "," ]; - then - # Return YNH_NULL if you prefer to not return a value at all. - echo YNH_NULL - else - echo $prices - fi -} - - #================================================= # SPECIFIC VALIDATORS FOR TOML SHORT KEYS #================================================= -validate__publishable_key() { - - # We can imagine here we test if the key is really a publisheable key - (is_secret_key $publishable_key) && - echo 'This key seems to be a secret key' -} #================================================= # SPECIFIC SETTERS FOR TOML SHORT KEYS #================================================= -set__prices() { +set__directories() { + + mkdir -p /etc/samba/smb.conf.d #--------------------------------------------- # IMPORTANT: setter are trigger only if a change is detected #--------------------------------------------- - for price in $(echo $prices | sed "s/,/ /"); do - frequency=$(echo $price | cut -d/ -f1) - currency=$(echo $price | cut -d/ -f2) - price_id=$(echo $price | cut -d/ -f3) - sed "d/DONATION\['$frequency'\]\['$currency'\]" "$final_path/settings.py" + for directory in $(echo $directories | sed "s/,/ /"); do + # Create permission if needed + if ! ynh_permission_exists --permission=samba.${directory} ; then + ynh_permission_create --permission="samba.${directory}" --allowed=all_users --show_tile=false + fi + + # Add the configuration in /etc/samba/smb.conf if needed + cat > /etc/samba/smb.conf.d/${directory}.conf <> "$final_path/settings.py" done + + cat > /etc/samba/smb.conf <> /etc/samba/smb.conf #--------------------------------------------- # IMPORTANT: to be able to upgrade properly, you have to saved the value in settings too #--------------------------------------------- - ynh_app_setting_set $app prices $prices + ynh_app_setting_set $app directories $directories } #================================================= diff --git a/scripts/install b/scripts/install index 5e9731c..b7066de 100755 --- a/scripts/install +++ b/scripts/install @@ -71,7 +71,11 @@ setfacl -R -m g:all_users:rwx,d:g:all_users:rwx $datadir/share #================================================= ynh_script_progression --message="Adding a configuration file..." --time --weight=1 -ynh_add_config --template="smb.conf" --destination="/etc/samba/smb.conf" +mkdir -p /etc/samba/smb.conf.d +ynh_add_config --template="global-smb.conf" --destination="/etc/samba/smb.conf.d/0-global.conf" +ynh_add_config --template="shared-smb.conf" --destination="/etc/samba/smb.conf.d/shared.conf" + +cat /etc/samba/smb.conf.d/*.conf > /etc/samba/smb.conf #================================================ # INTEGRATE SERVICE IN YUNOHOST From 6166065091b31fa051b00c96fbd6c21ebea6de76 Mon Sep 17 00:00:00 2001 From: Galettofraise Date: Fri, 25 Feb 2022 17:05:34 +0100 Subject: [PATCH 9/9] [fix] add repository --- config_panel.toml.example | 295 -------------------------------------- scripts/config | 38 +++-- scripts/install | 2 +- 3 files changed, 26 insertions(+), 309 deletions(-) delete mode 100644 config_panel.toml.example diff --git a/config_panel.toml.example b/config_panel.toml.example deleted file mode 100644 index c6bccd8..0000000 --- a/config_panel.toml.example +++ /dev/null @@ -1,295 +0,0 @@ - -## Config panel are available from webadmin > Apps > YOUR_APP > Config Panel Button -## Those panels let user configure some params on their apps using a friendly interface, -## and remove the need to manually edit files from the command line. - -## From a packager perspective, this .toml is coupled to the scripts/config script, -## which may be used to define custom getters/setters. However, most use cases -## should be covered automagically by the core, thus it may not be necessary -## to define a scripts/config at all! - -## ----------------------------------------------------------------------------- -## IMPORTANT: In accordance with YunoHost's spirit, please keep things simple and -## do not overwhelm the admin with tons of misunderstandable or advanced settings. -## ----------------------------------------------------------------------------- - -## The top level describe the entire config panels screen. - -## The version is a required property. -## Here a small reminder to associate config panel version with YunoHost version -## | Config | YNH | Config panel small change log | -## | ------ | --- | ------------------------------------------------------- | -## | 0.1 | 3.x | 0.1 config script not compatible with YNH >= 4.3 | -## | 1.0 | 4.3.x | The new config panel system with 'bind' property | -version = "1.0" - -## (optional) i18n property let you internationalize questions, however this feature -## is only available in core configuration panel (like yunohost domain config). -## So in app config panel this key is ignored for now, but you can internationalize -## by using a lang dictionary (see property name bellow) -# i18n = "prefix_translation_key" - -################################################################################ -#### ABOUT PANELS -################################################################################ - -## The next level describes web admin panels -## You have to choose an ID for each panel, in this example the ID is "main" -## Keep in mind this ID will be used in CLI to refer to your question, so choose -## something short and meaningfull. -## In the webadmin, each panel corresponds to a distinct tab / form -[main] - -## Define the label for your panel -## Internationalization works similarly to the 'description' and 'ask' questions in the manifest -# name.en = "Main configuration" -# name.fr = "Configuration principale" - -## (optional) If you need to trigger a service reload-or-restart after the user -## change a question in this panel, you can add your service in the list. -services = ["__APP__"] -# or services = ["nginx", "__APP__"] to also reload-or-restart nginx - -## (optional) This help properties is a short help displayed on the same line -## than the panel title but not displayed in the tab. -# help = "" - - ############################################################################ - #### ABOUT SECTIONS - ############################################################################ - - ## A panel is composed of one or several sections. - ## - ## Sections are meant to group questions together when they correspond to - ## a same subtopic. This impacts the rendering in terms of CLI prompts - ## and HTML forms - ## - ## You should choose an ID for your section, and prefix it with the panel ID - ## (Be sure to not make a typo in the panel ID, which would implicitly create - ## an other entire panel) - ## - ## We use the context of pepettes_ynh as an example, - ## which is a simple donation form app written in python, - ## and for which the admin will want to edit the configuration - [main.customization] - - ## (optional) Defining a proper title for sections is not mandatory - ## and depends on the exact rendering you're aiming for the CLI / webadmin - name = "" - - ## (optional) This help properties is a short help displayed on the same line - ## than the section title, meant to provide additional details - # help = "" - - ## (optional) As for panel, you can specify to trigger a service - ## reload-or-restart after the user change a question in this section. - ## This property is added to the panel property, it doesn't deactivate it. - ## So no need to replicate, the service list from panel services property. - # services = [] - - ## (optional) By default all questions are optionals, but you can specify a - ## default behaviour for question in the section - optional = false - - ## (optional) It's also possible with the 'visible' property to only - ## display the section depending on the user's answers to previous questions. - ## - ## Be careful that the 'visible' property should only refer to **previous** questions - ## Hence, it should not make sense to have a "visible" property on the very first section. - ## - ## Also, keep in mind that this feature only works in the webadmin and not in CLI - ## (therefore a user could be prompted in CLI for a question that may not be relevant) - # visible = true - - ######################################################################## - #### ABOUT QUESTIONS - ######################################################################## - - ## A section is compound of one or several questions. - - ## --------------------------------------------------------------------- - ## IMPORTANT: as for panel and section you have to choose an ID, but this - ## one should be unique in all this document, even if the question is in - ## an other panel. - ## --------------------------------------------------------------------- - - ## You can use same questions types and properties than in manifest.yml - ## install part. However, in YNH 4.3, a lot of change has been made to - ## extend availables questions types list. - ## See: TODO DOC LINK - - [main.customization.project_name] - - ## (required) The ask property is equivalent to the ask property in - ## the manifest. However, in config panels, questions are displayed on the - ## left side and therefore have less space to be rendered. Therefore, - ## it is better to use a short question, and use the "help" property to - ## provide additional details if necessary. - ask.en = "Name of the project" - - ## (required) The type property indicates how the question should be - ## displayed, validated and managed. Some types have specific properties. - ## - ## Types available: string, boolean, number, range, text, password, path - ## email, url, date, time, color, select, domain, user, tags, file. - ## - ## For a complete list with specific properties, see: TODO DOC LINK - type = "string" - - ######################################################################## - #### ABOUT THE BIND PROPERTY - ######################################################################## - - ## (recommended) 'bind' property is a powerful feature that let you - ## configure how and where the data will be read, validated and written. - - ## By default, 'bind property is in "settings" mode, it means it will - ## **only** read and write the value in application settings file. - ## bind = "settings" - - ## However, settings usually correspond to key/values in actual app configurations - ## Hence, a more useful mode is to have bind = ":FILENAME". In that case, YunoHost - ## will automagically find a line with "KEY=VALUE" in FILENAME - ## (with the adequate separator between KEY and VALUE) - ## - ## YunoHost will then use this value for the read/get operation. - ## During write/set operations, YunoHost will overwrite the value - ## in **both** FILENAME and in the app's settings.yml - - ## Configuration file format supported: yaml, toml, json, ini, env, php, - ## python. The feature probably works with others formats, but should be tested carefully. - - ## Note that this feature only works with relatively simple cases - ## such as `KEY: VALUE`, but won't properly work with - ## complex data structures like multilin array/lists or dictionnaries. - ## It also doesn't work with XML format, custom config function call, php define(), ... - - ## More info on TODO - # bind = ":/var/www/__APP__/settings.py" - - - ## By default, bind = ":FILENAME" will use the question ID as KEY - ## ... but the question ID may sometime not be the exact KEY name in the configuration file. - ## - ## In particular, in pepettes, the python variable is 'name' and not 'project_name' - ## (c.f. https://github.com/YunoHost-Apps/pepettes_ynh/blob/5cc2d3ffd6529cc7356ff93af92dbb6785c3ab9a/conf/settings.py##L11 ) - ## - ## In that case, the key name can be specified before the column ':' - - bind = "name:/var/www/__APP__/settings.py" - - ## --------------------------------------------------------------------- - ## IMPORTANT: other 'bind' mode exists: - ## - ## bind = "FILENAME" (with no column character before FILENAME) - ## may be used to bind to the **entire file content** (instead of a single KEY/VALUE) - ## This could be used to expose an entire configuration file, or binary files such as images - ## For example: - ## bind = "/var/www/__APP__/img/logo.png" - ## - ## bind = "null" can be used to disable reading / writing in settings. - ## This creates sort of a "virtual" or "ephemeral" question which is not related to any actual setting - ## In this mode, you are expected to define custom getter/setters/validators in scripts/config: - ## - ## getter: get__QUESTIONID() - ## setter: set__QUESTIONID() - ## validator: validate__QUESTIONID() - ## - ## You can also specify a common getter / setter / validator, with the - ## function 'bind' mode, for example here it will try to run - ## get__array_settings() first. - # bind = "array_settings()" - ## --------------------------------------------------------------------- - - ## --------------------------------------------------------------------- - ## IMPORTANT: with the exception of bind=null questions, - ## question IDs should almost **always** correspond to an app setting - ## initialized / reused during install/upgrade. - ## Not doing so may result in inconsistencies between the config panel mechanism - ## and the use of ynh_add_config - ## --------------------------------------------------------------------- - - ######################################################################## - #### OTHER GENERIC PROPERTY FOR QUESTIONS - ######################################################################## - - ## (optional) An help text for the question - help = "Fill the name of the project which will received donation" - - ## (optional) An example display as placeholder in web form - # example = "YunoHost" - - ## (optional) set to true in order to redact the value in operation logs - # redact = false - - ## (optional) A validation pattern - ## --------------------------------------------------------------------- - ## IMPORTANT: your pattern should be between simple quote, not double. - ## --------------------------------------------------------------------- - pattern.regexp = '^\w{3,30}$' - pattern.error = "The name should be at least 3 chars and less than 30 chars. Alphanumeric chars are accepted" - - ## Note: visible and optional properties are also available for questions - - - [main.customization.contact_url] - ask = "Contact url" - type = "url" - example = "mailto: contact@example.org" - help = "mailto: accepted" - pattern.regexp = '^mailto:[^@]+@[^@]+|https://$' - pattern.error = "Should be https or mailto:" - bind = ":/var/www/__APP__/settings.py" - - [main.customization.logo] - ask = "Logo" - type = "file" - accept = ".png" - help = "Fill with an already resized logo" - bind = "__FINALPATH__/img/logo.png" - - [main.customization.favicon] - ask = "Favicon" - type = "file" - accept = ".png" - help = "Fill with an already sized favicon" - bind = "__FINALPATH__/img/favicon.png" - - - [main.stripe] - name = "Stripe general info" - optional = false - - # The next alert is overwrited with a getter from the config script - [main.stripe.amount] - ask = "Donation in the month : XX € - type = "alert" - style = "success" - - [main.stripe.publishable_key] - ask = "Publishable key" - type = "string" - redact = true - help = "Indicate here the stripe publishable key" - bind = ":/var/www/__APP__/settings.py" - - [main.stripe.secret_key] - ask = "Secret key" - type = "string" - redact = true - help = "Indicate here the stripe secret key" - bind = ":/var/www/__APP__/settings.py" - - [main.stripe.prices] - ask = "Prices ID" - type = "tags" - help = """\ - Indicates here the prices ID of donation products you created in stripe interfaces. \ - Go on [Stripe products](https://dashboard.stripe.com/products) to create those donation products. \ - Fill it tag with 'FREQUENCY/CURRENCY/PRICE_ID' \ - FREQUENCY: 'one_time' or 'recuring' \ - CURRENCY: 'EUR' or 'USD' \ - PRICE_ID: ID from stripe interfaces starting with 'price_' \ - """ - pattern.regexp = '^(one_time|recuring)/(EUR|USD)/price_.*$' - pattern.error = "Please respect the format describe in help text for each price ID" diff --git a/scripts/config b/scripts/config index 20d20c4..d91a7be 100644 --- a/scripts/config +++ b/scripts/config @@ -18,6 +18,8 @@ source /usr/share/yunohost/helpers ynh_abort_if_errors +datadir=$(ynh_app_setting_get --app=$app --key=datadir) + #================================================= # SPECIFIC GETTERS FOR TOML SHORT KEY #================================================= @@ -36,28 +38,38 @@ set__directories() { #--------------------------------------------- # IMPORTANT: setter are trigger only if a change is detected #--------------------------------------------- - for directory in $(echo $directories | sed "s/,/ /"); do - # Create permission if needed - if ! ynh_permission_exists --permission=samba.${directory} ; then - ynh_permission_create --permission="samba.${directory}" --allowed=all_users --show_tile=false + for directory in $(echo $directories | sed "s/,/ /g"); do + + # Create yunohost permission + if ! ynh_permission_exists --permission=$directory ; then + ynh_permission_create --permission="$directory" --allowed=all_users --show_tile=false fi + + # Create the directory + mkdir -p $datadir/$directory + + chmod 750 "$datadir/$directory" + chmod -R o-rwx "$datadir/$directory" + chown -R root:root "$datadir/$directory" + setfacl -R -m g:samba.$directory:rwx,d:g:samba.$directory:rwx $datadir/$directory + # Add the configuration in /etc/samba/smb.conf if needed - cat > /etc/samba/smb.conf.d/${directory}.conf < /etc/samba/smb.conf.d/$directory.conf <> /etc/samba/smb.conf - #--------------------------------------------- - # IMPORTANT: to be able to upgrade properly, you have to saved the value in settings too - #--------------------------------------------- +#--------------------------------------------- +# IMPORTANT: to be able to upgrade properly, you have to saved the value in settings too +#--------------------------------------------- ynh_app_setting_set $app directories $directories } diff --git a/scripts/install b/scripts/install index b7066de..1d1557a 100755 --- a/scripts/install +++ b/scripts/install @@ -32,7 +32,7 @@ ynh_script_progression --message="Storing installation settings..." --time --wei #================================================= ynh_script_progression --message="Storing installation settings..." --time --weight=1 -ynh_app_setting_set --app=$app --key=directory --value=shared +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=''