mirror of
https://github.com/YunoHost-Apps/adguardhome_ynh.git
synced 2024-09-03 18:06:23 +02:00
230 lines
8.4 KiB
Bash
230 lines
8.4 KiB
Bash
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source _common.sh
|
|
source /usr/share/yunohost/helpers
|
|
|
|
#=================================================
|
|
# MANAGE SCRIPT FAILURE
|
|
#=================================================
|
|
|
|
ynh_clean_setup () {
|
|
ynh_clean_check_starting
|
|
}
|
|
# Exit if an error occurs during the execution of the script
|
|
ynh_abort_if_errors
|
|
|
|
#=================================================
|
|
# RETRIEVE ARGUMENTS FROM THE MANIFEST
|
|
#=================================================
|
|
|
|
domain=$YNH_APP_ARG_DOMAIN
|
|
path_url=$YNH_APP_ARG_PATH
|
|
admin=$YNH_APP_ARG_ADMIN
|
|
password=$YNH_APP_ARG_PASSWORD
|
|
dns_over_https=$YNH_APP_ARG_DNS_OVER_HTTPS
|
|
|
|
app=$YNH_APP_INSTANCE_NAME
|
|
|
|
#=================================================
|
|
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
|
|
#=================================================
|
|
ynh_script_progression --message="Validating installation parameters..." --weight=1
|
|
|
|
final_path=/var/www/$app
|
|
test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
|
|
|
|
# Register (book) web path
|
|
ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
|
|
|
|
#=================================================
|
|
# STORE SETTINGS FROM MANIFEST
|
|
#=================================================
|
|
ynh_script_progression --message="Storing installation settings..." --weight=2
|
|
|
|
ynh_app_setting_set --app=$app --key=domain --value=$domain
|
|
ynh_app_setting_set --app=$app --key=path --value=$path_url
|
|
ynh_app_setting_set --app=$app --key=admin --value=$admin
|
|
|
|
if [ "$dns_over_https" == "1" ];
|
|
then
|
|
dns_over_https="true"
|
|
# DNS over TLS
|
|
adguard_DoT_port=853
|
|
ynh_app_setting_set --app=$app --key=adguard_DoT_port --value=$adguard_DoT_port
|
|
ynh_exec_warn_less yunohost firewall allow --no-upnp UDP $adguard_DoT_port
|
|
ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $adguard_DoT_port
|
|
# DNS over QUIC
|
|
adguard_DoQ_port=784
|
|
ynh_app_setting_set --app=$app --key=adguard_DoQ_port --value=$adguard_DoQ_port
|
|
ynh_exec_warn_less yunohost firewall allow --no-upnp UDP $adguard_DoQ_port
|
|
else
|
|
dns_over_https="false"
|
|
fi
|
|
ynh_app_setting_set --app=$app --key=dns_over_https --value=$dns_over_https
|
|
|
|
#=================================================
|
|
# STANDARD MODIFICATIONS
|
|
#=================================================
|
|
# FIND AND OPEN A PORT
|
|
#=================================================
|
|
ynh_script_progression --message="Finding an available port..." --weight=1
|
|
|
|
# Find an available port
|
|
port=$(ynh_find_port --port=3000)
|
|
ynh_app_setting_set --app=$app --key=port --value=$port
|
|
|
|
# Find an available port
|
|
adguard_port=53
|
|
ynh_app_setting_set --app=$app --key=adguard_port --value=$adguard_port
|
|
|
|
# Disable the port 53 for upnp
|
|
ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $adguard_port
|
|
ynh_exec_warn_less yunohost firewall allow --no-upnp UDP $adguard_port
|
|
|
|
#=================================================
|
|
# INSTALL DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Installing dependencies..." --weight=1
|
|
|
|
ynh_install_app_dependencies $pkg_dependencies
|
|
|
|
#=================================================
|
|
# CREATE DEDICATED USER
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring system user..." --weight=1
|
|
|
|
# Create a system user
|
|
ynh_system_user_create --username=$app --home_dir="$final_path" --groups="ssl-cert"
|
|
|
|
#=================================================
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
|
#=================================================
|
|
ynh_script_progression --message="Setting up source files..." --weight=4
|
|
|
|
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
|
|
# Download, check integrity, uncompress and patch the source from app.src
|
|
ynh_setup_source --dest_dir=$final_path --source_id="$YNH_ARCH"
|
|
|
|
chmod 750 "$final_path"
|
|
chmod -R o-rwx "$final_path"
|
|
chown -R $app:$app "$final_path"
|
|
|
|
setcap 'CAP_NET_BIND_SERVICE=+eip CAP_NET_RAW=+eip' $final_path/AdGuardHome
|
|
|
|
#=================================================
|
|
# NGINX CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring NGINX web server..." --weight=3
|
|
|
|
# Create a dedicated NGINX config
|
|
ynh_add_nginx_config
|
|
|
|
#=================================================
|
|
# SPECIFIC SETUP
|
|
#=================================================
|
|
# ADD A CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Adding a configuration file..." --weight=1
|
|
|
|
# echo the ip route command to prevent a crash if the server doesn't have any ipv4/6
|
|
ipv4_interface=$(echo "$(ip -4 route get 1.2.3.4 2> /dev/null)" | head -n1 | grep -oP '(?<=dev )\w+' || true)
|
|
ipv6_interface=$(echo "$(ip -6 route get ::1.2.3.4 2> /dev/null)" | head -n1 | grep -oP '(?<=dev )\w+' || true)
|
|
|
|
if [ -z "$ipv4_interface" ] && [ -z "$ipv6_interface" ]; then
|
|
ynh_die --message="Impossible to find the main network interface, please report this issue."
|
|
elif [ "$ipv4_interface" != "$ipv6_interface" ]; then
|
|
if [ -z "$ipv4_interface" ]; then
|
|
echo -e "bind-interface\nexcept-interface=$ipv6_interface" > "/etc/dnsmasq.d/$app"
|
|
elif [ -z "$ipv6_interface" ]; then
|
|
echo -e "bind-interfaces\nexcept-interface=$ipv4_interface" > "/etc/dnsmasq.d/$app"
|
|
else
|
|
echo -e "bind-interfaces\nexcept-interface=$ipv4_interface, $ipv6_interface" > "/etc/dnsmasq.d/$app"
|
|
fi
|
|
else
|
|
echo -e "bind-interfaces\nexcept-interface=$ipv4_interface" > "/etc/dnsmasq.d/$app"
|
|
fi
|
|
|
|
systemctl restart dnsmasq
|
|
|
|
ynh_store_file_checksum --file="/etc/dnsmasq.d/$app"
|
|
|
|
ipv4_route_output=$(echo "$(ip -4 route get 1.2.3.4 2> /dev/null)" | head -n1 | head -n1)
|
|
ipv6_route_output=$(echo "$(ip -6 route get ::1.2.3.4 2> /dev/null)" | head -n1)
|
|
|
|
ipv4_addr=""
|
|
for i in $(seq "$(echo $ipv4_route_output | wc -w)" -1 1); do
|
|
ip=$(echo $ipv4_route_output | awk "{print \$$i}")
|
|
if ynh_validate_ip4 --ip_address=$ip; then
|
|
ipv4_addr="- $ip"
|
|
break
|
|
fi
|
|
done
|
|
|
|
ipv6_addr=""
|
|
for i in $(seq "$(echo $ipv6_route_output | wc -w)" -1 1); do
|
|
ip=$(echo $ipv6_route_output | awk "{print \$$i}")
|
|
if ynh_validate_ip6 --ip_address=$ip; then
|
|
ipv6_addr="- $ip"
|
|
break
|
|
fi
|
|
done
|
|
|
|
password=$(python3 -c "import bcrypt; print(bcrypt.hashpw(b\"$password\", bcrypt.gensalt(rounds=10)).decode())")
|
|
ynh_app_setting_set --app=$app --key=password --value=$password
|
|
|
|
# Main config File
|
|
ynh_add_config --template="../conf/AdGuardHome.yaml" --destination="$final_path/AdGuardHome.yaml"
|
|
|
|
chmod 600 "$final_path/AdGuardHome.yaml"
|
|
chown -R $app:$app "$final_path/AdGuardHome.yaml"
|
|
|
|
#=================================================
|
|
# SETUP SYSTEMD
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring a systemd service..." --weight=1
|
|
|
|
# Create a dedicated systemd config
|
|
ynh_add_systemd_config
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# INTEGRATE SERVICE IN YUNOHOST
|
|
#=================================================
|
|
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
|
|
|
|
yunohost service add $app --description="Ads & trackers blocking DNS server" --needs_exposed_ports $adguard_port
|
|
|
|
#=================================================
|
|
# START SYSTEMD SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Starting a systemd service..." --weight=2
|
|
|
|
# Start a systemd service
|
|
ynh_systemd_action --service_name=$app --action="restart" --log_path=systemd
|
|
|
|
#=================================================
|
|
# SETUP SSOWAT
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring permissions..."
|
|
|
|
ynh_permission_create --permission="api" --label="api" --url="re:$domain/dns-query" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
|
|
|
|
#=================================================
|
|
# RELOAD NGINX
|
|
#=================================================
|
|
ynh_script_progression --message="Reloading NGINX web server..." --weight=2
|
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Installation of $app completed" --last
|