1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/limesurvey_ynh.git synced 2024-09-03 19:36:32 +02:00

Initialize packaging v2

This commit is contained in:
tituspijean 2023-08-25 15:12:56 +02:00
parent 07a0e62158
commit f2e115179e
No known key found for this signature in database
GPG key ID: EF3B0D7CC0A94720
20 changed files with 160 additions and 791 deletions

View file

@ -1,33 +0,0 @@
;; Test complet
; Manifest
domain="domain.tld"
path="/path"
language="en"
admin="john"
password="1Strong-Password"
is_admin_public=1
; Checks
pkg_linter=1
setup_sub_dir=1
setup_root=1
setup_nourl=0
setup_private=0
setup_public=1
upgrade=1
# 3.17.1~ynh1
#upgrade=1 from_commit=da4959616e67f89ef907a223f7c84607dc4771e5
# 5.2.6~ynh2
upgrade=1 from_commit=58cac7dfc0d0b835898d56238e550c775be7255b
# 5.2.6~ynh3
upgrade=1 from_commit=73fa31321aa056102c8a1c79efc3946753190c9c
backup_restore=1
multi_instance=1
port_already_use=0
change_url=0
;;; Options
Email=ljf+libresurvey_ynh@reflexlibre.net
Notification=down
;;; Upgrade options
; commit=da4959616e67f89ef907a223f7c84607dc4771e5
name=3.17.1
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=en&is_public=1&

View file

@ -1,7 +0,0 @@
SOURCE_URL=https://api.github.com/repos/LimeSurvey/LimeSurvey/tarball/refs/tags/5.6.8+230227
SOURCE_SUM=eedad74060c71673b4ff0dbc466957d317add672d0e32984c83141b8b0ff3757
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true
SOURCE_FILENAME=limesurvey.tar.gz
SOURCE_EXTRACT=true

View file

@ -65,7 +65,7 @@ return array(
// 'use_asset_manager'=>true, // Uncomment if you want to use debug mode and asset manager at the same time
'enableLdap' => true,
'force_ssl' => true,
'uploaddir' => '__DATADIR__/upload'
'uploaddir' => '__DATA_DIR__/upload'
)
);
/* End of file config.php */

View file

@ -1,4 +0,0 @@
SOURCE_URL=https://github.com/zamentur/libreform/archive/40fad776c33271ecc028b9260fb7f9e300998e5f.tar.gz
SOURCE_SUM=4c0a96d610c6740ff7467cf1916a923949bf4c00e99a3cd33509335f884e138b
SOURCE_SUM_PRG=sha256sum
SOURCE_FILENAME=libreform-40fad776c33271ecc028b9260fb7f9e300998e5f.tar.gz

View file

@ -2,7 +2,7 @@
location __PATH__/ {
# Path to source
alias __FINALPATH__/;
alias __INSTALL_DIR__/;
more_set_headers "X-Frame-Options : ALLOWALL";

View file

@ -358,7 +358,7 @@ request_terminate_timeout = 1d
; Chdir to this directory at the start.
; Note: relative path can be used.
; Default Value: current directory or / when chroot
chdir = __FINALPATH__
chdir = __INSTALL_DIR__
; Redirect worker stdout and stderr into main error log. If not set, stdout and
; stderr will be redirected to /dev/null according to FastCGI specs.

View file

@ -1,5 +0,0 @@
### YunoHost specific features
* In private mode, only authorized YunoHost members can create poll, with the public mode, it's possible to create account to people with no YunoHost account.
* SSO and LDAP are configured.
* Login secured by fail2ban

View file

@ -1,5 +0,0 @@
### Caractéristiques spécifiques de YunoHost
* En mode privé, seuls les membres autorisés de YunoHost peuvent créer des sondages, en mode public, il est possible de créer des comptes pour les personnes n'ayant pas de compte YunoHost.
* SSO et LDAP sont configurés.
* Login sécurisé par fail2ban

5
doc/POST_INSTALL.md Normal file
View file

@ -0,0 +1,5 @@
LimeSurvey was successfully installed :)
You can now create a poll on this address: https://__DOMAIN____PATH__/admin/
If you are facing any problem or want to improve this app, please open a new issue here: https://github.com/YunoHost-Apps/limesurvey_ynh/issues

5
doc/POST_INSTALL_fr.md Normal file
View file

@ -0,0 +1,5 @@
LimeSurvey a été installé avec succès. :)
Vous pouvez maintenant créer un sondage à cette adresse : https://__DOMAIN____PATH__/admin/
Si vous rencontrez un quelconque problème, ou si vous souhaitez améliorer cette app, rendez-vous à l'adresse : https://github.com/YunoHost-Apps/limesurvey_ynh/issues

View file

@ -1,186 +0,0 @@
{
"name": "LimeSurvey",
"id": "limesurvey",
"packaging_format": 1,
"description": {
"en": "Create and distribute surveys",
"fr": "Outil de création et diffusion de sondage"
},
"version": "5.6.8+230227~ynh1",
"url": "https://www.limesurvey.org/",
"upstream": {
"license": "GPL-2.0+",
"website": "https://www.limesurvey.org",
"admindoc": "https://manual.limesurvey.org/LimeSurvey_Manual/fr",
"userdoc": "https://help.limesurvey.org",
"code": "https://github.com/LimeSurvey/LimeSurvey"
},
"license": "GPL-2.0+",
"maintainer": {
"name": "ljf",
"email": "ljf+limesurvey_ynh@reflexlibre.net",
"url": "https://reflexlibre.net"
},
"requirements": {
"yunohost": ">= 11.0.9"
},
"multi_instance": true,
"services": [
"nginx",
"php7.3-fpm",
"mysql"
],
"arguments": {
"install": [
{
"name": "domain",
"type": "domain"
},
{
"name": "path",
"type": "path",
"example": "/poll",
"default": "/poll"
},
{
"name": "language",
"type": "string",
"ask": {
"en": "Choose the default language of this LimeSurvey",
"fr": "Choisissez la langue par défault de LimeSurvey"
},
"choices": [
"af",
"am",
"ar",
"az",
"be",
"bg",
"bn",
"bs",
"ca",
"ca-valencia",
"ceb",
"ckb",
"cnr",
"cs",
"cs-informal",
"cy",
"da",
"de",
"de-easy",
"de-informal",
"el",
"en",
"eo",
"es",
"es-AR",
"es-AR-informal",
"es-CL",
"es-CO",
"es-MX",
"et",
"eu",
"fa",
"fi",
"fil",
"fr",
"ful",
"ga",
"gl",
"gu",
"he",
"hi",
"hil",
"hr",
"hu",
"hy",
"id",
"ilo",
"is",
"it",
"it-informal",
"ja",
"ka",
"kal",
"kk",
"kmr",
"ko",
"ky",
"lb",
"lt",
"lv",
"mk",
"ml",
"mn",
"mr",
"ms",
"mt",
"mya",
"nb",
"nl",
"nl-informal",
"nn",
"ny",
"oc",
"pa",
"pap-CW",
"pl",
"pl-informal",
"prs",
"ps",
"pt",
"pt-BR",
"ro",
"roh",
"ru",
"run",
"rw",
"sah",
"si",
"sk",
"sl",
"smi",
"so",
"sq",
"sr",
"sr-Latn",
"sv",
"swh",
"ta",
"tg",
"th",
"ti",
"tl",
"tr",
"uk",
"ur",
"vi",
"xho",
"zh-Hans",
"zh-Hant-HK",
"zh-Hant-TW",
"zu"
],
"default": "en"
},
{
"name": "admin",
"type": "user"
},
{
"name": "password",
"type": "password"
},
{
"name": "is_admin_public",
"type": "boolean",
"ask": {
"en": "In private mode, only authorized YunoHost members can create poll, with the public mode, it's possible to create account to people with no YunoHost account. ",
"fr": "En mode privé, seuls les utilisateurs YunoHost autorisés peuvent créer un sondage. En mode public, il est possible de créer un sondage avec un compte Limesurvey mais sans compte YunoHost."
},
"default": true
}
]
}
}

87
manifest.toml Normal file
View file

@ -0,0 +1,87 @@
packaging_format = 2
id = "limesurvey"
name = "LimeSurvey"
description.en = "Create and distribute surveys"
description.fr = "Outil de création et diffusion de sondage"
version = "5.6.8+230227~ynh1"
maintainers = ["ljf"]
[upstream]
license = "GPL-2.0+"
website = "https://www.limesurvey.org"
admindoc = "https://manual.limesurvey.org/LimeSurvey_Manual/fr"
userdoc = "https://help.limesurvey.org"
code = "https://github.com/LimeSurvey/LimeSurvey"
cpe = "cpe:2.3:a:limesurvey:limesurvey"
[integration]
yunohost = ">= 11.0.9"
architectures = "all"
multi_instance = true
ldap = true
sso = true
disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ...
ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
[install]
[install.domain]
type = "domain"
[install.path]
type = "path"
default = "/poll"
[install.language]
ask.en = "Choose the default language of this LimeSurvey"
ask.fr = "Choisissez la langue par défault de LimeSurvey"
type = "string"
choices = ["af", "am", "ar", "az", "be", "bg", "bn", "bs", "ca", "ca-valencia", "ceb", "ckb", "cnr", "cs", "cs-informal", "cy", "da", "de", "de-easy", "de-informal", "el", "en", "eo", "es", "es-AR", "es-AR-informal", "es-CL", "es-CO", "es-MX", "et", "eu", "fa", "fi", "fil", "fr", "ful", "ga", "gl", "gu", "he", "hi", "hil", "hr", "hu", "hy", "id", "ilo", "is", "it", "it-informal", "ja", "ka", "kal", "kk", "kmr", "ko", "ky", "lb", "lt", "lv", "mk", "ml", "mn", "mr", "ms", "mt", "mya", "nb", "nl", "nl-informal", "nn", "ny", "oc", "pa", "pap-CW", "pl", "pl-informal", "prs", "ps", "pt", "pt-BR", "ro", "roh", "ru", "run", "rw", "sah", "si", "sk", "sl", "smi", "so", "sq", "sr", "sr-Latn", "sv", "swh", "ta", "tg", "th", "ti", "tl", "tr", "uk", "ur", "vi", "xho", "zh-Hans", "zh-Hant-HK", "zh-Hant-TW", "zu"]
default = "en"
[install.admin]
type = "user"
[install.password]
type = "password"
[install.init_admin_permission]
ask.en = "If you select Visitors here, they will be able to create surveys with a Limesurvey account and without YunoHost account."
ask.fr = "Si vous sélectionnez Visiteurs ici, il sera possible de créer un sondage avec un compte Limesurvey mais sans compte YunoHost."
type = "group"
[resources]
[resources.sources]
[resources.sources.libreform]
url = "https://github.com/zamentur/libreform/archive/40fad776c33271ecc028b9260fb7f9e300998e5f.tar.gz"
sha256 = "4c0a96d610c6740ff7467cf1916a923949bf4c00e99a3cd33509335f884e138b"
[resources.sources.main]
url = "https://api.github.com/repos/LimeSurvey/LimeSurvey/tarball/refs/tags/5.6.8+230227"
sha256 = "eedad74060c71673b4ff0dbc466957d317add672d0e32984c83141b8b0ff3757"
autoupdate.strategy = "latest_github_tag"
format = "tar.gz"
in_subdir = true
[resources.system_user]
[resources.install_dir]
[resources.data_dir]
subdirs = ["upload"]
[resources.permissions]
main.url = "/"
main.allowed = "visitors"
admin.url = "/admin"
[resources.apt]
packages = "php7.3-cli, php7.3-mysql, php7.3-imap, python3-pip, php7.3-gd, php7.3-ldap, php7.3-zip, php7.3-mbstring"
[resources.database]
type = "mysql"

View file

@ -6,11 +6,6 @@
# App package root directory should be the parent folder
PKG_DIR=$(cd ../; pwd)
YNH_PHP_VERSION="7.3"
# dependencies used by the app
pkg_dependencies="php${YNH_PHP_VERSION}-cli php${YNH_PHP_VERSION}-mysql php${YNH_PHP_VERSION}-imap python3-pip php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-ldap php${YNH_PHP_VERSION}-zip php${YNH_PHP_VERSION}-mbstring"
#=================================================
# PERSONAL HELPERS
#=================================================
@ -18,60 +13,3 @@ pkg_dependencies="php${YNH_PHP_VERSION}-cli php${YNH_PHP_VERSION}-mysql php${YNH
#=================================================
# EXPERIMENTAL HELPERS
#=================================================
# Send an email to inform the administrator
#
# usage: ynh_send_readme_to_admin app_message [recipients]
# | arg: app_message - The message to send to the administrator.
# | arg: recipients - The recipients of this email. Use spaces to separate multiples recipients. - default: root
# example: "root admin@domain"
# If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
# example: "root admin@domain user1 user2"
ynh_send_readme_to_admin() {
local app_message="${1:-...No specific information...}"
local recipients="${2:-root}"
# Retrieve the email of users
find_mails () {
local list_mails="$1"
local mail
local recipients=" "
# Read each mail in argument
for mail in $list_mails
do
# Keep root or a real email address as it is
if [ "$mail" = "root" ] || echo "$mail" | grep --quiet "@"
then
recipients="$recipients $mail"
else
# But replace an user name without a domain after by its email
if mail=$(ynh_user_get_info "$mail" "mail" 2> /dev/null)
then
recipients="$recipients $mail"
fi
fi
done
echo "$recipients"
}
recipients=$(find_mails "$recipients")
local mail_subject="☁️🆈🅽🅷☁️: \`$app\` has important message for you"
local mail_message="This is an automated message from your beloved YunoHost server.
Specific information for the application $app.
$app_message
---
Automatic diagnosis data from YunoHost
$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
# Define binary to use for mail command
if [ -e /usr/bin/bsd-mailx ]
then
local mail_bin=/usr/bin/bsd-mailx
else
local mail_bin=/usr/bin/mail.mailutils
fi
# Send the email to the recipients
echo "$mail_message" | $mail_bin -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients"
}

View file

@ -10,29 +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)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
#=================================================
# DECLARE DATA AND CONF FILES TO BACKUP
#=================================================
@ -42,13 +19,13 @@ ynh_print_info --message="Declaring files to be backed up..."
# BACKUP THE APP MAIN DIR
#=================================================
ynh_backup --src_path="$final_path"
ynh_backup --src_path="$install_dir"
#=================================================
# BACKUP THE DATA DIR
#=================================================
ynh_backup --src_path="$datadir" --is_big
ynh_backup --src_path="$data_dir" --is_big
#=================================================
# BACKUP THE NGINX CONFIGURATION

View file

@ -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
#=================================================
@ -74,38 +16,7 @@ fi
#=================================================
ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
# 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
#=================================================
# GENERIC FINALISATION
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
ynh_change_url_nginx_config
#=================================================
# END OF SCRIPT

View file

@ -9,108 +9,32 @@
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
language=$YNH_APP_ARG_LANGUAGE
admin=$YNH_APP_ARG_ADMIN
password=$YNH_APP_ARG_PASSWORD
is_admin_public=$YNH_APP_ARG_IS_ADMIN_PUBLIC
app=$YNH_APP_INSTANCE_NAME
prefix=lime_
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
ynh_script_progression --message="Validating installation parameters..." --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..." --weight=1
ynh_app_setting_set --app=$app --key=domain --value=$domain
ynh_app_setting_set --app=$app --key=path --value=$path_url
ynh_app_setting_set --app=$app --key=language --value=$language
ynh_app_setting_set --app=$app --key=admin --value=$admin
ynh_app_setting_set --app=$app --key=prefix --value=$prefix
#=================================================
# STANDARD MODIFICATIONS
#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Installing dependencies..." --weight=1
ynh_install_app_dependencies $pkg_dependencies
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Configuring system user..." --weight=1
# Create a system user
ynh_system_user_create --username=$app --home_dir="$final_path"
#=================================================
# CREATE A MYSQL DATABASE
#=================================================
ynh_script_progression --message="Creating a MySQL database..." --weight=1
db_name=$(ynh_sanitize_dbid --db_name=$app)
db_user=$db_name
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
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
ynh_setup_source --dest_dir="$final_path"
ynh_setup_source --dest_dir="$install_dir"
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
chmod 750 "$install_dir"
chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_script_progression --message="Configuring PHP-FPM..." --weight=1
# Create a dedicated PHP-FPM config
ynh_add_fpm_config
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Configuring NGINX web server..." --weight=1
# Create a dedicated NGINX config
ynh_add_nginx_config
#=================================================
@ -120,33 +44,28 @@ ynh_add_nginx_config
#=================================================
ynh_script_progression --message="Creating a data directory..." --weight=1
datadir=/home/yunohost.app/$app
ynh_app_setting_set --app=$app --key=datadir --value=$datadir
mkdir -p $datadir/upload
# Remove upload if empty
rmdir $datadir 2> /dev/null && mv "$final_path/upload" $datadir || true
chmod -R o-rwx "$datadir"
chown -R $app:www-data "$datadir"
ln -s $datadir/upload $final_path/upload 2> /dev/null || true
rmdir $data_dir 2> /dev/null && mv "$install_dir/upload" $data_dir || true
chmod -R o-rwx "$data_dir"
chown -R $app:www-data "$data_dir"
ln -s $data_dir/upload $install_dir/upload 2> /dev/null || true
#=================================================
# ADD A CONFIGURATION
#=================================================
ynh_script_progression --message="Adding a configuration file..." --weight=1
ynh_add_config --template="../conf/config.php" --destination="$final_path/application/config/config.php"
ynh_add_config --template="../conf/config.php" --destination="$install_dir/application/config/config.php"
chmod 400 "$final_path/application/config/config.php"
chown $app:$app "$final_path/application/config/config.php"
chmod 400 "$install_dir/application/config/config.php"
chown $app:$app "$install_dir/application/config/config.php"
#=================================================
# INSTALL APP
#=================================================
ynh_script_progression --message="Installing app..."
ls_cli=$final_path/application/commands/console.php
ls_cli=$install_dir/application/commands/console.php
fullname=$(ynh_user_get_info --username="$admin" --key="fullname")
mail=$(ynh_user_get_info --username="$admin" --key="mail")
@ -173,48 +92,17 @@ ynh_secure_remove --file=./data.sql
#=================================================
#ynh_script_progression --message="Adding nice themes..."
#ynh_setup_source "$datadir/upload/templates/libreform" libreform
#ynh_setup_source "$final_path/upload/templates/librepoll" librepoll
#ynh_setup_source "$data_dir/upload/templates/libreform" libreform
#ynh_setup_source "$install_dir/upload/templates/librepoll" librepoll
#=================================================
# GENERIC FINALIZATION
#=================================================
# SETUP SSOWAT
#=================================================
ynh_script_progression --message="Configuring permissions..." --weight=1
# Everyone can access the app.
# The "main" permission is automatically created before the install script.
ynh_permission_update --permission="main" --add="visitors"
if [ $is_admin_public -eq 1 ]
then
allowed_groups="visitors $admin"
else
allowed_groups="$admin"
fi
ynh_permission_create --permission="admin" --url="/admin" --allowed=$allowed_groups --show_tile="true"
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# SEND A README FOR THE ADMIN
#=================================================
ynh_script_progression --message="Sending a readme for the admin..." --weight=1
message="LimeSurvey was successfully installed :)
You can now create a poll on this address: https://$domain$path_url/admin/
If you are facing any problem or want to improve this app, please open a new issue here: https://github.com/YunoHost-Apps/limesurvey_ynh/issues"
ynh_send_readme_to_admin "$message"
# Grant $admin access to /admin, whether or not Visitors has been selected in the installation form
ynh_permission_update --permission="admin" --add="$admin"
#=================================================
# END OF SCRIPT

View file

@ -9,48 +9,6 @@
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# 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)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
#=================================================
# STANDARD REMOVE
#=================================================
# REMOVE THE MYSQL DATABASE
#=================================================
ynh_script_progression --message="Removing the MySQL database..." --weight=1
# Remove a database if it exists, along with the associated user
ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
#=================================================
# REMOVE APP MAIN DIR
#=================================================
ynh_script_progression --message="Removing app main directory..." --weight=1
# Remove the app directory securely
ynh_secure_remove --file="$final_path"
#=================================================
# REMOVE DATA DIR
#=================================================
# Remove the data directory if --purge option is used
if [ "${YNH_APP_PURGE:-0}" -eq 1 ]
then
ynh_script_progression --message="Removing app data directory..." --weight=1
ynh_secure_remove --file="$datadir"
fi
#=================================================
# REMOVE NGINX CONFIGURATION
#=================================================
@ -67,24 +25,6 @@ ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=1
# Remove the dedicated PHP-FPM config
ynh_remove_fpm_config
#=================================================
# REMOVE DEPENDENCIES
#=================================================
ynh_script_progression --message="Removing dependencies..." --weight=1
# Remove metapackage and its dependencies
ynh_remove_app_dependencies
#=================================================
# SPECIFIC REMOVE
#=================================================
# REMOVE DEDICATED USER
#=================================================
ynh_script_progression --message="Removing the dedicated system user..." --weight=1
# Delete a system user
ynh_system_user_delete --username=$app
#=================================================
# END OF SCRIPT
#=================================================

View file

@ -10,83 +10,30 @@
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)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
#=================================================
# CHECK IF THE APP CAN BE RESTORED
#=================================================
ynh_script_progression --message="Validating restoration parameters..." --weight=1
test ! -d $final_path \
|| ynh_die --message="There is already a directory: $final_path "
#=================================================
# STANDARD RESTORATION STEPS
#=================================================
# RECREATE THE DEDICATED USER
#=================================================
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
# Create the dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
ynh_script_progression --message="Restoring the app main directory..." --weight=1
ynh_restore_file --origin_path="$final_path"
ynh_restore_file --origin_path="$install_dir"
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
chmod 750 "$install_dir"
chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
#=================================================
# RESTORE THE DATA DIRECTORY
#=================================================
ynh_script_progression --message="Restoring the data directory..." --weight=2
ynh_restore_file --origin_path="$datadir" --not_mandatory
ynh_restore_file --origin_path="$data_dir" --not_mandatory
mkdir -p "$datadir/upload"
mkdir -p "$data_dir/upload"
chmod 750 "$datadir"
chmod -R o-rwx "$datadir"
chown -R $app:www-data "$datadir"
ln -s $datadir/upload $final_path/upload 2> /dev/null || true
#=================================================
# SPECIFIC RESTORATION
#=================================================
# REINSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Reinstalling dependencies..." --weight=1
# Define and install dependencies
ynh_install_app_dependencies $pkg_dependencies
chmod 750 "$data_dir"
chmod -R o-rwx "$data_dir"
chown -R $app:www-data "$data_dir"
ln -s $data_dir/upload $install_dir/upload 2> /dev/null || true
#=================================================
# RESTORE THE PHP-FPM CONFIGURATION
@ -107,8 +54,6 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
ynh_script_progression --message="Restoring the MySQL database..." --weight=1
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
#=================================================

View file

@ -9,45 +9,12 @@
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# 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)
admin=$(ynh_app_setting_get --app=$app --key=admin)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
prefix=$(ynh_app_setting_get --app=$app --key=prefix)
is_admin_public=$(ynh_app_setting_get --app=$app --key=is_admin_public)
#=================================================
# 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=7
# 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
#=================================================
@ -55,68 +22,12 @@ ynh_abort_if_errors
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
# If db_name doesn't exist, create it
if [ -z "$db_name" ]; then
db_name=$(ynh_sanitize_dbid --db_name=$app)
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
fi
# If final_path doesn't exist, create it
if [ -z "$final_path" ]; then
final_path=/var/www/$app
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
fi
# If prefix doesn't exist, create it
if [ -z "$prefix" ]; then
prefix="lime_"
ynh_app_setting_set --app=$app --key=prefix --value=$prefix
fi
# If datadir doesn't exist, create it
if [ -z "$datadir" ]; then
datadir=/home/yunohost.app/$app/upload
ynh_app_setting_set --app=$app --key=datadir --value=$datadir
mkdir -p $datadir
# Remove upload if empty
rmdir $datadir 2> /dev/null && mv "$final_path/upload" $datadir || true
chown -R $app:www-data "$datadir"
chmod -R o-rwx "$datadir"
ln -s $datadir/upload $final_path/upload
fi
# Cleaning legacy permissions
if ynh_legacy_permissions_exists; then
ynh_legacy_permissions_delete_all
ynh_app_setting_delete --app=$app --key=is_public
fi
if ! ynh_permission_exists --permission="admin"; then
# Create the required permissions
if [ $is_admin_public -eq 1 ]
then
allowed_groups="visitors $admin"
else
allowed_groups="$admin"
fi
ynh_permission_create --permission="admin" --url="/admin" --allowed=$allowed_groups --show_tile="true"
fi
# Create a permission if needed
if ! ynh_permission_exists --permission="api"; then
ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --show_tile="false" --protected="true"
fi
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
# Create a dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
@ -126,24 +37,17 @@ 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="plugins/ application/config/config.php"
ynh_setup_source --dest_dir="$install_dir" --keep="plugins/ application/config/config.php"
fi
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
chmod 750 "$final_path/tmp"
chmod 750 "$final_path/application/config/"
chown -R $app:www-data "$datadir"
chmod 750 $datadir
ln -s $datadir/upload $final_path/upload 2> /dev/null || true
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
ynh_script_progression --message="Upgrading dependencies..." --weight=1
ynh_install_app_dependencies $pkg_dependencies
chmod 750 "$install_dir"
chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
chmod 750 "$install_dir/tmp"
chmod 750 "$install_dir/application/config/"
chown -R $app:www-data "$data_dir"
chmod 750 $data_dir
ln -s $data_dir/upload $install_dir/upload 2> /dev/null || true
#=================================================
# PHP-FPM CONFIGURATION
@ -168,10 +72,10 @@ ynh_add_nginx_config
#=================================================
ynh_script_progression --message="Updating a configuration file..." --weight=1
ynh_add_config --template="../conf/config.php" --destination="$final_path/application/config/config.php"
ynh_add_config --template="../conf/config.php" --destination="$install_dir/application/config/config.php"
chmod 400 "$final_path/application/config/config.php"
chown $app:$app "$final_path/application/config/config.php"
chmod 400 "$install_dir/application/config/config.php"
chown $app:$app "$install_dir/application/config/config.php"
#=================================================
# UPGRADE DB
@ -179,16 +83,7 @@ chown $app:$app "$final_path/application/config/config.php"
ynh_script_progression --message="Upgrading DB..."
# Migrate DB
ynh_exec_as "$app" php$phpversion $final_path/application/commands/console.php updatedb
#=================================================
# GENERIC FINALIZATION
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
ynh_exec_as "$app" php$phpversion $install_dir/application/commands/console.php updatedb
#=================================================
# END OF SCRIPT

18
tests.toml Normal file
View file

@ -0,0 +1,18 @@
test_format = 1.0
[default]
# -------------------------------
# Default args to use for install
# -------------------------------
# args.admin = "john"
# args.password = "1Strong-Password"
# args.is_admin_public
# -------------------------------
# Commits to test upgrade from
# -------------------------------
test_upgrade_from.58cac7dfc0d0b835898d56238e550c775be7255b.name = "Upgrade from 5.2.6~ynh2"
test_upgrade_from.73fa31321aa056102c8a1c79efc3946753190c9c.name = "Upgrade from 5.2.6~ynh3"