mirror of
https://github.com/YunoHost-Apps/dokuwiki_ynh.git
synced 2024-09-03 18:26:20 +02:00
[enh] refactor 'backup' and 'upgrade' scripts
This commit is contained in:
Gofannon
parent
9e53f1cf6f
commit
feba478177
2 changed files with 282 additions and 144 deletions
|
|
@ -1,23 +1,80 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
# Exit on command errors and treat unset variables as an error
|
#=================================================
|
||||||
set -eu
|
# GENERIC START
|
||||||
|
#=================================================
|
||||||
|
# IMPORT GENERIC HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
# Get multi-instances specific variables
|
if [ ! -e _common.sh ]; then
|
||||||
app=$YNH_APP_INSTANCE_NAME
|
# Get the _common.sh file if it's not in the current directory
|
||||||
|
cp ../settings/scripts/_common.sh ./_common.sh
|
||||||
# Source app helpers
|
chmod a+rx _common.sh
|
||||||
|
fi
|
||||||
|
source _common.sh
|
||||||
source /usr/share/yunohost/helpers
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
# Retrieve app settings
|
#=================================================
|
||||||
domain=$(ynh_app_setting_get "$app" domain)
|
# MANAGE SCRIPT FAILURE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
# Copy the app files
|
# Exit if an error occurs during the execution of the script
|
||||||
final_path="/var/www/${app}"
|
ynh_abort_if_errors
|
||||||
ynh_backup "$final_path" "sources" 1
|
|
||||||
|
|
||||||
# Copy the nginx conf files
|
#=================================================
|
||||||
ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "nginx.conf"
|
# LOAD SETTINGS
|
||||||
# Copy the php-fpm conf files
|
#=================================================
|
||||||
ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" "php-fpm.conf"
|
|
||||||
ynh_backup "/etc/php5/fpm/conf.d/20-${app}.ini" "php-fpm.ini"
|
app=$YNH_APP_INSTANCE_NAME
|
||||||
|
|
||||||
|
final_path=$(ynh_app_setting_get $app final_path)
|
||||||
|
domain=$(ynh_app_setting_get $app domain)
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# STANDARD BACKUP STEPS
|
||||||
|
#=================================================
|
||||||
|
# BACKUP THE APP MAIN DIR
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# TODO taken from old "backup" script
|
||||||
|
#ynh_backup "$final_path" "sources" 1
|
||||||
|
ynh_backup "$final_path"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# BACKUP THE NGINX CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# BACKUP THE PHP-FPM CONFIGURATION
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_backup "/etc/php5/fpm/pool.d/$app.conf"
|
||||||
|
ynh_backup "/etc/php5/fpm/conf.d/20-$app.ini"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# BACKUP THE MYSQL DATABASE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_mysql_dump_db "$db_name" > db.sql
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SPECIFIC BACKUP
|
||||||
|
#=================================================
|
||||||
|
# BACKUP LOGROTATE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_backup "/etc/logrotate.d/$app"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# BACKUP SYSTEMD
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_backup "/etc/systemd/system/$app.service"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# BACKUP THE CRON FILE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_backup "/etc/cron.d/$app"
|
||||||
|
|
|
||||||
337
scripts/upgrade
337
scripts/upgrade
|
|
@ -1,128 +1,209 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
# Exit on command errors and treat unset variables as an error
|
#=================================================
|
||||||
set -eu
|
# GENERIC START
|
||||||
|
#=================================================
|
||||||
if [ ! -e .fonctions ]; then
|
# IMPORT GENERIC HELPERS
|
||||||
# Get file fonction if not been to the current directory
|
#=================================================
|
||||||
sudo cp ../settings/scripts/.fonctions ./.fonctions
|
|
||||||
sudo chmod a+rx .fonctions
|
source _common.sh
|
||||||
fi
|
source /usr/share/yunohost/helpers
|
||||||
# Loads the generic functions usually used in the script
|
|
||||||
source .fonctions
|
#=================================================
|
||||||
# Source app helpers
|
# LOAD SETTINGS
|
||||||
source /usr/share/yunohost/helpers
|
#=================================================
|
||||||
|
|
||||||
# This is a multi-instance app, meaning it can be installed several times independently
|
app=$YNH_APP_INSTANCE_NAME
|
||||||
# The id of the app as stated in the manifest is available as $YNH_APP_ID
|
|
||||||
# The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
|
domain=$(ynh_app_setting_get $app domain)
|
||||||
# The app instance name is available as $YNH_APP_INSTANCE_NAME
|
path_url=$(ynh_app_setting_get $app path)
|
||||||
# - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
|
admin=$(ynh_app_setting_get $app admin)
|
||||||
# - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
|
is_public=$(ynh_app_setting_get $app is_public)
|
||||||
# - ynhexample__{N} for the subsequent installations, with N=3,4, ...
|
final_path=$(ynh_app_setting_get $app final_path)
|
||||||
# The app instance name is probably what you are interested the most, since this is
|
|
||||||
# guaranteed to be unique. This is a good unique identifier to define installation path,
|
#=================================================
|
||||||
# db names, ...
|
# ENSURE DOWNWARD COMPATIBILITY
|
||||||
app=$YNH_APP_INSTANCE_NAME
|
#=================================================
|
||||||
|
|
||||||
# Retrieve app settings
|
# Fix is_public as a boolean value
|
||||||
domain=$(ynh_app_setting_get $app domain)
|
if [ "$is_public" = "Yes" ]; then
|
||||||
path=$(ynh_app_setting_get $app path)
|
ynh_app_setting_set $app is_public 1
|
||||||
admin=$(ynh_app_setting_get $app admin)
|
is_public=1
|
||||||
is_public=$(ynh_app_setting_get $app is_public)
|
elif [ "$is_public" = "No" ]; then
|
||||||
multisite=$(ynh_app_setting_get $app multisite)
|
ynh_app_setting_set $app is_public 0
|
||||||
|
is_public=0
|
||||||
# Remove trailing slash to path
|
fi
|
||||||
path=${path%/}
|
|
||||||
#force location to be / or /foo
|
# If final_path doesn't exist, create it
|
||||||
location=${path:-/}
|
if [ -z $final_path ]; then
|
||||||
|
final_path=/var/www/$app
|
||||||
# admin default value, if not set
|
ynh_app_setting_set $app final_path $final_path
|
||||||
if [ -z "$admin" ];
|
fi
|
||||||
then
|
|
||||||
admin=$(sudo yunohost user list | grep 'username' -m1 | awk '{print $2}')
|
# TODO Not sure if still needed ??
|
||||||
sudo ynh_app_setting_set $app is_public -v "$is_public"
|
# admin default value, if not set
|
||||||
fi
|
if [ -z "$admin" ]; then
|
||||||
|
admin=$(sudo yunohost user list | grep 'username' -m1 | awk '{print $2}')
|
||||||
# Create system user dedicace for this app
|
sudo ynh_app_setting_set $app is_public -v "$is_public"
|
||||||
ynh_system_user_create $app
|
fi
|
||||||
|
|
||||||
# Modify dokuwiki conf
|
#=================================================
|
||||||
sed -i "s@YNH_ADMIN_USER@$admin@g" ../conf/dokuwiki.php
|
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
|
||||||
|
#=================================================
|
||||||
# Copy files to the right place
|
|
||||||
final_path=/var/www/$app
|
# Backup the current version of the app
|
||||||
sudo mkdir -p $final_path
|
ynh_backup_before_upgrade
|
||||||
|
ynh_clean_setup () {
|
||||||
# Get source
|
# restore it if the upgrade fails
|
||||||
SETUP_SOURCE
|
ynh_restore_upgradebackup
|
||||||
|
}
|
||||||
sudo cp ../conf/dokuwiki.php $final_path/conf
|
# Exit if an error occurs during the execution of the script
|
||||||
|
ynh_abort_if_errors
|
||||||
# Do not override ACL configuration file
|
|
||||||
if [ ! -f "$final_path/conf/acl.auth.php" ]; then
|
#=================================================
|
||||||
sudo cp ../conf/acl.auth.php $final_path/conf
|
# CHECK THE PATH
|
||||||
fi
|
#=================================================
|
||||||
|
|
||||||
# Remove upgrade notification
|
# Normalize the URL path syntax
|
||||||
# See https://www.dokuwiki.org/update_check
|
path_url=$(ynh_normalize_url_path $path_url)
|
||||||
sudo touch $final_path/doku.php
|
|
||||||
|
#=================================================
|
||||||
# Remove deleted files
|
# STANDARD UPGRADE STEPS
|
||||||
# See https://www.dokuwiki.org/install:unused_files
|
#=================================================
|
||||||
if [ -f "../sources/data/deleted.files" ]; then
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
||||||
grep -Ev '^($|#)' ../sources/data/deleted.files | xargs -I {} sudo rm -vrf $final_path/{}
|
#=================================================
|
||||||
fi
|
|
||||||
|
# Download, check integrity, uncompress and patch the source from app.src
|
||||||
# Change owner for all plugins
|
ynh_setup_source "$final_path"
|
||||||
sudo chmod -R 755 $final_path/lib/plugins
|
|
||||||
|
#=================================================
|
||||||
# Update all plugins
|
# NGINX CONFIGURATION
|
||||||
for name_plugin in $(sudo -s cat $final_path/lib/plugins/*/plugin.info.txt | grep url | awk -F':' '{print $3}');
|
#=================================================
|
||||||
do
|
|
||||||
# Get a official plugin for dokuwiki, not update a no-official
|
# Create a dedicated nginx config
|
||||||
sudo wget -nv --quiet "https://github.com/splitbrain/dokuwiki-plugin-${name_plugin}/zipball/master" -O "${name_plugin}.zip" -o /dev/null || true
|
ynh_add_nginx_config
|
||||||
if [ -s "${name_plugin}.zip" ]; then
|
|
||||||
sudo unzip ${name_plugin}.zip
|
#=================================================
|
||||||
sudo cp -a splitbrain-dokuwiki-plugin-${name_plugin}*/. "${final_path}/lib/plugins/${name_plugin}/"
|
# CREATE DEDICATED USER
|
||||||
fi
|
#=================================================
|
||||||
done
|
|
||||||
|
# Create a system user
|
||||||
# Files owned by www-data can just read
|
ynh_system_user_create $app
|
||||||
sudo chown -R root: $final_path
|
|
||||||
|
#=================================================
|
||||||
# except for conf, data, some data subfolders, and lib/plugin, where dokuwiki must have write permissions
|
# PHP-FPM CONFIGURATION
|
||||||
if [ -d "${final_path}/data/media" ]; then
|
#=================================================
|
||||||
sudo chown -R $app:root $final_path/{data/attic,data/cache,data/index,data/locks,data/media*,data/meta,data/pages,data/tmp}
|
|
||||||
fi
|
# Create a dedicated php-fpm config
|
||||||
sudo chown -R $app:root $final_path/{conf,data,lib/plugins,lib/tpl}
|
ynh_add_fpm_config
|
||||||
sudo chmod -R 700 $final_path/conf
|
|
||||||
sudo chmod -R 700 $final_path/data
|
#=================================================
|
||||||
sudo chmod -R 755 $final_path/lib/plugins
|
# SPECIFIC UPGRADE
|
||||||
sudo chmod 755 $final_path/lib/tpl/{dokuwiki,dokuwiki/images}
|
#=================================================
|
||||||
|
|
||||||
# Modify Nginx configuration file and copy it to Nginx conf directory
|
# TODO Taken from old "upgrade" script. Should check if it is needed and what it does
|
||||||
sudo sed -i "s@__PATHTOCHANGE__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf
|
if [ -d "${final_path}/data/media" ]; then
|
||||||
sudo sed -i "s@__FINALPATH__@$final_path@g" /etc/nginx/conf.d/$domain.d/$app.conf
|
sudo chown -R $app:root $final_path/{data/attic,data/cache,data/index,data/locks,data/media*,data/meta,data/pages,data/tmp}
|
||||||
# sudo sed -i "s@__NAMETOCHANGE__@$app@g" /etc/nginx/conf.d/$domain.d/$app.conf
|
fi
|
||||||
sudo sed -i "s@fastcgi_pass unix:/var/run/php5-fpm.sock;@fastcgi_pass unix:/var/run/php5-fpm-${app}.sock;@g" /etc/nginx/conf.d/$domain.d/$app.conf
|
|
||||||
|
# Modify dokuwiki conf
|
||||||
if [ "$is_public" = "Yes" ];
|
#sed -i "s@YNH_ADMIN_USER@$admin@g" ../conf/dokuwiki.php
|
||||||
then
|
ynh_replace_string "YNH_ADMIN_USER" "$admin" "../conf/dokuwiki.php"
|
||||||
sudo sed -i "s@#--PRIVATE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf
|
sudo cp ../conf/dokuwiki.php $final_path/conf
|
||||||
fi
|
|
||||||
|
# Do not override ACL configuration file
|
||||||
# Create the php-fpm pool config
|
if [ ! -f "$final_path/conf/acl.auth.php" ]; then
|
||||||
POOL_FPM
|
sudo cp ../conf/acl.auth.php $final_path/conf
|
||||||
|
fi
|
||||||
# Set ssowat config
|
|
||||||
if [ "$is_public" = "Yes" ]; then
|
# Remove upgrade notification
|
||||||
ynh_app_setting_set $app is_public 1 # Fixe is_public en booléen
|
# See https://www.dokuwiki.org/update_check
|
||||||
is_public=1
|
sudo touch $final_path/doku.php
|
||||||
else
|
|
||||||
ynh_app_setting_set $app is_public 0
|
# Remove deleted files
|
||||||
is_public=0
|
# See https://www.dokuwiki.org/install:unused_files
|
||||||
fi
|
if [ -f "../sources/data/deleted.files" ]; then
|
||||||
|
grep -Ev '^($|#)' ../sources/data/deleted.files | xargs -I {} sudo rm -vrf $final_path/{}
|
||||||
sudo systemctl reload nginx
|
fi
|
||||||
sudo yunohost app ssowatconf
|
|
||||||
|
# Update all plugins
|
||||||
|
for name_plugin in $(sudo -s cat $final_path/lib/plugins/*/plugin.info.txt | grep url | awk -F':' '{print $3}');
|
||||||
|
do
|
||||||
|
# Get a official plugin for dokuwiki, not update a no-official
|
||||||
|
sudo wget -nv --quiet "https://github.com/splitbrain/dokuwiki-plugin-${name_plugin}/zipball/master" -O "${name_plugin}.zip" -o /dev/null || true
|
||||||
|
if [ -s "${name_plugin}.zip" ]; then
|
||||||
|
sudo unzip ${name_plugin}.zip
|
||||||
|
sudo cp -a splitbrain-dokuwiki-plugin-${name_plugin}*/. "${final_path}/lib/plugins/${name_plugin}/"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Verify the checksum and backup the file if it's different
|
||||||
|
ynh_backup_if_checksum_is_different "$final_path/CONFIG_FILE"
|
||||||
|
# Recalculate and store the config file checksum into the app settings
|
||||||
|
ynh_store_file_checksum "$final_path/CONFIG_FILE"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SETUP LOGROTATE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Use logrotate to manage app-specific logfile(s)
|
||||||
|
ynh_use_logrotate --non-append
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SETUP SYSTEMD
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Create a dedicated systemd config
|
||||||
|
ynh_add_systemd_config
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# GENERIC FINALIZATION
|
||||||
|
#=================================================
|
||||||
|
# SECURE FILES AND DIRECTORIES
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Files owned by dokuwiki can just read
|
||||||
|
chown -R root: $final_path
|
||||||
|
|
||||||
|
# except for conf, data, some data subfolders, and lib/plugin, where dokuwiki must have write permissions
|
||||||
|
#TODO compare rights with install script !!!
|
||||||
|
# Install script :
|
||||||
|
#sudo chown -R $app:root $final_path/{conf,data,data/attic,data/cache,data/index,data/locks,data/media*,data/meta,data/pages,data/tmp,lib/plugins,lib/tpl}
|
||||||
|
|
||||||
|
sudo chown -R $app:root $final_path/{conf,data,lib/plugins,lib/tpl}
|
||||||
|
sudo chmod -R 700 $final_path/conf
|
||||||
|
sudo chmod -R 700 $final_path/data
|
||||||
|
sudo chmod -R 755 $final_path/lib/plugins
|
||||||
|
sudo chmod 755 $final_path/lib/tpl/{dokuwiki,dokuwiki/images}
|
||||||
|
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SETUP SSOWAT
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
if [ $is_public -eq 0 ]
|
||||||
|
then # Remove the public access
|
||||||
|
ynh_app_setting_delete $app skipped_uris
|
||||||
|
fi
|
||||||
|
# Make app public if necessary
|
||||||
|
if [ $is_public -eq 1 ]
|
||||||
|
then
|
||||||
|
# unprotected_uris allows SSO credentials to be passed anyway
|
||||||
|
ynh_app_setting_set $app unprotected_uris "/"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# TODO: Still needed ??
|
||||||
|
#if [ "$is_public" = "Yes" ];
|
||||||
|
#then
|
||||||
|
# sudo sed -i "s@#--PRIVATE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf
|
||||||
|
#fi
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# RELOAD NGINX
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
systemctl reload nginx
|
||||||
|
# TODO
|
||||||
|
#sudo yunohost app ssowatconf
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue