mirror of
https://github.com/YunoHost-Apps/archivebox_ynh.git
synced 2024-09-03 18:15:54 +02:00
273 lines
9.2 KiB
Bash
Executable file
273 lines
9.2 KiB
Bash
Executable file
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source _common.sh
|
|
source /usr/share/yunohost/helpers
|
|
|
|
#=================================================
|
|
# MANAGE SCRIPT FAILURE
|
|
#=================================================
|
|
|
|
ynh_clean_setup () {
|
|
true
|
|
}
|
|
# 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
|
|
# we can only add support for subpaths once this is resolved in archivebox
|
|
# https://github.com/ArchiveBox/ArchiveBox/issues/724
|
|
path_url="/"
|
|
is_public=$YNH_APP_ARG_IS_PUBLIC
|
|
language=$YNH_APP_ARG_LANGUAGE
|
|
admin=$YNH_APP_ARG_ADMIN
|
|
password=$YNH_APP_ARG_PASSWORD
|
|
|
|
app=$YNH_APP_INSTANCE_NAME
|
|
|
|
admin_mail=$(ynh_user_get_info $admin 'mail')
|
|
|
|
#=================================================
|
|
# 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=1
|
|
|
|
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=language --value=$language
|
|
ynh_app_setting_set --app=$app --key=admin --value=$admin
|
|
|
|
#=================================================
|
|
# 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=8095)
|
|
ynh_app_setting_set --app=$app --key=port --value=$port
|
|
|
|
#=================================================
|
|
# INSTALL DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Installing dependencies..." --weight=8
|
|
|
|
ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
|
|
ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
|
|
|
|
#=================================================
|
|
# 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"
|
|
|
|
#=================================================
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
|
#=================================================
|
|
ynh_script_progression --message="Setting up source files..." --weight=1
|
|
|
|
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
|
|
# Download, check integrity, uncompress and patch the source from app.src
|
|
tempdir="$(mktemp -d)"
|
|
ynh_setup_source --dest_dir="$tempdir"
|
|
mkdir -p $final_path
|
|
|
|
chmod 750 "$final_path"
|
|
chmod -R o-rwx "$final_path"
|
|
chown -R $app:www-data "$final_path"
|
|
|
|
#=================================================
|
|
# NGINX CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring NGINX web server..." --weight=1
|
|
|
|
# Create a dedicated NGINX config
|
|
ynh_add_nginx_config
|
|
|
|
#=================================================
|
|
# SPECIFIC SETUP
|
|
#=================================================
|
|
# PIP INSTALLATION
|
|
#=================================================
|
|
ynh_script_progression --message="Installing project via pip..." --weight=80
|
|
|
|
python3 -m venv "${final_path}/venv"
|
|
cp ../conf/requirements.txt "$final_path/requirements.txt"
|
|
chown -R "$app" "$final_path"
|
|
|
|
#run source in a 'sub shell'
|
|
(
|
|
set +o nounset
|
|
source "${final_path}/venv/bin/activate"
|
|
set -o nounset
|
|
ynh_exec_as $app $final_path/venv/bin/pip install --upgrade pip
|
|
ynh_exec_as $app $final_path/venv/bin/pip install -r "$final_path/requirements.txt"
|
|
)
|
|
|
|
# we use this virtualenv archivebox for further commands now
|
|
archivebox_cmd="$final_path/venv/bin/archivebox"
|
|
|
|
#=================================================
|
|
# INSTALL NODE DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Installing node dependencies..."
|
|
|
|
cp -f $tempdir/package.json "$final_path/package.json"
|
|
cp -f $tempdir/package-lock.json "$final_path/package-lock.json"
|
|
ynh_secure_remove --file="$tempdir"
|
|
pushd $final_path
|
|
ynh_use_nodejs
|
|
ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH $ynh_npm ci
|
|
popd
|
|
|
|
#=================================================
|
|
# CREATE DATA DIRECTORY
|
|
#=================================================
|
|
ynh_script_progression --message="Creating a data directory..." --weight=1
|
|
|
|
datadir=/home/yunohost.app/$app
|
|
ynh_app_setting_set --app=$app --key=datadir --value=$datadir
|
|
|
|
mkdir -p $datadir
|
|
|
|
chmod 750 "$datadir"
|
|
chmod -R o-rwx "$datadir"
|
|
chown -R $app:www-data "$datadir"
|
|
|
|
#=================================================
|
|
# ADD A CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Adding a configuration file..." --weight=1
|
|
|
|
ynh_add_config --template="../conf/ArchiveBox.conf" --destination="$datadir/ArchiveBox.conf"
|
|
|
|
chmod 600 "$datadir/ArchiveBox.conf"
|
|
chown $app:$app "$datadir/ArchiveBox.conf"
|
|
|
|
#=================================================
|
|
# INITIALIZE ARCHIVEBOX
|
|
#=================================================
|
|
ynh_script_progression --message="Initializing Archivebox" --weight=1
|
|
|
|
pushd $datadir
|
|
ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH $archivebox_cmd init
|
|
|
|
ynh_script_progression --message="Checking if admin superuser already exists: $admin" --weight=1
|
|
USER_EXISTS=$(ynh_exec_as $app $archivebox_cmd manage shell -c "from django.contrib.auth.models import User; print(User.objects.filter(username='$admin').count())")
|
|
ynh_script_progression --message="Found users: $USER_EXISTS" --weight=1
|
|
|
|
if [ $USER_EXISTS -eq 1 ]
|
|
then
|
|
ynh_script_progression --message="User already exists: setting admin password" --weight=1
|
|
ynh_exec_as $app /usr/bin/expect<<EOF
|
|
set force_conservative 0 ;
|
|
set timeout -1
|
|
spawn sh -c "cd $datadir && $archivebox_cmd manage changepassword $admin"
|
|
match_max 100000
|
|
expect "*?assword: "
|
|
send -- "$password\r"
|
|
expect "*?assword (again): "
|
|
send -- "$password\r"
|
|
expect eof
|
|
EOF
|
|
else
|
|
ynh_script_progression --message="Creating new archivebox superuser: $admin" --weight=1
|
|
ynh_exec_as $app /usr/bin/expect<<EOF
|
|
set force_conservative 0 ;
|
|
set timeout -1
|
|
spawn sh -c "cd $datadir && $archivebox_cmd manage createsuperuser --username $admin --email $admin_mail"
|
|
match_max 100000
|
|
expect "*?assword: "
|
|
send -- "$password\r"
|
|
expect "*?assword (again): "
|
|
send -- "$password\r"
|
|
expect eof
|
|
EOF
|
|
fi
|
|
|
|
ynh_script_progression --message="Finishing Archivebox Setup" --weight=1
|
|
ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH $archivebox_cmd init --setup
|
|
popd
|
|
|
|
#=================================================
|
|
# SETUP SYSTEMD
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring a systemd service..." --weight=1
|
|
|
|
# Create a dedicated systemd config
|
|
ynh_add_systemd_config
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SETUP LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring log rotation..." --weight=1
|
|
|
|
# Use logrotate to manage application logfile(s)
|
|
ynh_use_logrotate
|
|
|
|
#=================================================
|
|
# INTEGRATE SERVICE IN YUNOHOST
|
|
#=================================================
|
|
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
|
|
|
|
yunohost service add $app --description="Self-hosted internet archiving" --log="/var/log/$app/$app.log"
|
|
|
|
#=================================================
|
|
# START SYSTEMD SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Starting a systemd service..." --weight=1
|
|
|
|
# Start a systemd service
|
|
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
|
|
|
|
#=================================================
|
|
# SETUP SSOWAT
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring permissions..." --weight=1
|
|
|
|
# Make app public if necessary
|
|
if [ $is_public -eq 1 ]
|
|
then
|
|
# Everyone can access the app.
|
|
# The "main" permission is automatically created before the install script.
|
|
ynh_permission_update --permission="main" --add="visitors"
|
|
fi
|
|
|
|
#=================================================
|
|
# 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="Installation of $app completed" --last
|