Merge pull request #2 from YunoHost-Apps/testing

Testing
2024-09-03 19:46:16 +02:00 · 2021-06-05 16:46:35 +02:00 · 2021-06-05 16:46:35 +02:00 · f3d11d19f5
commit f3d11d19f5
parent e3e5ba12ac cbe9c49e18
10 changed files with 74 additions and 64 deletions
--- a/README.md
+++ b/README.md
@ -19,7 +19,7 @@ Web interface for voice chat software (VoIP)

 **Shipped version:** 1.3.0~ynh1

-
+**Demo:** https://web.mumble.framatalk.org/

 ## Screenshots

@ -27,12 +27,18 @@ Web interface for voice chat software (VoIP)

 ## Disclaimers / important information

-#### Setup
+## Setup
+
+Various configuration options are available for Mumble web on this configuration file `/var/www/mumble-web/dist/config.local.js`
+
+### Documentation
+
+- Framasoft documentation: https://docs.framasoft.org/fr/jitsimeet/mumble.html

 ## Documentation and resources

 * Official app website: https://mumble.info
-* Official admin documentation: https://github.com/Johni0702/mumble-web/
+* Official admin documentation: https://docs.framasoft.org/fr/jitsimeet/mumble.html
 * Upstream app code repository: https://github.com/Johni0702/mumble-web/
 * YunoHost documentation for this app: https://yunohost.org/app_mumble-web
 * Report a bug: https://github.com/YunoHost-Apps/mumble-web_ynh/issues
--- a/README_fr.md
+++ b/README_fr.md
@ -15,7 +15,7 @@ Interface web interface pour voix sur IP (VoIP)

 **Version incluse :** 1.3.0~ynh1

-
+**Démo :** https://web.mumble.framatalk.org/

 ## Captures d'écran

@ -25,10 +25,16 @@ Interface web interface pour voix sur IP (VoIP)

 ## Configuration

+Diverses options de configuration sont disponibles pour Mumble web sur ce fichier de configuration `/var/www/mumble-web/dist/config.local.js` 
+
+## Documentation
+
+- documentation Framasoft : https://docs.framasoft.org/fr/jitsimeet/mumble.html
+
 ## Documentations et ressources

 * Site officiel de l'app : https://mumble.info
-* Documentation officielle de l'admin : https://github.com/Johni0702/mumble-web/
+* Documentation officielle de l'admin : https://docs.framasoft.org/fr/jitsimeet/mumble.html
 * Dépôt de code officiel de l'app : https://github.com/Johni0702/mumble-web/
 * Documentation YunoHost pour cette app : https://yunohost.org/app_mumble-web
 * Signaler un bug : https://github.com/YunoHost-Apps/mumble-web_ynh/issues
--- a/conf/config.local.js
+++ b/conf/config.local.js
@ -10,34 +10,34 @@ let config = window.mumbleWebConfig // eslint-disable-line no-unused-vars


 // Which fields to show on the Connect to Server dialog
-config.connectDialog.address : 'false'
-config.connectDialog.port : 'false'
-config.connectDialog.token : 'false'
-// config.connectDialog.username : 'true'
-// config.connectDialog.password : 'true'
-// config.connectDialog.channelName : 'false'
+config.connectDialog.address = false
+config.connectDialog.port = false
+config.connectDialog.token = true
+// config.connectDialog.username = true
+config.connectDialog.password = false
+// config.connectDialog.channelName = false

 // Default values for user settings
 // You can see your current value by typing `localStorage.getItem('mumble.$setting')` in the web console.
-// config.settings.voiceMode : 'vad' // one of 'cont' (Continuous), 'ptt' (Push-to-Talk), 'vad' (Voice Activity Detection)
-// config.settings.pttKey : 'ctrl + shift'
-// config.settings.vadLevel : '0.3'
-// config.settings.toolbarVertical : 'false'
-// config.settings.showAvatars : 'always' // one of 'always', 'own_channel', 'linked_channel', 'minimal_only', 'never'
-// config.settings.userCountInChannelName : 'false'
-// config.settings.audioBitrate : '40000' // bits per second
-// config.settings.samplesPerPacket : '960'
+// config.settings.voiceMode = 'vad' // one of 'cont' (Continuous), 'ptt' (Push-to-Talk), 'vad' (Voice Activity Detection)
+// config.settings.pttKey = 'ctrl + shift'
+// config.settings.vadLevel = '0.3'
+// config.settings.toolbarVertical = false
+// config.settings.showAvatars = 'always' // one of 'always', 'own_channel', 'linked_channel', 'minimal_only', 'never'
+// config.settings.userCountInChannelName = false
+// config.settings.audioBitrate = '40000' // bits per second
+// config.settings.samplesPerPacket = '960'

 // Default values (can be changed by passing a query parameter of the same name)
 // Connect Dialog
-// config.defaults.address': window.location.hostname,
-// config.defaults.port : '443'
-// config.defaults.token : ''
-// config.defaults.username': ''
-// config.defaults.password': '',
-// config.defaults.joinDialog : 'false' // replace whole dialog with single "Join Conference" button
-// config.defaults.matrix : 'false' // enable Matrix Widget support (mostly auto-detected; implies 'joinDialog')
-// config.defaults.avatarurl : '' // download and set the user's Mumble avatar to the image at this URL
+// config.defaults.address = 'window.location.hostname'
+// config.defaults.port = '443'
+// config.defaults.token = ''
+// config.defaults.username = ''
+// config.defaults.password = ''
+// config.defaults.joinDialog = false // replace whole dialog with single "Join Conference" button
+// config.defaults.matrix = false // enable Matrix Widget support (mostly auto-detected; implies 'joinDialog')
+// config.defaults.avatarurl = '' // download and set the user's Mumble avatar to the image at this URL

 // General
-config.defaults.theme : 'MetroMumbleDark'
+config.defaults.theme = 'MetroMumbleDark'
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
@ -1 +1,7 @@
-#### Setup
+## Setup
+
+Various configuration options are available for Mumble web on this configuration file `/var/www/mumble-web/dist/config.local.js`
+
+### Documentation
+
+- Framasoft documentation: https://docs.framasoft.org/fr/jitsimeet/mumble.html
--- a/doc/DISCLAIMER_fr.md
+++ b/doc/DISCLAIMER_fr.md
@ -1 +1,7 @@
 ## Configuration
+
+Diverses options de configuration sont disponibles pour Mumble web sur ce fichier de configuration `/var/www/mumble-web/dist/config.local.js` 
+
+## Documentation
+
+- documentation Framasoft : https://docs.framasoft.org/fr/jitsimeet/mumble.html
--- a/manifest.json
+++ b/manifest.json
@ -11,7 +11,8 @@
    "upstream": {
        "license": "BSD-3-Clause",
        "website": "https://mumble.info",
-        "admindoc": "https://github.com/Johni0702/mumble-web/",
+        "demo": "https://web.mumble.framatalk.org/",
+        "admindoc": "https://docs.framasoft.org/fr/jitsimeet/mumble.html",
        "code": "https://github.com/Johni0702/mumble-web/"
    },
    "license": "BSD-3-Clause",
@ -31,7 +32,7 @@
    	   {
                "name": "domain",
                "type": "domain",
-    	        "example": "domain.org"
+    	        "example": "example.com"
    	    },
            {
                "name": "is_public",
--- a/scripts/install
+++ b/scripts/install
@ -78,7 +78,7 @@ ynh_system_user_create --username=$app --home_dir="$final_path"
 #=================================================
 # INSTALL Mumble-web
 #=================================================
-ynh_script_progression --message="Installing Mumble Web..." --weight=4
+ynh_script_progression --message="Setting up source files..." --weight=1

 ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
@ -91,27 +91,17 @@ chown -R $app:www-data "$final_path"
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Configuring NGINX web server..." --weight=1
+ynh_script_progression --message="Configuring NGINX web server..." --weight=4

 # Create a dedicated NGINX config
 ynh_add_nginx_config

-#=================================================
-# ADD A CONFIGURATION
-#=================================================
-# ynh_script_progression --message="Adding a configuration file..." --weight=1
-
-# ynh_add_config --template="../conf/config.local.js" --destination="$final_path/dist/config.local.js"
-
-# chmod 400 "$final_path/dist/config.local.js"
-# chown $app "$final_path/dist/config.local.js"
-
 #=================================================
 # SPECIFIC SETUP
 #=================================================
 # mumble server conf.ini
 #=================================================
-ynh_script_progression --message="Configuring Mumble Web..." --weight=1
+ynh_script_progression --message="Configuring Mumble web client..." --weight=1

 ynh_use_nodejs
 (
@ -122,6 +112,16 @@ ynh_use_nodejs
 	ls -lah
 )

+#=================================================
+# ADD A CONFIGURATION
+#=================================================
+ynh_script_progression --message="Adding a configuration file..." --weight=1
+
+ynh_add_config --template="../conf/config.local.js" --destination="$final_path/dist/config.local.js"
+
+chmod 400 "$final_path/dist/config.local.js"
+chown $app "$final_path/dist/config.local.js"
+
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@ -136,7 +136,7 @@ ynh_add_systemd_config
 #=================================================
 ynh_script_progression --message="Integrating service in YunoHost..." --weight=1

-yunohost service add $app --description="Mumble web interface" --log="/var/log/$app/$app.log"
+yunohost service add $app --description="Mumble web client" --log="/var/log/$app/$app.log"

 #=================================================
 # START SYSTEMD SERVICE
--- a/scripts/remove
+++ b/scripts/remove
@ -68,14 +68,6 @@ ynh_script_progression --message="Removing NGINX web server configuration..." --
 # Remove the dedicated nginx config
 ynh_remove_nginx_config

-#=================================================
-# SPECIFIC REMOVE
-#=================================================
-# REMOVE OTHER FILES
-#=================================================
-
-ynh_secure_remove "/var/log/$app"
-
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
--- a/scripts/restore
+++ b/scripts/restore
@ -89,7 +89,7 @@ systemctl enable $app.service --quiet
 ynh_script_progression --message="Integrating service in YunoHost..." --weight=1

 # Add Mumble as a YunoHost service
-yunohost service add $app --description="Mumble web interface" --log="/var/log/$app/$app.log"
+yunohost service add $app --description="Mumble web client" --log="/var/log/$app/$app.log"

 #=================================================
 # START SYSTEMD SERVICE
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -57,14 +57,7 @@ ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
 # If final_path doesn't exist, create it
 if [ -z "$final_path" ]; then
 	final_path=/var/www/$app
-	ynh_app_setting_set "$app" final_path "$final_path"
-fi
-
-# Cleaning legacy permissions
-if ynh_legacy_permissions_exists; then
-	ynh_legacy_permissions_delete_all
-
-	ynh_app_setting_delete --app=$app --key=is_public
+	ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 fi

 #=================================================
@ -84,7 +77,7 @@ then
 	ynh_script_progression --message="Upgrading source files..." --weight=1

 	# Download, check integrity, uncompress and patch the source from app.src
-	ynh_setup_source --dest_dir="$final_path" #--keep="$final_path/dist/config.local.js"
+	ynh_setup_source --dest_dir="$final_path" --keep="$final_path/dist/config.local.js"
 fi

 chmod 750 "$final_path"
@ -123,7 +116,7 @@ ynh_add_systemd_config
 #=================================================

 # Add Mumble as a YunoHost service
-yunohost service add $app --description="Mumble web interface" --log="/var/log/$app/$app.log"
+yunohost service add $app --description="Mumble web client" --log="/var/log/$app/$app.log"

 #=================================================
 # START SYSTEMD SERVICE