fix

doc/ADMIN.md

@@ -3,4 +3,4 @@
 You can configure Vikunja with the config panels in the webadmin or by editing this file `/opt/vikunja/config.yml` using the [documentation](https://vikunja.io/docs/config-options/).
 
 
-The API is accesible with this path: https://domain.ltd/api/v1/docs
+The API is accesible with this path: https://__DOMAIN__/api/v1/docs

doc/ADMIN_fr.md

@@ -1,3 +1 @@
-## Configuration
-
 Vous pouvez configurer Vikunja avec les config panels ou en modifiant le fichier `/opt/vikunja/config.yml` en vous aidant de la [documentation](https://vikunja.io/docs/config-options/).

manifest.json

@@ -1,46 +0,0 @@
-{
-    "name": "Vikunja",
-    "id": "vikunja",
-    "packaging_format": 1,
-    "description": {
-        "en": "Self-hosted To-Do list application",
-        "fr": "Application de liste de tâches auto-hébergée"
-    },
-    "version": "0.20.2~ynh1",
-    "url": "https://vikunja.io/",
-    "upstream": {
-        "license": "GPL-3.0",
-        "website": "https://vikunja.io/",
-        "demo": "https://try.vikunja.io/login",
-        "admindoc": "https://vikunja.io/docs/",
-        "code": "https://kolaente.dev/vikunja/"
-    },
-    "license": "GPL-3.0",
-    "maintainer": {
-        "name": "eric_G"
-    },
-    "requirements": {
-        "yunohost": ">= 11.0.9"
-    },
-    "multi_instance": true,
-    "services": [
-        "nginx"
-    ],
-    "arguments": {
-        "install" : [
-            {
-                "name": "domain",
-                "type": "domain"
-            },
-            {
-                "name": "is_public",
-                "type": "boolean",
-                "help": {
-                    "en": "If enabled, Vikunja will be accessible by people who do not have an account. This can be changed later via the webadmin.",
-                    "fr": "Si cette case est cochée, Vikunja sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin."
-                },
-                "default": true
-            }
-        ]
-    }
-}

manifest.toml

@@ -15,22 +15,18 @@ website = "https://vikunja.io/"
 demo = "https://try.vikunja.io/login"
 admindoc = "https://vikunja.io/docs/"
 code = "https://kolaente.dev/vikunja/"
-cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number)
-fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin.
 
 [integration]
-yunohost = ">= 11.0.9"
+yunohost = ">= 11.1.12"
-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"]
+architectures = "all"
 multi_instance = true
-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.
+ldap = false
-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.
+sso = false
-disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ...
+ram.build = "50M"
-ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
+ram.runtime = "50M"
-ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
 
 [install]
     [install.domain]
-    # this is a generic question - ask strings are automatically handled by Yunohost's core
     type = "domain"
     full_domain = true
 
@@ -41,6 +37,8 @@ ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requiremen
     default = "visitors"
 
 [resources]
+    [resources.ports]
+
     [resources.system_user]
 
     [resources.install_dir]
@@ -48,5 +46,12 @@ ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requiremen
     [resources.permissions]
     main.url = "/"
 
+    api.url = "/api"
+    api.show_tile = false
+    api.allowed = "visitors"
+
+    [resources.apt]
+    packages = "postgresql"
+
     [resources.database]
     type = "postgresql"

scripts/install

@@ -9,25 +9,13 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-# Exit if an error occurs during the execution of the script
-#REMOVEME? ynh_abort_if_errors
-
 #=================================================
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
 
-#REMOVEME? domain=$YNH_APP_ARG_DOMAIN
-path="/"
-#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC
 timezone="$(cat /etc/timezone)"
 secret=$(ynh_string_random --length=32)
 
-#REMOVEME? app=$YNH_APP_INSTANCE_NAME
-
 set_motd=""
 enable_registration="true"
 enable_linksharing="true"
@@ -41,22 +29,13 @@ maxitemsperpage=50
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
-#REMOVEME? ynh_script_progression --message="Validating installation parameters..." --weight=1
 
-#REMOVEME? install_dir=/var/www/$app
 backend_path=/opt/$app
-#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder"
-
-# Register (book) web path
-#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
-#REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=2
 
-#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain
-#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path
 ynh_app_setting_set --app=$app --key=set_motd --value=$set_motd
 ynh_app_setting_set --app=$app --key=enable_registration --value=$enable_registration
 ynh_app_setting_set --app=$app --key=enable_linksharing --value=$enable_linksharing
@@ -67,49 +46,11 @@ ynh_app_setting_set --app=$app --key=enable_userdeletion --value=$enable_userdel
 ynh_app_setting_set --app=$app --key=maxavatarsize --value=$maxavatarsize
 ynh_app_setting_set --app=$app --key=maxitemsperpage --value=$maxitemsperpage
 
-#=================================================
-# STANDARD MODIFICATIONS
-#=================================================
-# FIND AND OPEN A PORT
-#=================================================
-#REMOVEME? ynh_script_progression --message="Finding an available port..." --weight=0
-
-# Find an available port
-#REMOVEME? port=$(ynh_find_port --port=3456)
-#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$port
-
-#=================================================
-# INSTALL DEPENDENCIES
-#=================================================
-#REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=20
-
-#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-#REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=1
-
-# Create a system user
-#REMOVEME? ynh_system_user_create --username=$app --home_dir=$install_dir
-
-#=================================================
-# CREATE A POSTGRESQL DATABASE
-#=================================================
-#REMOVEME? ynh_script_progression --message="Creating a PostgreSQL database..." --weight=2
-
-#REMOVEME? db_name=$(ynh_sanitize_dbid --db_name=$app)
-#REMOVEME? db_user=$db_name
-#REMOVEME? ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-#REMOVEME? ynh_psql_test_if_first_run
-#REMOVEME? ynh_psql_setup_db --db_user=$db_user --db_name=$db_name
-
 #=================================================
 # INSTALL FRONTEND
 #=================================================
 ynh_script_progression --message="Setting up frontend..." --weight=1
 
-#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
 # Download, check integrity, uncompress and patch the source from app.src
 ynh_setup_source --dest_dir="$install_dir" --source_id="front"
 
@@ -122,7 +63,7 @@ chown -R $app:www-data "$install_dir"
 #=================================================
 ynh_script_progression --message="Setting up backend..." --weight=1
 
-#REMOVEME? ynh_app_setting_set --app=$app --key=backend_path --value=$backend_path
+ynh_app_setting_set --app=$app --key=backend_path --value=$backend_path
 
 # Download, check integrity, uncompress and patch the source from app.src
 mkdir -p "$backend_path"
@@ -176,26 +117,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=2
 # Start a systemd service
 ynh_systemd_action --service_name=$app --action=start --log_path=systemd #--line_match="server started on"
 
-#=================================================
-# SETUP SSOWAT
-#=================================================
-#REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=1
-
-# Make app public if necessary or protect it
-#REMOVEME? if [ $is_public -eq 1 ]
-then
-#REMOVEME? 	ynh_permission_update --permission="main" --add="visitors"
-fi
-
-#REMOVEME? ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
-
-#=================================================
-# RELOAD NGINX
-#=================================================
-#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=2
-
-#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/remove

@@ -9,20 +9,6 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# LOAD SETTINGS
-#=================================================
-#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1
-
-#REMOVEME? app=$YNH_APP_INSTANCE_NAME
-
-#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port)
-#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-#REMOVEME? backend_path=$(ynh_app_setting_get --app=$app --key=backend_path)
-#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-#REMOVEME? db_user=$db_name
-
 #=================================================
 # STANDARD REMOVE
 #=================================================
@@ -44,22 +30,6 @@ ynh_script_progression --message="Stopping and removing the systemd service..."
 # Remove the dedicated systemd config
 ynh_remove_systemd_config
 
-#=================================================
-# REMOVE THE POSTGRESQL DATABASE
-#=================================================
-#REMOVEME? ynh_script_progression --message="Removing the PostgreSQL database..." --weight=2
-
-# Remove a database if it exists, along with the associated user
-#REMOVEME? ynh_psql_remove_db --db_user=$db_user --db_name=$db_name
-
-#=================================================
-# REMOVE DEPENDENCIES
-#=================================================
-#REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=1
-
-# Remove metapackage and its dependencies
-#REMOVEME? ynh_remove_app_dependencies
-
 #=================================================
 # REMOVE THE REDIS DATABASE
 #=================================================
@@ -72,9 +42,6 @@ ynh_redis_remove_db "$redis_db"
 #=================================================
 ynh_script_progression --message="Removing $app main directory..." --weight=6
 
-# Remove the app directory securely
-#REMOVEME? ynh_secure_remove --file="$install_dir"
-
 # Remove backend
 ynh_secure_remove --file="$backend_path"
 
@@ -86,16 +53,6 @@ ynh_script_progression --message="Removing NGINX web server configuration..." --
 # Remove the dedicated NGINX config
 ynh_remove_nginx_config
 
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-# REMOVE DEDICATED USER
-#=================================================
-#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." --weight=1
-
-# Delete a system user
-#REMOVEME? ynh_system_user_delete --username=$app
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/restore

@@ -9,35 +9,6 @@
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-# Exit if an error occurs during the execution of the script
-#REMOVEME? ynh_abort_if_errors
-
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_script_progression --message="Loading settings..." --weight=1
-
-#REMOVEME? app=$YNH_APP_INSTANCE_NAME
-
-#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
-#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-#REMOVEME? backend_path=$(ynh_app_setting_get --app=$app --key=backend_path)
-#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-#REMOVEME? db_user=$db_name
-#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
-
-#=================================================
-# CHECK IF THE APP CAN BE RESTORED
-#=================================================
-#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." --weight=2
-
-#REMOVEME? test ! -d $install_dir || ynh_die --message="There is already a directory: $install_dir "
-
 #=================================================
 # STANDARD RESTORATION STEPS
 #=================================================
@@ -71,21 +42,11 @@ ynh_restore_file --origin_path="$backend_path"
 chmod +x "$backend_path/vikunja"
 chown -R $app:www-data "$backend_path/files"
 
-#=================================================
-# REINSTALL DEPENDENCIES
-#=================================================
-#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." --weight=6
-
-# Define and install dependencies
-#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-
 #=================================================
 # RESTORE THE POSTGRESQL DATABASE
 #=================================================
-#REMOVEME? ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=6
+ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=6
 
-#REMOVEME? ynh_psql_test_if_first_run
-#REMOVEME? ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
 ynh_psql_execute_file_as_root --file="./db.sql" --database=$db_name
 
 #=================================================

scripts/upgrade

@@ -12,52 +12,16 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=2
 
-#REMOVEME? app=$YNH_APP_INSTANCE_NAME
-
-#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
-#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-#REMOVEME? backend_path=$(ynh_app_setting_get --app=$app --key=backend_path)
-#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port)
-#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-#REMOVEME? db_user=$db_name
-#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
 timezone="$(cat /etc/timezone)"
 secret=$(ynh_string_random --length=32)
 
-#REMOVEME? set_motd=$(ynh_app_setting_get --app=$app --key=set_motd)
-#REMOVEME? enable_registration=$(ynh_app_setting_get --app=$app --key=enable_registration)
-#REMOVEME? enable_linksharing=$(ynh_app_setting_get --app=$app --key=enable_linksharing)
-#REMOVEME? enable_taskattachments=$(ynh_app_setting_get --app=$app --key=enable_taskattachments)
-#REMOVEME? enable_taskcomments=$(ynh_app_setting_get --app=$app --key=enable_taskcomments)
-#REMOVEME? enable_emailreminders=$(ynh_app_setting_get --app=$app --key=enable_emailreminders)
-#REMOVEME? enable_userdeletion=$(ynh_app_setting_get --app=$app --key=enable_userdeletion)
-#REMOVEME? maxavatarsize=$(ynh_app_setting_get --app=$app --key=maxavatarsize)
-#REMOVEME? maxitemsperpage=$(ynh_app_setting_get --app=$app --key=maxitemsperpage)
-
-
 #=================================================
 # CHECK VERSION
 #=================================================
 
 upgrade_type=$(ynh_check_app_version_changed)
 
-#=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
-#=================================================
-ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=4
-
-# Backup the current version of the app
-#REMOVEME? ynh_backup_before_upgrade
-#REMOVEME? ynh_clean_setup () {
-	# restore it if the upgrade fails
-#REMOVEME? 	ynh_restore_upgradebackup
-}
-# Exit if an error occurs during the execution of the script
-#REMOVEME? ynh_abort_if_errors
-
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
@@ -114,18 +78,6 @@ if [ -z "$maxitemsperpage" ]; then
 	ynh_app_setting_set --app=$app --key=maxitemsperpage --value=$maxitemsperpage
 fi
 
-# Cleaning legacy permissions
-#REMOVEME? if ynh_legacy_permissions_exists; then
-#REMOVEME? 	ynh_legacy_permissions_delete_all
-
-	ynh_app_setting_delete --app=$app --key=is_public
-fi
-
-# Create a permission if needed
-#REMOVEME? if ! ynh_permission_exists --permission="api"; then
-#REMOVEME? 	ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
-fi
-
 #=================================================
 # STANDARD UPGRADE STEPS
 #=================================================
@@ -135,14 +87,6 @@ ynh_script_progression --message="Stopping a systemd service..." --weight=1
 
 ynh_systemd_action --service_name=$app --action=stop --log_path=systemd
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-#REMOVEME? ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
-
-# Create a dedicated user (if not existing)
-#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
-
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@@ -188,13 +132,6 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." -
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
-#=================================================
-# UPGRADE DEPENDENCIES
-#=================================================
-#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=10
-
-#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@@ -216,13 +153,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=1
 
 ynh_systemd_action --service_name=$app --action=start --log_path=systemd --line_match="server started on"
 
-#=================================================
-# RELOAD NGINX
-#=================================================
-#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1
-
-#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
-
 #=================================================
 # END OF SCRIPT
 #=================================================

tests.toml

@@ -0,0 +1,7 @@
+test_format = 1.0
+
+[default]
+
+    # ------------
+    # Tests to run
+    # ------------