mirror of
https://github.com/YunoHost-Apps/funkwhale_ynh.git
synced 2024-09-03 18:36:24 +02:00
fa9587f61e
* Update README.md * Test bump to 1.0 * Bump to Yunohost 4 (for Debian upgrade) * Test removal of nonexistent scripts * Correct Typo * Update README.md * Fix linter warnings * Fix linter * Fix linter warnings * Cleaning up * Update README.md * Update to 1.0.1 (#119) * Update to 1.0.1 * Set new permissions * Add French Readme * Readme update * Update README.md * Update README.md * Update README_fr.md * Update README.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Update README_fr.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Update README.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Update README_fr.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Finding an available port * Uprade to 1.1 and fixes Twisted by retrograding it (#129) * Fix linter warning : no need to use $is_public * Clarify custom paths needed to import collections of music files in Readme. (#134) * Update readme to indicate custom import path Yunohost installations of Funkwhale use a different path for file imports than those indicated in the Funkwhale documentation.. (/var/www/Funkwhale/import). We should therefore indicate to the admin user what that path is, and steps necessary to use it. Addresses #132. * Fix bash highlighting. * Update README.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Apply Example_ynh (#131) * Testing (#130) * Uprade to 1.1 and fixes Twisted by retrograding it (#129) * Apply example_ynh Fix #15 * Fix services * Fix several merging * Stick to official install process * fix path_transversal * Using option '--log_type systemd' with 'yunohost service add' is not relevant anymore * Try to fix package_check * Fix package_check test * Update check_process * Trying to fix package_check * Update env.prod * remove sleep * Better service name * missing datadir * line 111: upgrade_type: unbound variable * Implement --is_big * Fix stopping service from previous version * Fix upgrade * Fix upgrade * Apply example_ynh * Apply example_ynh * Fix rights * Update api.src * Update env.prod * Update front.src * Update manifest.json * Update README.md * Update README_fr.md * Fix chmod * Fix rights Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Update conf/nginx.conf Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> * Update conf/nginx.conf Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> * fix * Fix rights for datadir from previous version * Update upgrade * Fix recursive chmod * Fix import link * Update README_fr.md Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> Co-authored-by: Ciarán Ainsworth <cda@rootkey.co.uk> Co-authored-by: Ciarán Ainsworth <ciaranainsworth@posteo.net> Co-authored-by: ericgaspar <junk.eg@free.fr> Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> Co-authored-by: Amos Blanton <lightnin@users.noreply.github.com>
312 lines
11 KiB
Bash
312 lines
11 KiB
Bash
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source _common.sh
|
|
source /usr/share/yunohost/helpers
|
|
|
|
#=================================================
|
|
# LOAD SETTINGS
|
|
#=================================================
|
|
ynh_script_progression --message="Loading installation settings..."
|
|
|
|
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
|
|
db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
|
|
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
|
|
port=$(ynh_app_setting_get --app=$app --key=port)
|
|
redis_db=$(ynh_app_setting_get --app=$app --key=redis_db)
|
|
key=$(ynh_app_setting_get --app=$app --key=key)
|
|
|
|
#=================================================
|
|
# CHECK VERSION
|
|
#=================================================
|
|
ynh_script_progression --message="Checking version..."
|
|
|
|
upgrade_type=$(ynh_check_app_version_changed)
|
|
|
|
#=================================================
|
|
# ENSURE DOWNWARD COMPATIBILITY
|
|
#=================================================
|
|
ynh_script_progression --message="Ensuring downward compatibility..."
|
|
|
|
# If redis_db doesn't exist, create it
|
|
if [ -z "$redis_db" ]; then
|
|
redis_db=$(ynh_redis_get_free_db)
|
|
ynh_app_setting_set --app=$app --key=redis_db --value=$redis_db
|
|
fi
|
|
|
|
# If db_pwd doesn't exist, create it
|
|
if [ -z "$db_pwd" ]; then
|
|
db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
|
|
ynh_app_setting_set --app=$app --key=db_pwd --value=$db_pwd
|
|
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
|
|
|
|
# Cleaning legacy permissions
|
|
if ynh_legacy_permissions_exists; then
|
|
ynh_legacy_permissions_delete_all
|
|
|
|
ynh_app_setting_delete --app=$app --key=is_public
|
|
fi
|
|
|
|
#=================================================
|
|
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
|
|
#=================================================
|
|
ynh_script_progression --message="Backing up the app before upgrading (may take a while)..."
|
|
|
|
# Backup the current version of the app
|
|
ynh_backup_before_upgrade
|
|
ynh_clean_setup () {
|
|
# Restore it if the upgrade fails
|
|
ynh_clean_check_starting
|
|
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..."
|
|
|
|
ynh_systemd_action --action="stop" --service_name="${app}-beat" --log_path="systemd" --line_match="Stopped"
|
|
ynh_systemd_action --action="stop" --service_name="${app}-server" --log_path="systemd" --line_match="Stopped"
|
|
ynh_systemd_action --action="stop" --service_name="${app}-worker" --log_path="systemd" --line_match="Stopped"
|
|
|
|
#=================================================
|
|
# MOVE DATAS
|
|
#=================================================
|
|
|
|
# If datadir doesn't exist, create it
|
|
if [ -z "$datadir" ]; then
|
|
# Do a full backup before moving datas
|
|
yunohost backup create --apps $app
|
|
|
|
datadir="/home/yunohost.app/${app}/data"
|
|
ynh_script_progression --message="Moving datas to $datadir..."
|
|
|
|
mkdir -p $datadir
|
|
pushd $datadir
|
|
mkdir -p static media music
|
|
popd
|
|
|
|
chmod 750 "$datadir"
|
|
chmod -R o-rwx "$datadir"
|
|
chown -R $app:www-data "$datadir"
|
|
|
|
ynh_backup_if_checksum_is_different --file="$final_path/code/config/.env"
|
|
mkdir -p $final_path/config
|
|
rsync -a $final_path/code/config/ $final_path/config/
|
|
chmod 400 $final_path/config/.env
|
|
ynh_store_file_checksum --file="$final_path/config/.env"
|
|
ynh_delete_file_checksum --file="$final_path/code/config/.env"
|
|
|
|
if [ -d "$final_path/code/data/static/" ]; then
|
|
rsync -a $final_path/code/data/static/ $datadir/static/
|
|
fi
|
|
if [ -d "$final_path/media/" ]; then
|
|
rsync -a $final_path/media/ $datadir/media/
|
|
fi
|
|
if [ -d "$final_path/code/data/media/" ]; then
|
|
rsync -a $final_path/code/data/media/ $datadir/media/
|
|
fi
|
|
if [ -d "$final_path/import/" ]; then
|
|
rsync -a $final_path/import/ $datadir/music/
|
|
fi
|
|
if [ -d "$final_path/code/data/music/" ]; then
|
|
rsync -a $final_path/code/data/music/ $datadir/music/
|
|
fi
|
|
|
|
ynh_secure_remove --file="$final_path/code"
|
|
ynh_secure_remove --file="$final_path/media"
|
|
ynh_secure_remove --file="$final_path/code/data/media"
|
|
ynh_secure_remove --file="$final_path/import"
|
|
ynh_secure_remove --file="$final_path/code/data/music"
|
|
|
|
ynh_app_setting_set --app=$app --key=datadir --value=$datadir
|
|
|
|
chmod 750 "$datadir"
|
|
chmod -R o-rwx "$datadir"
|
|
chown -R $app:www-data "$datadir"
|
|
|
|
upgrade_type="UPGRADE_APP"
|
|
fi
|
|
|
|
#=================================================
|
|
# CREATE DEDICATED USER
|
|
#=================================================
|
|
ynh_script_progression --message="Making sure dedicated system user exists..."
|
|
|
|
# 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..."
|
|
|
|
ynh_secure_remove --file="$final_path/api"
|
|
ynh_secure_remove --file="$final_path/front"
|
|
# Download, check integrity, uncompress and patch the source from app.src
|
|
ynh_setup_source --dest_dir="$final_path/api" --source_id="api"
|
|
ynh_setup_source --dest_dir="$final_path/front" --source_id="front"
|
|
fi
|
|
|
|
chmod 750 "$final_path"
|
|
chmod -R o-rwx "$final_path"
|
|
chown -R $app:www-data "$final_path"
|
|
|
|
#=================================================
|
|
# NGINX CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading NGINX web server configuration..."
|
|
|
|
# Create a dedicated NGINX config
|
|
ynh_add_nginx_config "datadir"
|
|
|
|
#=================================================
|
|
# UPGRADE DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading dependencies..."
|
|
|
|
ynh_install_app_dependencies $pkg_dependencies
|
|
|
|
#=================================================
|
|
# SPECIFIC UPGRADE
|
|
#=================================================
|
|
# INSTALL PYTHON DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Installing Python dependencies..."
|
|
|
|
pushd $final_path
|
|
ynh_secure_remove --file="$final_path/virtualenv"
|
|
python3 -m venv $final_path/virtualenv
|
|
source $final_path/virtualenv/bin/activate
|
|
pip install --upgrade pip
|
|
pip install --upgrade setuptools
|
|
pip install wheel
|
|
pip install -r api/requirements.txt
|
|
popd
|
|
|
|
#=================================================
|
|
# UPDATE A CONFIG FILE
|
|
#=================================================
|
|
ynh_script_progression --message="Updating a config file..."
|
|
|
|
ynh_add_config --template="../conf/env.prod" --destination="$final_path/config/.env"
|
|
|
|
chmod 400 "$final_path/config/.env"
|
|
chown $app:$app "$final_path/config/.env"
|
|
|
|
#=================================================
|
|
# UPGRADE FUNKWHALE
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading Funkwhale..."
|
|
|
|
pushd $final_path
|
|
source $final_path/virtualenv/bin/activate
|
|
|
|
# needed for enabling the 'unaccent' extension
|
|
ynh_psql_execute_as_root --sql="ALTER USER $db_user WITH SUPERUSER;" --database="$db_name"
|
|
python api/manage.py migrate
|
|
ynh_psql_execute_as_root --sql="ALTER USER $db_user WITH NOSUPERUSER;" --database="$db_name"
|
|
|
|
echo "yes" | python api/manage.py collectstatic --clear --noinput
|
|
|
|
# https://code.eliotberriot.com/funkwhale/funkwhale/tags/0.16 # users-now-have-an-activitypub-actor-manual-action-required
|
|
# python api/manage.py script create_actors --no-input
|
|
# https://code.eliotberriot.com/funkwhale/funkwhale/tags/0.16 #image-thumbnails-manual-action-required
|
|
# python api/manage.py script create_image_variations --no-input
|
|
|
|
# https://docs.funkwhale.audio/upgrading/0.17.html#upgrade-instructions
|
|
# python api/manage.py script migrate_to_user_libraries --no-input
|
|
|
|
# Delete pre 0.17 federated tracks [manual action suggested]
|
|
# https://dev.funkwhale.audio/funkwhale/funkwhale/tags/0.18
|
|
# python api/manage.py script delete_pre_017_federated_uploads --no-input
|
|
|
|
# Delete the original thumbnails and generate new ones for
|
|
# higher quality images
|
|
# https://docs.funkwhale.audio/changelog.html#increased-quality-of-jpeg-thumbnails-manual-action-required
|
|
ynh_secure_remove --file="$final_path/media/__sized__"
|
|
python api/manage.py fw media generate-thumbnails
|
|
popd
|
|
|
|
chmod 750 "$final_path"
|
|
chmod -R o-rwx "$final_path"
|
|
chown -R $app:www-data "$final_path"
|
|
|
|
#=================================================
|
|
# SETUP SYSTEMD
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading systemd configuration..."
|
|
|
|
ynh_add_config --template="../conf/funkwhale.target" --destination="/etc/systemd/system/$app.target"
|
|
|
|
# Create a dedicated systemd config
|
|
ynh_add_systemd_config --service="${app}-server" --template="funkwhale-server.service" --others_var="datadir"
|
|
ynh_add_systemd_config --service="${app}-worker" --template="funkwhale-worker.service" --others_var="datadir"
|
|
ynh_add_systemd_config --service="${app}-beat" --template="funkwhale-beat.service" --others_var="datadir"
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# INTEGRATE SERVICE IN YUNOHOST
|
|
#=================================================
|
|
ynh_script_progression --message="Integrating service in YunoHost..."
|
|
|
|
yunohost service add "${app}-beat"
|
|
yunohost service add "${app}-server"
|
|
yunohost service add "${app}-worker"
|
|
|
|
#=================================================
|
|
# START SYSTEMD SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Starting a systemd service..."
|
|
|
|
# Start a systemd service
|
|
ynh_systemd_action --service_name="${app}-beat" --action="start" --log_path="systemd" --line_match="Running with the following plugins enabled"
|
|
ynh_systemd_action --service_name="${app}-server" --action="start" --log_path="systemd" --line_match="Application startup complete"
|
|
ynh_systemd_action --service_name="${app}-worker" --action="start" --log_path="systemd" --line_match="Running with the following plugins enabled"
|
|
|
|
#=================================================
|
|
# UPGRADE FAIL2BAN
|
|
#=================================================
|
|
ynh_script_progression --message="Reconfiguring Fail2Ban..."
|
|
|
|
# Create a dedicated Fail2Ban config
|
|
ynh_add_fail2ban_config --logpath="/var/log/nginx/$domain-access.log" --failregex="<HOST>.* \"POST /api/v1/token/ HTTP/1.1\" 400 68.*$" --max_retry=5
|
|
|
|
#=================================================
|
|
# RELOAD NGINX
|
|
#=================================================
|
|
ynh_script_progression --message="Reloading NGINX web server..."
|
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Upgrade of $app completed"
|