mirror of
https://github.com/YunoHost-Apps/paperless-ngx_ynh.git
synced 2024-09-03 19:56:33 +02:00
226 lines
8.9 KiB
Bash
226 lines
8.9 KiB
Bash
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source _common.sh
|
|
source ynh_redis
|
|
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)
|
|
port=$(ynh_app_setting_get --app=$app --key=port)
|
|
admin=$(ynh_app_setting_get --app=$app --key=admin)
|
|
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
|
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
|
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
|
db_user=$db_name
|
|
db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
|
|
redis_db=$(ynh_app_setting_get --app=$app --key=redis_db)
|
|
paperless_secret_key=$(ynh_app_setting_get --app=$app --key=paperless_secret_key)
|
|
ocr_language=$(ynh_app_setting_get --app=$app --key=ocr_language)
|
|
|
|
#=================================================
|
|
# CHECK VERSION
|
|
#=================================================
|
|
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
|
|
#=================================================
|
|
# STOP SYSTEMD SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Stopping a systemd service..." --weight=1
|
|
|
|
ynh_systemd_action --service_name="$app" --action="stop" --log_path="/var/log/$app/$app.log"
|
|
ynh_systemd_action --service_name="$app-consumer" --action="stop" --log_path="/var/log/$app/$app-consumer.log"
|
|
ynh_systemd_action --service_name="$app-scheduler" --action="stop" --log_path="/var/log/$app/$app-scheduler.log"
|
|
ynh_systemd_action --service_name="$app-task-queue" --action="stop" --log_path="/var/log/$app/$app-task-queue.log"
|
|
|
|
#=================================================
|
|
# ENSURE DOWNWARD COMPATIBILITY
|
|
#=================================================
|
|
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
|
|
|
|
# If ocr_language doesn't exist, create it
|
|
if [ -z "$ocr_language" ]; then
|
|
ocr_language="eng"
|
|
ynh_app_setting_set --app=$app --key=ocr_language --value=$ocr_language
|
|
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
|
|
#=================================================
|
|
|
|
if [ "$upgrade_type" == "UPGRADE_APP" ]
|
|
then
|
|
ynh_script_progression --message="Upgrading source files..." --weight=1
|
|
|
|
ynh_setup_source --dest_dir="$final_path" --keep="paperless.conf"
|
|
fi
|
|
|
|
chmod 750 "$final_path"
|
|
chmod -R o-rwx "$final_path"
|
|
chown -R $app:$app "$final_path"
|
|
|
|
#=================================================
|
|
# UPGRADE DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading dependencies..." --weight=1
|
|
|
|
ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies $ocr_pkg_dependencies
|
|
|
|
#=================================================
|
|
# NGINX CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
|
|
|
|
# Create a dedicated NGINX config
|
|
ynh_add_nginx_config
|
|
|
|
#=================================================
|
|
# SPECIFIC UPGRADE
|
|
#=================================================
|
|
# INSTALL PYTHON DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Installing Python dependencies..."
|
|
|
|
pushd $final_path
|
|
python3 -m venv venv
|
|
chown -R "$app:" "$final_path"
|
|
(
|
|
source "$final_path/venv/bin/activate"
|
|
ynh_exec_as $app $final_path/venv/bin/pip3 install --upgrade pip setuptools wheel
|
|
ynh_exec_as $app $final_path/venv/bin/pip3 install -r "$final_path/requirements.txt"
|
|
|
|
# Installing NLTK data
|
|
ynh_secure_remove --file="$final_path/nltk_data"
|
|
mkdir -p "$final_path/nltk_data"
|
|
chown -R "$app:" "$final_path/nltk_data"
|
|
ynh_exec_warn_less ynh_exec_as $app $final_path/venv/bin/python3 -m nltk.downloader -d "$final_path/nltk_data" snowball_data
|
|
ynh_exec_warn_less ynh_exec_as $app $final_path/venv/bin/python3 -m nltk.downloader -d "$final_path/nltk_data" stopwords
|
|
ynh_exec_warn_less ynh_exec_as $app $final_path/venv/bin/python3 -m nltk.downloader -d "$final_path/nltk_data" punkt
|
|
|
|
deactivate
|
|
)
|
|
popd
|
|
|
|
#=================================================
|
|
# UPDATE A CONFIG FILE
|
|
#=================================================
|
|
ynh_script_progression --message="Updating a configuration file..." --weight=1
|
|
|
|
ynh_add_config --template="paperless.conf.example" --destination="$final_path/paperless.conf"
|
|
|
|
chmod 400 "$final_path/paperless.conf"
|
|
chown $app:$app "$final_path/paperless.conf"
|
|
|
|
#=================================================
|
|
# SETUP THE DATABASE
|
|
#=================================================
|
|
ynh_script_progression --message="Setting up the database..." --weight=1
|
|
|
|
pushd "$final_path/src"
|
|
(
|
|
source "$final_path/venv/bin/activate"
|
|
ynh_exec_as $app $final_path/venv/bin/python manage.py migrate
|
|
deactivate
|
|
)
|
|
popd
|
|
|
|
#=================================================
|
|
# SETUP SYSTEMD
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading systemd configuration..." --weight=1
|
|
|
|
# Create a dedicated systemd config
|
|
ynh_add_systemd_config --service="$app" --template="systemd.service"
|
|
ynh_add_systemd_config --service="$app-consumer" --template="systemd-consumer.service"
|
|
ynh_add_systemd_config --service="$app-scheduler" --template="systemd-scheduler.service"
|
|
ynh_add_systemd_config --service="$app-task-queue" --template="systemd-task-queue.service"
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SETUP LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1
|
|
|
|
# Use logrotate to manage app-specific logfile(s)
|
|
ynh_use_logrotate --logfile="/var/log/$app/$app.log"
|
|
ynh_use_logrotate --logfile="/var/log/$app/$app-consumer.log"
|
|
ynh_use_logrotate --logfile="/var/log/$app/$app-scheduler.log"
|
|
ynh_use_logrotate --logfile="/var/log/$app/$app-task-queue.log"
|
|
|
|
#=================================================
|
|
# INTEGRATE SERVICE IN YUNOHOST
|
|
#=================================================
|
|
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
|
|
|
|
yunohost service add "$app" --log="/var/log/$app/$app.log"
|
|
yunohost service add "$app-consumer" --log="/var/log/$app/$app-consumer.log"
|
|
yunohost service add "$app-scheduler" --log="/var/log/$app/$app-scheduler.log"
|
|
yunohost service add "$app-task-queue" --log="/var/log/$app/$app-task-queue.log"
|
|
|
|
#=================================================
|
|
# START SYSTEMD SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Starting a systemd service..." --weight=1
|
|
|
|
ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log"
|
|
ynh_systemd_action --service_name="$app-consumer" --action="start" --log_path="/var/log/$app/$app-consumer.log"
|
|
ynh_systemd_action --service_name="$app-scheduler" --action="start" --log_path="/var/log/$app/$app-scheduler.log"
|
|
ynh_systemd_action --service_name="$app-task-queue" --action="start" --log_path="/var/log/$app/$app-task-queue.log"
|
|
|
|
#=================================================
|
|
# UPGRADE FAIL2BAN
|
|
#=================================================
|
|
#ynh_script_progression --message="Reconfiguring Fail2Ban..." --weight=1
|
|
|
|
# Create a dedicated Fail2Ban config
|
|
#ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
|
|
|
|
#=================================================
|
|
# RELOAD NGINX
|
|
#=================================================
|
|
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
|
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Upgrade of $app completed" --last
|