Merge pull request #18 from YunoHost-Apps/version-2

Version 2

README.md

@@ -16,10 +16,9 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 
 ## Overview
 
-Cockpit is a web-based graphical interface for servers, intended for everyone.
+Cockpit is an interactive server admin interface. It is easy to use and very lightweight. Cockpit interacts directly with the operating system from a real Linux session in a browser.
 
-
+**Shipped version:** 239~ynh1
-**Shipped version:** 188~ynh2
 
 ## Screenshots
 

README_fr.md

@@ -16,10 +16,9 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
 
 ## Vue d’ensemble
 
-Cockpit is a web-based graphical interface for servers, intended for everyone.
+Cockpit est une interface d'administration de serveur interactive. Il est facile à utiliser et très léger. Cockpit interagit directement avec le système d'exploitation à partir d'une vraie session Linux dans un navigateur.
 
-
+**Version incluse :** 239~ynh1
-**Version incluse :** 188~ynh2
 
 ## Captures d’écran
 

check_process

@@ -1,21 +0,0 @@
-;; Test complet
-	; Manifest
-		domain="domain.tld"
-		path="/path"
-	; Checks
-		pkg_linter=1
-		setup_sub_dir=1
-		setup_root=1
-		setup_nourl=0
-		setup_private=0
-		setup_public=0
-		upgrade=1
-		# 188~ynh1
-		upgrade=1	from_commit=d94f20300b9296f5dbe879d025a5f481ecb15011
-		backup_restore=1
-		multi_instance=0
-		port_already_use=0
-		change_url=0
-;;; Options
-Email=
-Notification=none

doc/DESCRIPTION.md

@@ -1 +1 @@
-Cockpit is a web-based graphical interface for servers, intended for everyone.
+Cockpit is an interactive server admin interface. It is easy to use and very lightweight. Cockpit interacts directly with the operating system from a real Linux session in a browser.

doc/DESCRIPTION_fr.md

@@ -0,0 +1 @@
+Cockpit est une interface d'administration de serveur interactive. Il est facile à utiliser et très léger. Cockpit interagit directement avec le système d'exploitation à partir d'une vraie session Linux dans un navigateur.

manifest.json

@@ -1,48 +0,0 @@
-{
-    "name": "Cockpit",
-    "id": "cockpit",
-    "packaging_format": 1,
-    "description": {
-        "en": "Sysadmin login session in a web browser",
-        "fr": "Session de connexion sysadmin dans un navigateur Web"
-    },
-    "version": "188~ynh2",
-    "url": "https://cockpit-project.org/",
-    "upstream": {
-        "license": "LGPL-2.1-only",
-        "website": "https://cockpit-project.org/",
-        "admindoc": "https://cockpit-project.org/documentation.html",
-        "code": "https://github.com/cockpit-project/cockpit",
-        "cpe": "cpe:2.3:a:agentejo:cockpit"
-    },
-    "license": "LGPL-2.1-only",
-    "maintainer": {
-        "name": "",
-        "email": ""
-    },
-    "requirements": {
-        "yunohost": ">= 11.2"
-    },
-    "multi_instance": false,
-    "services": [
-        "nginx"
-    ],
-    "arguments": {
-        "install": [
-            {
-                "name": "domain",
-                "type": "domain"
-            },
-            {
-                "name": "path",
-                "type": "path",
-                "help": {
-                    "en": "/cockpit/ and /cockpit+ are reserved and should not be used.",
-                    "fr": "/cockpit/ et /cockpit+ sont réservés et ne doivent pas être utilisés."
-                },
-                "example": "/monitor",
-                "default": "/monitor"
-            }
-        ]
-    }
-}

manifest.toml

@@ -0,0 +1,51 @@
+packaging_format = 2
+
+id = "cockpit"
+name = "Cockpit"
+description.en = "Sysadmin login session in a web browser"
+description.fr = "Session de connexion sysadmin dans un navigateur Web"
+
+version = "239~ynh1"
+
+maintainers = []
+
+[upstream]
+license = "LGPL-2.1-only"
+website = "https://cockpit-project.org/"
+admindoc = "https://cockpit-project.org/documentation.html"
+code = "https://github.com/cockpit-project/cockpit"
+
+[integration]
+yunohost = ">= 11.2"
+architectures = "all"
+multi_instance = false
+ldap = false
+sso = false
+disk = "50M"
+ram.build = "50M"
+ram.runtime = "50M"
+
+[install]
+    [install.domain]
+    type = "domain"
+
+    [install.path]
+    help.en = "/cockpit/ and /cockpit+ are reserved and should not be used."
+    help.fr = "/cockpit/ et /cockpit+ sont réservés et ne doivent pas être utilisés."
+    type = "path"
+    default = "/monitor"
+
+[resources]
+    [resources.system_user]
+
+    [resources.install_dir]
+
+    [resources.permissions]
+    main.url = "/"
+
+    [resources.ports]
+    main.default = 9090
+
+    [resources.apt]
+    packages = "cockpit"
+    

scripts/_common.sh

@@ -4,9 +4,6 @@
 # COMMON VARIABLES
 #=================================================
 
-# dependencies used by the app (must be on a single line)
-pkg_dependencies="cockpit"
-
 #=================================================
 # PERSONAL HELPERS
 #=================================================

scripts/backup

@@ -10,26 +10,6 @@
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-ynh_clean_setup () {
-	true
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_print_info --message="Loading installation settings..."
-
-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)
-
 #=================================================
 # DECLARE DATA AND CONF FILES TO BACKUP
 #=================================================
@@ -41,8 +21,6 @@ ynh_print_info --message="Declaring files to be backed up..."
 
 ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
-#=================================================
-# SPECIFIC BACKUP
 #=================================================
 # BACKUP VARIOUS FILES
 #=================================================

scripts/change_url

@@ -9,64 +9,6 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# RETRIEVE ARGUMENTS
-#=================================================
-
-old_domain=$YNH_APP_OLD_DOMAIN
-old_path=$YNH_APP_OLD_PATH
-
-new_domain=$YNH_APP_NEW_DOMAIN
-new_path=$YNH_APP_NEW_PATH
-
-app=$YNH_APP_INSTANCE_NAME
-
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
-
-# Needed for helper "ynh_add_nginx_config"
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-
-# Add settings here as needed by your application
-#db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-#db_user=$db_name
-#db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
-
-#=================================================
-# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
-#=================================================
-ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1
-
-# Backup the current version of the app
-ynh_backup_before_upgrade
-ynh_clean_setup () {
-	# Remove the new domain config file, the remove script won't do it as it doesn't know yet its location.
-	ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
-
-	# Restore it if the upgrade fails
-	ynh_restore_upgradebackup
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# CHECK WHICH PARTS SHOULD BE CHANGED
-#=================================================
-
-change_domain=0
-if [ "$old_domain" != "$new_domain" ]
-then
-	change_domain=1
-fi
-
-change_path=0
-if [ "$old_path" != "$new_path" ]
-then
-	change_path=1
-fi
-
 #=================================================
 # STANDARD MODIFICATIONS
 #=================================================
@@ -81,29 +23,7 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
 #=================================================
 ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
 
-nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
+ynh_change_url_nginx_config
-
-# Change the path in the NGINX config file
-if [ $change_path -eq 1 ]
-then
-	# Make a backup of the original NGINX config file if modified
-	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
-	# Set global variables for NGINX helper
-	domain="$old_domain"
-	path_url="$new_path"
-	# Create a dedicated NGINX config
-	ynh_add_nginx_config
-fi
-
-# Change the domain for NGINX
-if [ $change_domain -eq 1 ]
-then
-	# Delete file checksum for the old conf file location
-	ynh_delete_file_checksum --file="$nginx_conf_path"
-	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
-	# Store file checksum for the new config file location
-	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
-fi
 
 #=================================================
 # SPECIFIC MODIFICATIONS
@@ -114,7 +34,7 @@ ynh_script_progression --message="Updating a configuration file..." --weight=1
 
 ynh_add_config --template="../conf/cockpit.conf" --destination="/etc/cockpit/cockpit.conf"
 
-chmod 440 "/etc/cockpit/cockpit.conf"
+chmod 650 "/etc/cockpit/cockpit.conf"
 chown root:$app-ws "/etc/cockpit/cockpit.conf"
 
 #=================================================
@@ -127,13 +47,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=1
 # Start a systemd service
 ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Started"
 
-#=================================================
-# RELOAD NGINX
-#=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=1
-
-ynh_systemd_action --service_name=nginx --action=reload
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/install

@@ -9,59 +9,6 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-ynh_clean_setup () {
-	true
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# RETRIEVE ARGUMENTS FROM THE MANIFEST
-#=================================================
-
-domain=$YNH_APP_ARG_DOMAIN
-path_url=$YNH_APP_ARG_PATH
-
-app=$YNH_APP_INSTANCE_NAME
-
-#=================================================
-# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
-#=================================================
-ynh_script_progression --message="Validating installation parameters..." --weight=1
-
-# 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..." --weight=2
-
-ynh_app_setting_set --app=$app --key=domain --value=$domain
-ynh_app_setting_set --app=$app --key=path --value=$path_url
-
-#=================================================
-# STANDARD MODIFICATIONS
-#=================================================
-# FIND AND OPEN A PORT
-#=================================================
-ynh_script_progression --message="Finding an available port..." --weight=2
-
-# Find an available port
-port=$(ynh_find_port --port=8095)
-ynh_app_setting_set --app=$app --key=port --value=$port
-
-#=================================================
-# INSTALL DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Installing dependencies..." --weight=20
-
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@@ -93,7 +40,7 @@ chown root:$app-ws "/etc/cockpit/cockpit.conf"
 #=================================================
 ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
 
-yunohost service add $app
+yunohost service add $app --description="Sysadmin login session in a web browser" --log="/var/log/$app/$app.log"
 
 #=================================================
 # START SYSTEMD SERVICE
@@ -103,13 +50,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=2
 # Start a systemd service
 ynh_systemd_action --service_name=$app --action="restart" --log_path="systemd" --line_match="Started"
 
-#=================================================
-# RELOAD NGINX
-#=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=2
-
-ynh_systemd_action --service_name=nginx --action=reload
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/remove

@@ -10,21 +10,11 @@ source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
-# LOAD SETTINGS
+# REMOVE SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+# REMOVE SYSTEMD SERVICE 
-
-app=$YNH_APP_INSTANCE_NAME
-
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-port=$(ynh_app_setting_get --app=$app --key=port)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-
-#=================================================
-# STANDARD REMOVE
-#=================================================
-# REMOVE SERVICE INTEGRATION IN YUNOHOST
 #=================================================
+ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
 
 # Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
 if ynh_exec_warn_less yunohost service status $app >/dev/null
@@ -33,37 +23,11 @@ then
 	yunohost service remove $app
 fi
 
-#=================================================
+ynh_remove_systemd_config
-# STOP AND REMOVE SERVICE
-#=================================================
-ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1
-
-# Remove the dedicated systemd config
-ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
-
-#=================================================
-# REMOVE NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Removing NGINX web server configuration..." --weight=5
 
 # Remove the dedicated NGINX config
 ynh_remove_nginx_config
 
-#=================================================
-# REMOVE DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Removing dependencies..." --weight=1
-
-# Remove metapackage and its dependencies
-ynh_remove_app_dependencies
-
-#=================================================
-# SPECIFIC REMOVE
-#=================================================
-# REMOVE VARIOUS FILES
-#=================================================
-ynh_script_progression --message="Removing various files..." --weight=1
-
 # Remove a directory securely
 ynh_secure_remove --file="/etc/$app"
 

scripts/restore

@@ -10,51 +10,6 @@
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-ynh_clean_setup () {
-	true
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
-
-app=$YNH_APP_INSTANCE_NAME
-
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
-port=$(ynh_app_setting_get --app=$app --key=port)
-
-#=================================================
-# CHECK IF THE APP CAN BE RESTORED
-#=================================================
-ynh_script_progression --message="Validating restoration parameters..." --weight=2
-
-#=================================================
-# STANDARD RESTORATION STEPS
-#=================================================
-# SPECIFIC RESTORATION
-#=================================================
-# REINSTALL DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Reinstalling dependencies..." --weight=7
-
-# Define and install dependencies
-ynh_install_app_dependencies $pkg_dependencies
-
-#=================================================
-# RESTORE THE NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1
-
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
-
 #=================================================
 # RESTORE VARIOUS FILES
 #=================================================
@@ -67,25 +22,24 @@ systemctl restart $app.socket
 ynh_restore_file --origin_path="/etc/cockpit/cockpit.conf"
 
 #=================================================
-# INTEGRATE SERVICE IN YUNOHOST
+# RESTORE SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
+# RESTORE THE PHP-FPM CONFIGURATION
-
-yunohost service add $app
-
 #=================================================
-# START SYSTEMD SERVICE
+ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
-#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=2
 
-ynh_systemd_action --service_name=$app --action="restart" --log_path="systemd" --line_match="Started"
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
+yunohost service add $app --description="Sysadmin login session in a web browser" --log="/var/log/$app/$app.log"
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
-# RELOAD NGINX
+# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=2
+ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
+
+ynh_systemd_action --service_name=$app --action="restart" --log_path="systemd" --line_match="Started"
 
 ynh_systemd_action --service_name=nginx --action=reload
 

scripts/upgrade

@@ -9,39 +9,12 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=2
-
-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)
-port=$(ynh_app_setting_get --app=$app --key=port)
-
 #=================================================
 # CHECK VERSION
 #=================================================
-ynh_script_progression --message="Checking version..." --weight=1
 
 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
-
-# Backup the current version of the app
-ynh_backup_before_upgrade
-ynh_clean_setup () {
-	# Restore it if the upgrade fails
-	ynh_restore_upgradebackup
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
 #=================================================
 # STANDARD UPGRADE STEPS
 #=================================================
@@ -52,22 +25,15 @@ ynh_script_progression --message="Stopping a systemd service..." --weight=1
 ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
 
 #=================================================
-# UPGRADE DEPENDENCIES
+# REAPPLY SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Upgrading dependencies..." --weight=20
+ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
-
-ynh_install_app_dependencies $pkg_dependencies
-
-#=================================================
-# NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2
 
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
-#=================================================
+yunohost service add $app --description="Sysadmin login session in a web browser" --log="/var/log/$app/$app.log"
-# SPECIFIC UPGRADE
+
 #=================================================
 # UPDATE A CONFIG FILE
 #=================================================
@@ -79,14 +45,8 @@ systemctl restart $app.socket
 
 ynh_add_config --template="../conf/cockpit.conf" --destination="/etc/cockpit/cockpit.conf"
 
-#=================================================
+chmod 650 "/etc/cockpit/cockpit.conf"
-# GENERIC FINALIZATION
+chown root:$app-ws "/etc/cockpit/cockpit.conf"
-#=================================================
-# INTEGRATE SERVICE IN YUNOHOST
-#=================================================
-ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
-
-yunohost service add $app
 
 #=================================================
 # START SYSTEMD SERVICE
@@ -95,13 +55,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=2
 
 ynh_systemd_action --service_name=$app --action="restart" --log_path="systemd" --line_match="Started"
 
-#=================================================
-# RELOAD NGINX
-#=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=2
-
-ynh_systemd_action --service_name=nginx --action=reload
-
 #=================================================
 # END OF SCRIPT
 #=================================================

tests.toml

@@ -0,0 +1,3 @@
+test_format = 1.0
+
+[default]