mirror of
https://github.com/YunoHost-Apps/vaultwarden_ynh.git
synced 2024-09-03 18:26:31 +02:00
Merge pull request #141 from YunoHost-Apps/testing
Migration from bitwarden to vaultwarden
This commit is contained in:
commit
703d5a9cb8
13 changed files with 440 additions and 72 deletions
|
@ -8,7 +8,7 @@ about: When creating a bug report, please use the following template to provide
|
||||||
1. *Read this whole template first.*
|
1. *Read this whole template first.*
|
||||||
2. *Determine if you are on the right place:*
|
2. *Determine if you are on the right place:*
|
||||||
- *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!*
|
- *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!*
|
||||||
- *Otherwise, the issue may be due to vaultwarden itself. Refer to its documentation or repository for help.*
|
- *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.*
|
||||||
- *When in doubt, post here and we will figure it out together.*
|
- *When in doubt, post here and we will figure it out together.*
|
||||||
3. *Delete the italic comments as you write over them below, and remove this guide.*
|
3. *Delete the italic comments as you write over them below, and remove this guide.*
|
||||||
---
|
---
|
||||||
|
@ -31,7 +31,7 @@ about: When creating a bug report, please use the following template to provide
|
||||||
|
|
||||||
- *If you performed a command from the CLI, the command itself is enough. For example:*
|
- *If you performed a command from the CLI, the command itself is enough. For example:*
|
||||||
```sh
|
```sh
|
||||||
sudo yunohost app install vaultwarden
|
sudo yunohost app install the_app
|
||||||
```
|
```
|
||||||
- *If you used the webadmin, please perform the equivalent command from the CLI first.*
|
- *If you used the webadmin, please perform the equivalent command from the CLI first.*
|
||||||
- *If the error occurs in your browser, explain what you did:*
|
- *If the error occurs in your browser, explain what you did:*
|
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,16 @@
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
- *Description of why you made this PR*
|
||||||
|
|
||||||
|
## Solution
|
||||||
|
|
||||||
|
- *And how do you fix that problem*
|
||||||
|
|
||||||
|
## PR Status
|
||||||
|
|
||||||
|
- [ ] Code finished and ready to be reviewed/tested
|
||||||
|
- [ ] The fix/enhancement were manually tested (if applicable)
|
||||||
|
|
||||||
|
## Automatic tests
|
||||||
|
|
||||||
|
Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization)
|
13
README.md
13
README.md
|
@ -52,6 +52,19 @@ How to configure this app: by an admin panel at https://vaultwarden.domain.tld/a
|
||||||
* Upstream app repository: https://github.com/dani-garcia/vaultwarden
|
* Upstream app repository: https://github.com/dani-garcia/vaultwarden
|
||||||
* YunoHost website: https://yunohost.org/
|
* YunoHost website: https://yunohost.org/
|
||||||
|
|
||||||
|
## Migrate from Bitwarden
|
||||||
|
|
||||||
|
This package handle the migration from Bitwarden to Vaultwarden.
|
||||||
|
For that, you will have to upgrade your Bitwarden application with this repository.
|
||||||
|
This can only be done from the command-line interface - e.g. through SSH.
|
||||||
|
Once you're connected, you simply have to execute the following:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo yunohost app upgrade bitwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
The `--debug` option will let you see the full output. If you encounter any issue, please paste it.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
|
@ -19,6 +19,8 @@
|
||||||
upgrade=1
|
upgrade=1
|
||||||
# Bitwarden 1.20.0~ynh4
|
# Bitwarden 1.20.0~ynh4
|
||||||
#upgrade=1 from_commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db
|
#upgrade=1 from_commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db
|
||||||
|
# 1.21.0~ynh1
|
||||||
|
upgrade=1 from_commit=3f7d7d2740a1cb3f16a290b64c89e84422d06ede
|
||||||
backup_restore=1
|
backup_restore=1
|
||||||
multi_instance=1
|
multi_instance=1
|
||||||
port_already_use=0
|
port_already_use=0
|
||||||
|
@ -28,4 +30,6 @@ Email=yalh@yahoo.com
|
||||||
Notification=all
|
Notification=all
|
||||||
;;; Upgrade options
|
;;; Upgrade options
|
||||||
; commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db
|
; commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db
|
||||||
name=1.20.0~ynh4
|
name=Bitwarden 1.20.0~ynh4
|
||||||
|
; commit=3f7d7d2740a1cb3f16a290b64c89e84422d06ede
|
||||||
|
name=1.21.0~ynh1
|
||||||
|
|
15
conf/bitwarden_migration
Normal file
15
conf/bitwarden_migration
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
# App main directory
|
||||||
|
/var/www/$app
|
||||||
|
|
||||||
|
# NGINX web server configuration
|
||||||
|
/etc/nginx/conf.d/$domain.d/$app.conf
|
||||||
|
|
||||||
|
# App logs
|
||||||
|
/var/log/$app/
|
||||||
|
|
||||||
|
# Service configuration
|
||||||
|
/etc/systemd/system/$app.service
|
||||||
|
|
||||||
|
# Fail2Ban configuration
|
||||||
|
/etc/fail2ban/jail.d/$app.conf
|
||||||
|
/etc/fail2ban/filter.d/$app.conf
|
38
conf/bitwarden_post_migration.sh
Normal file
38
conf/bitwarden_post_migration.sh
Normal file
|
@ -0,0 +1,38 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Ending the migration process from Bitwarden to Vaultwarden
|
||||||
|
|
||||||
|
set -u
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# IMPORT GENERIC HELPERS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# SET VARIABLES
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
old_app="__OLD_APP__"
|
||||||
|
new_app="__NEW_APP__"
|
||||||
|
script_name="$0"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# DELETE OLD APP'S SETTINGS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_secure_remove --file="/etc/yunohost/apps/$old_app"
|
||||||
|
yunohost app ssowatconf
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# REMOVE THE OLD USER
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_system_user_delete --username="$old_app"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# DELETE THIS SCRIPT
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
echo "rm $script_name" | at now + 1 minutes
|
|
@ -6,14 +6,14 @@
|
||||||
"en": "Manage passwords and other sensitive informations",
|
"en": "Manage passwords and other sensitive informations",
|
||||||
"fr": "Gérez les mots de passe et autres informations sensibles"
|
"fr": "Gérez les mots de passe et autres informations sensibles"
|
||||||
},
|
},
|
||||||
"version": "1.21.0~ynh1",
|
"version": "1.21.0~ynh2",
|
||||||
"url": "https://github.com/dani-garcia/vaultwarden",
|
"url": "https://github.com/dani-garcia/vaultwarden",
|
||||||
"license": "GPL-3.0-or-later",
|
"license": "GPL-3.0-or-later",
|
||||||
"maintainer": {
|
"maintainer": {
|
||||||
"name": "yalh76"
|
"name": "yalh76"
|
||||||
},
|
},
|
||||||
"requirements": {
|
"requirements": {
|
||||||
"yunohost": ">= 4.1.7.3"
|
"yunohost": ">= 4.2.0"
|
||||||
},
|
},
|
||||||
"multi_instance": true,
|
"multi_instance": true,
|
||||||
"services": [
|
"services": [
|
||||||
|
|
|
@ -1,16 +0,0 @@
|
||||||
## Problem
|
|
||||||
- *Description of why you made this PR*
|
|
||||||
|
|
||||||
## Solution
|
|
||||||
- *And how do you fix that problem*
|
|
||||||
|
|
||||||
## PR Status
|
|
||||||
- [ ] Code finished.
|
|
||||||
- [ ] Tested with Package_check.
|
|
||||||
- [ ] Fix or enhancement tested.
|
|
||||||
- [ ] Upgrade from last version tested.
|
|
||||||
- [ ] Can be reviewed and tested.
|
|
||||||
|
|
||||||
## Package_check results
|
|
||||||
---
|
|
||||||
* An automatic package_check will be launch at https://ci-apps-dev.yunohost.org/, when you add a specific comment to your Pull Request: "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!"*
|
|
|
@ -217,8 +217,6 @@ ynh_systemd_action --service_name=nginx --action=reload
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_script_progression --message="Sending a readme for the admin..."
|
ynh_script_progression --message="Sending a readme for the admin..."
|
||||||
|
|
||||||
ynh_add_config --template="../conf/message" --destination="../conf/msg_install"
|
|
||||||
|
|
||||||
ynh_send_readme_to_admin --app_message="../conf/msg_install" --recipients="$admin_mail" --type='install'
|
ynh_send_readme_to_admin --app_message="../conf/msg_install" --recipients="$admin_mail" --type='install'
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
105
scripts/upgrade
105
scripts/upgrade
|
@ -7,6 +7,7 @@
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
||||||
source _common.sh
|
source _common.sh
|
||||||
|
source ynh_handle_app_migration
|
||||||
source /usr/share/yunohost/helpers
|
source /usr/share/yunohost/helpers
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
|
@ -32,28 +33,6 @@ ynh_script_progression --message="Checking version..."
|
||||||
|
|
||||||
upgrade_type=$(ynh_check_app_version_changed)
|
upgrade_type=$(ynh_check_app_version_changed)
|
||||||
|
|
||||||
#=================================================
|
|
||||||
# ENSURE DOWNWARD COMPATIBILITY
|
|
||||||
#=================================================
|
|
||||||
ynh_script_progression --message="Ensuring downward compatibility..."
|
|
||||||
|
|
||||||
# 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
|
|
||||||
ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin --show_tile="false"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Create a permission if needed
|
|
||||||
if ! ynh_permission_exists --permission="api"; then
|
|
||||||
ynh_permission_create --permission="api" --url="/api" --additional_urls="/identity/connect/token" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
|
|
||||||
fi
|
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
|
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
|
||||||
#=================================================
|
#=================================================
|
||||||
|
@ -78,7 +57,60 @@ ynh_remove_logrotate
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_script_progression --message="Stopping a systemd service..."
|
ynh_script_progression --message="Stopping a systemd service..."
|
||||||
|
|
||||||
ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --line_match="Stopped vaultwarden Server"
|
ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --line_match="Stopped"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# HANDLE MIGRATION FROM BITWARDEN
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
ynh_handle_app_migration --migration_id="bitwarden" --migration_list="bitwarden_migration"
|
||||||
|
|
||||||
|
if [ $migration_process -eq 1 ]
|
||||||
|
then
|
||||||
|
# If a migration has been perform
|
||||||
|
# Reload some values changed by the migration process
|
||||||
|
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
||||||
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
||||||
|
|
||||||
|
# Move config file
|
||||||
|
mv $final_path/live/bitwarden_rs.env $final_path/live/vaultwarden.env
|
||||||
|
ynh_delete_file_checksum --file="/var/www/$old_app/live/bitwarden_rs.env"
|
||||||
|
ynh_store_file_checksum --file="$final_path/live/vaultwarden.env"
|
||||||
|
ynh_secure_remove --file="$final_path/live/bitwarden_rs"
|
||||||
|
|
||||||
|
# Manage permissions
|
||||||
|
ynh_permission_update --permission="main" --add="all_users"
|
||||||
|
ynh_permission_update --permission="main" --add="visitors"
|
||||||
|
|
||||||
|
# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
|
||||||
|
if ynh_exec_warn_less yunohost service status $old_app >/dev/null
|
||||||
|
then
|
||||||
|
ynh_script_progression --message="Removing $old_app service integration..."
|
||||||
|
yunohost service remove $old_app
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# ENSURE DOWNWARD COMPATIBILITY
|
||||||
|
#=================================================
|
||||||
|
ynh_script_progression --message="Ensuring downward compatibility..."
|
||||||
|
|
||||||
|
# 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
|
||||||
|
ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin --show_tile="false"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Create a permission if needed
|
||||||
|
if ! ynh_permission_exists --permission="api"; then
|
||||||
|
ynh_permission_create --permission="api" --url="/api" --additional_urls="/identity/connect/token" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
|
||||||
|
fi
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# CREATE DEDICATED USER
|
# CREATE DEDICATED USER
|
||||||
|
@ -169,13 +201,6 @@ fi
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_script_progression --message="Updating a config file..."
|
ynh_script_progression --message="Updating a config file..."
|
||||||
|
|
||||||
# Manage app name change
|
|
||||||
if test -f "$final_path/live/bitwarden_rs.env"; then
|
|
||||||
mv -a "$final_path/live/bitwarden_rs.env" "$final_path/live/vaultwarden.env"
|
|
||||||
ynh_delete_file_checksum --file="$final_path/live/bitwarden_rs.env"
|
|
||||||
ynh_store_file_checksum --file="$final_path/live/vaultwarden.env"
|
|
||||||
fi
|
|
||||||
|
|
||||||
ynh_add_config --template="../conf/vaultwarden.env" --destination="$final_path/live/vaultwarden.env"
|
ynh_add_config --template="../conf/vaultwarden.env" --destination="$final_path/live/vaultwarden.env"
|
||||||
|
|
||||||
chmod 400 "$final_path/live/vaultwarden.env"
|
chmod 400 "$final_path/live/vaultwarden.env"
|
||||||
|
@ -210,6 +235,8 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --l
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_script_progression --message="Reconfiguring Fail2Ban..."
|
ynh_script_progression --message="Reconfiguring Fail2Ban..."
|
||||||
|
|
||||||
|
mkdir -p "/var/log/$app"
|
||||||
|
touch /var/log/"$app"/"$app".log
|
||||||
# Create a dedicated Fail2Ban config
|
# Create a dedicated Fail2Ban config
|
||||||
ynh_add_fail2ban_config --logpath="/var/log/$app/$app.log" --failregex="^.*Username or password is incorrect\. Try again\. IP: <HOST>\. Username:.*$"
|
ynh_add_fail2ban_config --logpath="/var/log/$app/$app.log" --failregex="^.*Username or password is incorrect\. Try again\. IP: <HOST>\. Username:.*$"
|
||||||
|
|
||||||
|
@ -220,6 +247,24 @@ ynh_script_progression --message="Reloading NGINX web server..."
|
||||||
|
|
||||||
ynh_systemd_action --service_name=nginx --action=reload
|
ynh_systemd_action --service_name=nginx --action=reload
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# FINISH MIGRATION PROCESS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
if [ $migration_process -eq 1 ]
|
||||||
|
then
|
||||||
|
ynh_script_progression --message="Bitwarden has been successfully migrated to Vaultwarden! \
|
||||||
|
A last scheduled operation will run in a couple of minutes to finish the \
|
||||||
|
migration in YunoHost side. Do not proceed any application operation while \
|
||||||
|
you don't see Vaultwarden as installed."
|
||||||
|
script_post_migration=bitwarden_post_migration.sh
|
||||||
|
cp ../conf/$script_post_migration /tmp
|
||||||
|
ynh_replace_string --match_string="__OLD_APP__" --replace_string="$old_app" --target_file=/tmp/$script_post_migration
|
||||||
|
ynh_replace_string --match_string="__NEW_APP__" --replace_string="$app" --target_file=/tmp/$script_post_migration
|
||||||
|
chmod +x /tmp/$script_post_migration
|
||||||
|
(cd /tmp; echo "/tmp/$script_post_migration > /tmp/$script_post_migration.log 2>&1" | at now + 2 minutes)
|
||||||
|
fi
|
||||||
|
|
||||||
#=================================================
|
#=================================================
|
||||||
# END OF SCRIPT
|
# END OF SCRIPT
|
||||||
#=================================================
|
#=================================================
|
||||||
|
|
266
scripts/ynh_handle_app_migration
Normal file
266
scripts/ynh_handle_app_migration
Normal file
|
@ -0,0 +1,266 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Need also the helper https://github.com/YunoHost-Apps/Experimental_helpers/blob/master/ynh_handle_getopts_args/ynh_handle_getopts_args
|
||||||
|
|
||||||
|
# Make the main steps to migrate an app to its fork.
|
||||||
|
#
|
||||||
|
# This helper has to be used for an app which needs to migrate to a new name or a new fork
|
||||||
|
# (like owncloud to nextcloud or zerobin to privatebin).
|
||||||
|
#
|
||||||
|
# This helper will move the files of an app to its new name
|
||||||
|
# or recreate the things it can't move.
|
||||||
|
#
|
||||||
|
# To specify which files it has to move, you have to create a "migration file", stored in ../conf
|
||||||
|
# This file is a simple list of each file it has to move,
|
||||||
|
# except that file names must reference the $app variable instead of the real name of the app,
|
||||||
|
# and every instance-specific variables (like $domain).
|
||||||
|
# $app is especially important because it's this variable which will be used to identify the old place and the new one for each file.
|
||||||
|
#
|
||||||
|
# If a database exists for this app, it will be dumped and then imported in a newly created database, with a new name and new user.
|
||||||
|
# Don't forget you have to then apply these changes to application-specific settings (depends on the packaged application)
|
||||||
|
#
|
||||||
|
# Same things for an existing user, a new one will be created.
|
||||||
|
# But the old one can't be removed unless it's not used. See below.
|
||||||
|
#
|
||||||
|
# If you have some dependencies for your app, it's possible to change the fake debian package which manages them.
|
||||||
|
# You have to fill the $pkg_dependencies variable, and then a new fake package will be created and installed,
|
||||||
|
# and the old one will be removed.
|
||||||
|
# If you don't have a $pkg_dependencies variable, the helper can't know what the app dependencies are.
|
||||||
|
#
|
||||||
|
# The app settings.yml will be modified as follows:
|
||||||
|
# - finalpath will be changed according to the new name (but only if the existing $final_path contains the old app name)
|
||||||
|
# - The checksums of php-fpm and nginx config files will be updated too.
|
||||||
|
# - If there is a $db_name value, it will be changed.
|
||||||
|
# - And, of course, the ID will be changed to the new name too.
|
||||||
|
#
|
||||||
|
# Finally, the $app variable will take the value of the new name.
|
||||||
|
# The helper will set the $migration_process variable to 1 if a migration has been successfully handled.
|
||||||
|
#
|
||||||
|
# You have to handle by yourself all the migrations not done by this helper, like configuration or special values in settings.yml
|
||||||
|
# Also, at the end of the upgrade script, you have to add a post_migration script to handle all the things the helper can't do during YunoHost upgrade (mostly for permission reasons),
|
||||||
|
# especially remove the old user, move some hooks and remove the old configuration directory
|
||||||
|
# To launch this script, you have to move it elsewhere and start it after the upgrade script.
|
||||||
|
# `cp ../conf/$script_post_migration /tmp`
|
||||||
|
# `(cd /tmp; echo "/tmp/$script_post_migration" | at now + 2 minutes)`
|
||||||
|
#
|
||||||
|
# usage: ynh_handle_app_migration migration_id migration_list
|
||||||
|
# | arg: -i, --migration_id= - ID from which to migrate
|
||||||
|
# | arg: -l, --migration_list= - File specifying every file to move (one file per line)
|
||||||
|
ynh_handle_app_migration () {
|
||||||
|
# Need for end of install
|
||||||
|
ynh_package_install at
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# LOAD SETTINGS
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
old_app=$YNH_APP_INSTANCE_NAME
|
||||||
|
local old_app_id=$YNH_APP_ID
|
||||||
|
local old_app_number=$YNH_APP_INSTANCE_NUMBER
|
||||||
|
|
||||||
|
# Declare an array to define the options of this helper.
|
||||||
|
declare -Ar args_array=( [i]=migration_id= [l]=migration_list= )
|
||||||
|
# Get the id from which to migrate
|
||||||
|
local migration_id
|
||||||
|
# And the file with the paths to move
|
||||||
|
local migration_list
|
||||||
|
# Manage arguments with getopts
|
||||||
|
ynh_handle_getopts_args "$@"
|
||||||
|
|
||||||
|
# Get the new app id in the manifest
|
||||||
|
local new_app_id=$(grep \"id\": ../manifest.json | cut -d\" -f4)
|
||||||
|
if [ $old_app_number -eq 1 ]; then
|
||||||
|
local new_app=$new_app_id
|
||||||
|
else
|
||||||
|
local new_app=${new_app_id}__${old_app_number}
|
||||||
|
fi
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# CHECK IF IT HAS TO MIGRATE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
migration_process=0
|
||||||
|
|
||||||
|
if [ "$old_app_id" == "$new_app_id" ]
|
||||||
|
then
|
||||||
|
# If the 2 id are the same
|
||||||
|
# No migration to do.
|
||||||
|
echo 0
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
if [ "$old_app_id" != "$migration_id" ]
|
||||||
|
then
|
||||||
|
# If the new app is not the authorized id, fail.
|
||||||
|
ynh_die --message="Incompatible application for migration from $old_app_id to $new_app_id"
|
||||||
|
fi
|
||||||
|
|
||||||
|
ynh_print_info --message="Migrate from $old_app_id to $new_app_id" >&2
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# CHECK IF THE MIGRATION CAN BE DONE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# TODO Handle multi instance apps...
|
||||||
|
# Check that there is not already an app installed for this id.
|
||||||
|
(yunohost app list | grep -q -w "id: $new_app") \
|
||||||
|
&& ynh_die --message="$new_app is already installed"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# CHECK THE LIST OF FILES TO MOVE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
local temp_migration_list="$(tempfile)"
|
||||||
|
|
||||||
|
# Build the list by removing blank lines and comment lines
|
||||||
|
sed '/^#.*\|^$/d' "../conf/$migration_list" > "$temp_migration_list"
|
||||||
|
|
||||||
|
# Check if there is no file in the destination
|
||||||
|
local file_to_move=""
|
||||||
|
while read file_to_move
|
||||||
|
do
|
||||||
|
# Replace all occurences of $app by $new_app in each file to move.
|
||||||
|
local move_to_destination="${file_to_move//\$app/$new_app}"
|
||||||
|
test -e "$move_to_destination" && ynh_die --message="A file named $move_to_destination already exists."
|
||||||
|
done < "$temp_migration_list"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# COPY YUNOHOST SETTINGS FOR THIS APP
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
local settings_dir="/etc/yunohost/apps"
|
||||||
|
cp -a "$settings_dir/$old_app" "$settings_dir/$new_app"
|
||||||
|
cp -a ../{scripts,conf,manifest.json} "$settings_dir/$new_app"
|
||||||
|
|
||||||
|
# Replace the old id by the new one
|
||||||
|
ynh_replace_string --match_string="\(^id: .*\)$old_app" --replace_string="\1$new_app" --target_file="$settings_dir/$new_app/settings.yml"
|
||||||
|
# INFO: There a special behavior with yunohost app setting:
|
||||||
|
# if the id given in argument does not match with the id
|
||||||
|
# stored in the config file, the config file will be purged.
|
||||||
|
# That's why we use sed instead of app setting here.
|
||||||
|
# https://github.com/YunoHost/yunohost/blob/c6b5284be8da39cf2da4e1036a730eb5e0515096/src/yunohost/app.py#L1316-L1321
|
||||||
|
|
||||||
|
# Change the label if it's simply the name of the app
|
||||||
|
old_label=$(ynh_app_setting_get --app=$new_app --key=label)
|
||||||
|
if [ "${old_label,,}" == "$old_app_id" ]
|
||||||
|
then
|
||||||
|
# Build the new label from the id of the app. With the first character as upper case
|
||||||
|
new_label=$(echo $new_app_id | cut -c1 | tr [:lower:] [:upper:])$(echo $new_app_id | cut -c2-)
|
||||||
|
ynh_app_setting_set --app=$new_app --key=label --value=$new_label
|
||||||
|
fi
|
||||||
|
|
||||||
|
permissions_name=$(yunohost user permission list $old_app --short --output-as plain)
|
||||||
|
for permission_name in $permissions_name
|
||||||
|
do
|
||||||
|
yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$permission_name', force=True, sync_perm=False)"
|
||||||
|
done
|
||||||
|
|
||||||
|
yunohost tools shell -c "from yunohost.permission import permission_create; permission_create('$new_app.main', url='/' , show_tile=True , sync_perm=True)"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# MOVE FILES TO THE NEW DESTINATION
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
while read file_to_move
|
||||||
|
do
|
||||||
|
# Replace all occurence of $app by $new_app in each file to move.
|
||||||
|
move_to_destination="$(eval echo "${file_to_move//\$app/$new_app}")"
|
||||||
|
local real_file_to_move="$(eval echo "${file_to_move//\$app/$old_app}")"
|
||||||
|
ynh_print_info --message="Move file $real_file_to_move to $move_to_destination" >&2
|
||||||
|
mv "$real_file_to_move" "$move_to_destination"
|
||||||
|
done < "$temp_migration_list"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# UPDATE SETTINGS KNOWN ENTRIES
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Replace nginx checksum
|
||||||
|
ynh_replace_string --match_string="\(^checksum__etc_nginx.*\)_$old_app" --replace_string="\1_$new_app" --target_file="$settings_dir/$new_app/settings.yml"
|
||||||
|
|
||||||
|
# Replace php-fpm checksums
|
||||||
|
ynh_replace_string --match_string="\(^checksum__etc_php.*[-_]\)$old_app" --replace_string="\1$new_app" --target_file="$settings_dir/$new_app/settings.yml"
|
||||||
|
|
||||||
|
# Replace final_path
|
||||||
|
ynh_replace_string --match_string="\(^final_path: .*\)$old_app" --replace_string="\1$new_app" --target_file="$settings_dir/$new_app/settings.yml"
|
||||||
|
|
||||||
|
# Replace fail2ban_filter
|
||||||
|
ynh_replace_string --match_string="\(^checksum__etc_fail2ban_filter.*\)_$old_app" --replace_string="\1_$new_app" --target_file="$settings_dir/$new_app/settings.yml"
|
||||||
|
|
||||||
|
# Replace fail2ban_jail
|
||||||
|
ynh_replace_string --match_string="\(^checksum__etc_fail2ban_jail.*\)_$old_app" --replace_string="\1_$new_app" --target_file="$settings_dir/$new_app/settings.yml"
|
||||||
|
|
||||||
|
# Replace systemd
|
||||||
|
ynh_replace_string --match_string="\(^checksum__etc_systemd_system.*\)_$old_app" --replace_string="\1_$new_app" --target_file="$settings_dir/$new_app/settings.yml"
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# MOVE THE MYSQL DATABASE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
old_db_name=$(ynh_app_setting_get --app=$old_app --key=db_name)
|
||||||
|
|
||||||
|
# Check if a database exists before trying to move it
|
||||||
|
local mysql_root_password=$(cat $MYSQL_ROOT_PWD_FILE)
|
||||||
|
if [ -n "$old_db_name" ] && mysqlshow -u root -p$mysql_root_password | grep -q "^| $old_db_name"
|
||||||
|
then
|
||||||
|
old_db_user=$old_db_name
|
||||||
|
db_pwd=$(ynh_app_setting_get --app=$old_app --key=mysqlpwd)
|
||||||
|
|
||||||
|
new_db_name=$(ynh_sanitize_dbid --db_name=$new_app)
|
||||||
|
new_db_user=$new_db_name
|
||||||
|
ynh_print_info --message="Rename the database $db_name to $new_db_name" >&2
|
||||||
|
|
||||||
|
local sql_dump="/tmp/${db_name}-$(date '+%s').sql"
|
||||||
|
|
||||||
|
# Dump the old database
|
||||||
|
ynh_mysql_dump_db --database="$old_db_name" > "$sql_dump"
|
||||||
|
|
||||||
|
# Create a new database
|
||||||
|
ynh_mysql_setup_db --db_user=$new_db_user --db_name=$new_db_name --db_pwd=$db_pwd
|
||||||
|
|
||||||
|
# Then restore the old one into the new one
|
||||||
|
ynh_mysql_connect_as --user=$new_db_user --password=$db_pwd --database=$new_db_name < "$sql_dump"
|
||||||
|
|
||||||
|
# Remove the old database
|
||||||
|
ynh_mysql_remove_db --db_user=$old_db_user --db_name=$old_db_name
|
||||||
|
|
||||||
|
# And the dump
|
||||||
|
ynh_secure_remove --file="$sql_dump"
|
||||||
|
|
||||||
|
# Update the value of $db_name
|
||||||
|
db_name=$new_db_name
|
||||||
|
db_user=$new_db_user
|
||||||
|
ynh_app_setting_set --app=$new_app --key=db_name --value=$db_name
|
||||||
|
fi
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# CHANGE THE FAKE DEPENDENCIES PACKAGE
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
# Check if a variable $pkg_dependencies exists
|
||||||
|
# If this variable doesn't exist, this part shall be managed in the upgrade script.
|
||||||
|
if [ -n "${pkg_dependencies:-}" ]
|
||||||
|
then
|
||||||
|
# Define the name of the package
|
||||||
|
local old_package_name="${old_app//_/-}-ynh-deps"
|
||||||
|
local new_package_name="${new_app//_/-}-ynh-deps"
|
||||||
|
|
||||||
|
if ynh_package_is_installed --package="$old_package_name"
|
||||||
|
then
|
||||||
|
# Install a new fake package
|
||||||
|
app=$new_app
|
||||||
|
ynh_install_app_dependencies $pkg_dependencies
|
||||||
|
# Then remove the old one
|
||||||
|
app=$old_app
|
||||||
|
ynh_remove_app_dependencies
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
#=================================================
|
||||||
|
# UPDATE THE ID OF THE APP
|
||||||
|
#=================================================
|
||||||
|
|
||||||
|
app=$new_app
|
||||||
|
|
||||||
|
# Set migration_process to 1 to inform that an upgrade has been made
|
||||||
|
migration_process=1
|
||||||
|
fi
|
||||||
|
}
|
|
@ -9,6 +9,8 @@
|
||||||
# If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
|
# 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"
|
# example: "root admin@domain user1 user2"
|
||||||
# | arg: -t, --type= - Type of mail, could be 'backup', 'change_url', 'install', 'remove', 'restore', 'upgrade'
|
# | arg: -t, --type= - Type of mail, could be 'backup', 'change_url', 'install', 'remove', 'restore', 'upgrade'
|
||||||
|
#
|
||||||
|
# Requires YunoHost version 4.1.0 or higher.
|
||||||
ynh_send_readme_to_admin() {
|
ynh_send_readme_to_admin() {
|
||||||
# Declare an array to define the options of this helper.
|
# Declare an array to define the options of this helper.
|
||||||
declare -Ar args_array=( [m]=app_message= [r]=recipients= [t]=type= )
|
declare -Ar args_array=( [m]=app_message= [r]=recipients= [t]=type= )
|
||||||
|
@ -23,7 +25,7 @@ ynh_send_readme_to_admin() {
|
||||||
type="${type:-install}"
|
type="${type:-install}"
|
||||||
|
|
||||||
# Get the value of admin_mail_html
|
# Get the value of admin_mail_html
|
||||||
admin_mail_html=$(ynh_app_setting_get "$app" admin_mail_html)
|
admin_mail_html=$(ynh_app_setting_get $app admin_mail_html)
|
||||||
admin_mail_html="${admin_mail_html:-0}"
|
admin_mail_html="${admin_mail_html:-0}"
|
||||||
|
|
||||||
# Retrieve the email of users
|
# Retrieve the email of users
|
||||||
|
@ -68,21 +70,15 @@ ynh_send_readme_to_admin() {
|
||||||
mail_subject="$mail_subject has just been installed!"
|
mail_subject="$mail_subject has just been installed!"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
ynh_add_config --template="$app_message" --destination="../conf/msg__to_send"
|
||||||
|
|
||||||
|
ynh_delete_file_checksum --file="../conf/msg__to_send"
|
||||||
|
|
||||||
local mail_message="This is an automated message from your beloved YunoHost server.
|
local mail_message="This is an automated message from your beloved YunoHost server.
|
||||||
|
|
||||||
Specific information for the application $app.
|
Specific information for the application $app.
|
||||||
|
|
||||||
$(if [ -n "$app_message" ]
|
$(cat "../conf/msg__to_send")"
|
||||||
then
|
|
||||||
cat "$app_message"
|
|
||||||
else
|
|
||||||
echo "...No specific information..."
|
|
||||||
fi)
|
|
||||||
|
|
||||||
---
|
|
||||||
Automatic diagnosis data from YunoHost
|
|
||||||
|
|
||||||
__PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')__PRE_TAG2__"
|
|
||||||
|
|
||||||
# Store the message into a file for further modifications.
|
# Store the message into a file for further modifications.
|
||||||
echo "$mail_message" > mail_to_send
|
echo "$mail_message" > mail_to_send
|
||||||
|
@ -103,10 +99,6 @@ __PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/service
|
||||||
# Insert url links tags
|
# Insert url links tags
|
||||||
ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "<a href=\"\2\">\1</a>" mail_to_send
|
ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "<a href=\"\2\">\1</a>" mail_to_send
|
||||||
|
|
||||||
# Insert pre tags
|
|
||||||
ynh_replace_string "__PRE_TAG1__" "<pre>" mail_to_send
|
|
||||||
ynh_replace_string "__PRE_TAG2__" "<\pre>" mail_to_send
|
|
||||||
|
|
||||||
# Insert finishing HTML tags
|
# Insert finishing HTML tags
|
||||||
echo -e "\n</body>\n</html>" >> mail_to_send
|
echo -e "\n</body>\n</html>" >> mail_to_send
|
||||||
|
|
||||||
|
@ -115,9 +107,6 @@ __PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/service
|
||||||
# Remove URL tags
|
# Remove URL tags
|
||||||
ynh_replace_string "__URL_TAG[1,3]__" "" mail_to_send
|
ynh_replace_string "__URL_TAG[1,3]__" "" mail_to_send
|
||||||
ynh_replace_string "__URL_TAG2__" ": " mail_to_send
|
ynh_replace_string "__URL_TAG2__" ": " mail_to_send
|
||||||
|
|
||||||
# Remove PRE tags
|
|
||||||
ynh_replace_string "__PRE_TAG[1-2]__" "" mail_to_send
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Define binary to use for mail command
|
# Define binary to use for mail command
|
||||||
|
|
Loading…
Reference in a new issue