mirror of
https://github.com/YunoHost-Apps/pihole_ynh.git
synced 2024-09-03 20:05:58 +02:00
251 lines
9.1 KiB
Bash
251 lines
9.1 KiB
Bash
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source ../settings/scripts/_common.sh
|
|
source /usr/share/yunohost/helpers
|
|
# Load common variables for all scripts.
|
|
source ../settings/scripts/_variables
|
|
|
|
#=================================================
|
|
# MANAGE SCRIPT FAILURE
|
|
#=================================================
|
|
|
|
# Exit if an error occurs during the execution of the script
|
|
ynh_abort_if_errors
|
|
|
|
#=================================================
|
|
# LOAD SETTINGS
|
|
#=================================================
|
|
ynh_script_progression --message="Load settings" --weight=2
|
|
|
|
app=$YNH_APP_INSTANCE_NAME
|
|
|
|
domain=$(ynh_app_setting_get $app domain)
|
|
path_url=$(ynh_app_setting_get $app path)
|
|
final_path=$(ynh_app_setting_get $app final_path)
|
|
enable_dhcp=$(ynh_app_setting_get $app enable_dhcp)
|
|
admin=$(ynh_app_setting_get $app admin)
|
|
|
|
#=================================================
|
|
# CHECK IF THE APP CAN BE RESTORED
|
|
#=================================================
|
|
|
|
ynh_webpath_available $domain $path_url \
|
|
|| ynh_die "Path not available: ${domain}${path_url}"
|
|
test ! -d $final_path \
|
|
|| ynh_die "There is already a directory: $final_path "
|
|
|
|
#=================================================
|
|
# ACTIVATE MAINTENANCE MODE
|
|
#=================================================
|
|
ynh_script_progression --message="Activate maintenance mode" --weight=2
|
|
|
|
ynh_maintenance_mode_ON
|
|
|
|
#=================================================
|
|
# STANDARD RESTORE STEPS
|
|
#=================================================
|
|
# RESTORE THE NGINX CONFIGURATION
|
|
#=================================================
|
|
|
|
ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
|
|
|
|
#=================================================
|
|
# RESTORE THE MAIN DIRECTORIES OF THE APP
|
|
#=================================================
|
|
ynh_script_progression --message="Restore the app main directories"
|
|
|
|
ynh_restore_file "$final_path"
|
|
|
|
ynh_restore_file "/etc/.pihole"
|
|
|
|
ynh_restore_file "/etc/pihole"
|
|
|
|
ynh_restore_file "/opt/pihole"
|
|
|
|
#=================================================
|
|
# RECREATE THE DEDICATED USER
|
|
#=================================================
|
|
ynh_script_progression --message="Recreate the dedicated user" --weight=2
|
|
|
|
# Create the dedicated user (if not existing)
|
|
ynh_system_user_create $app
|
|
|
|
#=================================================
|
|
# RESTORE USER RIGHTS
|
|
#=================================================
|
|
|
|
# Restore permissions on app files
|
|
chown $app: -R "/etc/pihole"
|
|
# /etc/pihole/logrotate have to belong to root, otherwise logrotate will failed silently...
|
|
chown root: -R "/etc/pihole/logrotate"
|
|
|
|
#=================================================
|
|
# RESTORE THE PHP-FPM CONFIGURATION
|
|
#=================================================
|
|
|
|
ynh_restore_file "/etc/php/7.0/fpm/pool.d/$app.conf"
|
|
|
|
#=================================================
|
|
# SPECIFIC RESTORE
|
|
#=================================================
|
|
# REINSTALL DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Reinstall dependencies" --weight=12
|
|
|
|
ynh_install_app_dependencies $app_depencencies
|
|
|
|
#=================================================
|
|
# ADVERTISE SERVICE IN ADMIN PANEL
|
|
#=================================================
|
|
|
|
yunohost service add pihole-FTL --description "PiHole backend service" --log "/var/log/pihole-FTL.log"
|
|
|
|
#=================================================
|
|
# RESTORE THE CRON FILE
|
|
#=================================================
|
|
|
|
ynh_restore_file "/etc/cron.d/pihole"
|
|
|
|
#=================================================
|
|
# RECREATE LOG FILES
|
|
#=================================================
|
|
|
|
touch /var/log/pihole.log
|
|
chmod 644 /var/log/pihole.log
|
|
dnsmasq_user=$(grep DNSMASQ_USER= /etc/init.d/dnsmasq | cut -d'"' -f2)
|
|
chown $dnsmasq_user:root /var/log/pihole.log
|
|
|
|
#=================================================
|
|
# RESTORE SPECIFIC FILES
|
|
#=================================================
|
|
ynh_script_progression --message="Restore specific files"
|
|
|
|
ynh_restore_file "/usr/local/bin/pihole"
|
|
ynh_restore_file "/etc/bash_completion.d/pihole"
|
|
|
|
ynh_restore_file "/etc/sudoers.d/pihole"
|
|
|
|
ynh_restore_file "/etc/init.d/pihole-FTL"
|
|
ynh_restore_file "/usr/bin/pihole-FTL"
|
|
|
|
ynh_restore_file "/usr/share/yunohost/hooks/conf_regen/50-dnsmasq_$app"
|
|
|
|
#=================================================
|
|
# RESTORE DNSMASQ CONFIG
|
|
#=================================================
|
|
ynh_script_progression --message="Restore Dnsmasq config"
|
|
|
|
ynh_systemd_action --action=stop --service_name=dnsmasq
|
|
|
|
ynh_restore_file "/etc/dnsmasq.d/01-pihole.conf"
|
|
test -e "${YNH_APP_BACKUP_DIR}/etc/dnsmasq.d/02-pihole-dhcp.conf" && \
|
|
ynh_restore_file "/etc/dnsmasq.d/02-pihole-dhcp.conf"
|
|
test -e "${YNH_APP_BACKUP_DIR}/etc/dnsmasq.d/03-pihole-wildcard.conf" && \
|
|
ynh_restore_file "/etc/dnsmasq.d/03-pihole-wildcard.conf"
|
|
test -e "${YNH_APP_BACKUP_DIR}/etc/dnsmasq.d/04-pihole-static-dhcp.conf" && \
|
|
ynh_restore_file "/etc/dnsmasq.d/04-pihole-static-dhcp.conf"
|
|
|
|
# To prevent any conflict with the original dnsmasq config, comment cache-size in the original config.
|
|
ynh_replace_string "^cache-size=" "#pihole# cache-size=" /etc/dnsmasq.conf
|
|
|
|
#=================================================
|
|
# CONFIGURE DNS FOR THE LOCAL DOMAINS
|
|
#=================================================
|
|
ynh_script_progression --message="Configure dns for the local domains" --weight=2
|
|
|
|
# Get the default network interface
|
|
main_iface=$(ip route | grep --max-count=1 default | awk '{print $5;}')
|
|
# Find the IP associated to the network interface
|
|
localipv4=$(ip address | grep "${main_iface}\$" | awk '{print $2;}' | cut -d/ -f1)
|
|
|
|
# List all YunoHost domains
|
|
while read perdomain
|
|
do
|
|
# Comment domain resolution in /etc/hosts on 127.0.0.1, because they can interfere with the local network resolution.
|
|
sed -i "s/^127.0.0.1.*$perdomain/#Commented by pihole# &/g" /etc/hosts
|
|
|
|
# And add a resolution on the local IP instead
|
|
grep -q "^$localipv4.*$perdomain" /etc/hosts || \
|
|
echo "$localipv4 $perdomain #Added by pihole#" >> /etc/hosts
|
|
done <<< "$(yunohost domain list | grep "\." | sed 's/.*: \|.*- //')"
|
|
|
|
#=================================================
|
|
# RESTART DNSMASQ
|
|
#=================================================
|
|
ynh_script_progression --message="Restart Dnsmasq"
|
|
|
|
ynh_systemd_action --action=restart --service_name=dnsmasq
|
|
|
|
#=================================================
|
|
# UPDATE VARIABLES FILE
|
|
#=================================================
|
|
|
|
setupVars="/etc/pihole/setupVars.conf"
|
|
|
|
echo "PIHOLE_INTERFACE=$main_iface" > $setupVars
|
|
ynh_replace_string "^PIHOLE_INTERFACE=.*" "PIHOLE_INTERFACE=$main_iface" $setupVars
|
|
ynh_replace_string "^IPV4_ADDRESS=.*" "IPV4_ADDRESS=127.0.0.1" $setupVars
|
|
|
|
# Recalculate and store the checksum of the file for the next upgrade.
|
|
ynh_store_file_checksum "$setupVars"
|
|
|
|
#=================================================
|
|
# START PIHOLE-FTL
|
|
#=================================================
|
|
ynh_script_progression --message="Restart PiHole-FTL" --weight=2
|
|
|
|
ynh_exec_warn_less systemctl enable pihole-FTL
|
|
ynh_systemd_action --action=restart --service_name=pihole-FTL
|
|
|
|
#=================================================
|
|
# GENERIC FINALISATION
|
|
#=================================================
|
|
# RELOAD NGINX AND PHP-FPM
|
|
#=================================================
|
|
ynh_script_progression --message="Reload nginx and php-fpm"
|
|
|
|
ynh_systemd_action --action=reload --service_name=php7.0-fpm
|
|
ynh_systemd_action --action=reload --service_name=nginx
|
|
|
|
#=================================================
|
|
# DEACTIVE MAINTENANCE MODE
|
|
#=================================================
|
|
ynh_script_progression --message="Disable maintenance mode" --weight=4
|
|
|
|
ynh_maintenance_mode_OFF
|
|
|
|
#=================================================
|
|
# SEND A README FOR THE ADMIN
|
|
#=================================================
|
|
|
|
# Get main domain and buid the url of the admin panel of the app.
|
|
admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
|
|
|
|
if [ $enable_dhcp -eq 1 ]
|
|
then
|
|
dhcp_alert="You asked to use the internal DHCP server of dnsmasq with PiHole.
|
|
You should really read the __URL_TAG1__documentation about that__URL_TAG2__https://github.com/YunoHost-Apps/pihole_ynh/blob/master/dhcp.md__URL_TAG3__
|
|
|
|
"
|
|
else
|
|
dhcp_alert=""
|
|
fi
|
|
|
|
echo "${dhcp_alert}You can configure this app easily by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__.
|
|
You can also find some specific actions for this app by using the experimental __URL_TAG1__action feature__URL_TAG2__$admin_panel/actions__URL_TAG3__.
|
|
|
|
If you're facing an issue or want to improve this app, please open a new issue in this __URL_TAG1__project__URL_TAG2__https://github.com/YunoHost-Apps/pihole_ynh__URL_TAG3__." > mail_to_send
|
|
|
|
ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="$admin" --type="restore"
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Restoration completed" --last
|