mirror of
https://github.com/YunoHost-Apps/paperless-ngx_ynh.git
synced 2024-09-03 19:56:33 +02:00
290 lines
11 KiB
Bash
Executable file
290 lines
11 KiB
Bash
Executable file
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source _common.sh
|
|
source ynh_redis
|
|
source /usr/share/yunohost/helpers
|
|
|
|
#=================================================
|
|
# MANAGE SCRIPT FAILURE
|
|
#=================================================
|
|
|
|
ynh_clean_setup () {
|
|
### Remove this function if there's nothing to clean before calling the remove script.
|
|
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="/"
|
|
is_public=$YNH_APP_ARG_IS_PUBLIC
|
|
is_public_api=$YNH_APP_ARG_IS_PUBLIC_API
|
|
admin=$YNH_APP_ARG_ADMIN
|
|
admin_pw=$YNH_APP_ARG_ADMIN_PW
|
|
|
|
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=/opt/yunohost/$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=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=1
|
|
|
|
# FIXME: Only on a Raspberry Pi (armv6 v7?)
|
|
# ynh_add_app_dependencies $raspberry_pkg_dependencies
|
|
ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies $ocr_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"
|
|
|
|
#=================================================
|
|
# CREATE A POSTGRESQL DATABASE
|
|
#=================================================
|
|
ynh_script_progression --message="Creating a PostgreSQL database..." --weight=1
|
|
|
|
db_name=$(ynh_sanitize_dbid --db_name=$app)
|
|
db_user=$db_name
|
|
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
|
|
|
|
ynh_psql_setup_db --db_user=$db_user --db_name=$db_name
|
|
|
|
#=================================================
|
|
# 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
|
|
|
|
ynh_setup_source --dest_dir="$final_path"
|
|
|
|
chmod 750 "$final_path"
|
|
chmod -R o-rwx "$final_path"
|
|
chown -R $app:$app "$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
|
|
#=================================================
|
|
# INSTALL PYTHON DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Installing Python dependencies..."
|
|
|
|
pushd $final_path
|
|
python3 -m venv venv
|
|
chown -R "$app:" "$final_path"
|
|
(
|
|
source "$final_path/venv/bin/activate"
|
|
ynh_exec_as $app $final_path/venv/bin/pip3 install --upgrade pip setuptools wheel
|
|
ynh_exec_as $app $final_path/venv/bin/pip3 install -r "$final_path/requirements.txt"
|
|
|
|
# Installing NLTK data
|
|
mkdir -p "$final_path/nltk_data"
|
|
chown -R "$app:" "$final_path/nltk_data"
|
|
ynh_exec_warn_less ynh_exec_as $app $final_path/venv/bin/python3 -m nltk.downloader -d "$final_path/nltk_data" snowball_data
|
|
ynh_exec_warn_less ynh_exec_as $app $final_path/venv/bin/python3 -m nltk.downloader -d "$final_path/nltk_data" stopwords
|
|
ynh_exec_warn_less ynh_exec_as $app $final_path/venv/bin/python3 -m nltk.downloader -d "$final_path/nltk_data" punkt
|
|
|
|
deactivate
|
|
)
|
|
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/consume"
|
|
mkdir -p "$datadir/data"
|
|
mkdir -p "$datadir/media"
|
|
|
|
chmod 750 "$datadir"
|
|
chmod -R o-rwx "$datadir"
|
|
chown -R $app:www-data "$datadir"
|
|
|
|
#=================================================
|
|
# REMOVE TEMP DIRECTORY
|
|
#=================================================
|
|
ynh_script_progression --message="Cleanup temp directory..." --weight=1
|
|
ynh_secure_remove --file="/tmp/$app"
|
|
|
|
#=================================================
|
|
# ADD A CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Adding a configuration file..." --weight=1
|
|
|
|
redis_db=$(ynh_redis_get_free_db)
|
|
ynh_app_setting_set --app=$app --key=redis_db --value=$redis_db
|
|
|
|
paperless_secret_key=$(ynh_string_random)
|
|
ynh_app_setting_set --app=$app --key=paperless_secret_key --value=$paperless_secret_key
|
|
|
|
ocr_language="eng"
|
|
ynh_app_setting_set --app=$app --key=ocr_language --value=$ocr_language
|
|
|
|
ynh_add_config --template="paperless.conf.example" --destination="$final_path/paperless.conf"
|
|
|
|
chmod 400 "$final_path/paperless.conf"
|
|
chown $app:$app "$final_path/paperless.conf"
|
|
|
|
#=================================================
|
|
# SETUP THE DATABASE
|
|
#=================================================
|
|
ynh_script_progression --message="Setting up the database..." --weight=1
|
|
|
|
pushd "$final_path/src"
|
|
(
|
|
source "$final_path/venv/bin/activate"
|
|
ynh_exec_as $app $final_path/venv/bin/python manage.py migrate
|
|
deactivate
|
|
)
|
|
popd
|
|
|
|
#=================================================
|
|
# CREATE THE ADMIN USER
|
|
#=================================================
|
|
ynh_script_progression --message="Creating the admin user..." --weight=1
|
|
|
|
pushd "$final_path/src"
|
|
(
|
|
source "$final_path/venv/bin/activate"
|
|
email=$(ynh_user_get_info $admin 'mail')
|
|
ynh_exec_as $app env "DJANGO_SUPERUSER_PASSWORD=$admin_pw" $final_path/venv/bin/python3 manage.py createsuperuser --noinput --username "$admin" --email "$email"
|
|
deactivate
|
|
)
|
|
popd
|
|
|
|
#=================================================
|
|
# SETUP SYSTEMD
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring a systemd service..." --weight=1
|
|
|
|
# Create a dedicated systemd config
|
|
ynh_add_systemd_config --service="$app" --template="systemd.service"
|
|
ynh_add_systemd_config --service="$app-consumer" --template="systemd-consumer.service"
|
|
ynh_add_systemd_config --service="$app-scheduler" --template="systemd-scheduler.service"
|
|
ynh_add_systemd_config --service="$app-task-queue" --template="systemd-task-queue.service"
|
|
|
|
#=================================================
|
|
# 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" --log="/var/log/$app/$app.log"
|
|
yunohost service add "$app-consumer" --log="/var/log/$app/$app-consumer.log"
|
|
yunohost service add "$app-scheduler" --log="/var/log/$app/$app-scheduler.log"
|
|
yunohost service add "$app-task-queue" --log="/var/log/$app/$app-task-queue.log"
|
|
|
|
#=================================================
|
|
# START SYSTEMD SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Starting a systemd service..." --weight=1
|
|
|
|
ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log"
|
|
ynh_systemd_action --service_name="$app-consumer" --action="start" --log_path="/var/log/$app/$app-consumer.log"
|
|
ynh_systemd_action --service_name="$app-scheduler" --action="start" --log_path="/var/log/$app/$app-scheduler.log"
|
|
ynh_systemd_action --service_name="$app-task-queue" --action="start" --log_path="/var/log/$app/$app-task-queue.log"
|
|
|
|
#=================================================
|
|
# SETUP FAIL2BAN
|
|
#=================================================
|
|
#ynh_script_progression --message="Configuring Fail2Ban..." --weight=1
|
|
|
|
# Create a dedicated Fail2Ban config
|
|
#ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
|
|
# FIXME fail2ban
|
|
# 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
|
|
|
|
#=================================================
|
|
# SETUP SSOWAT
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring permissions..." --weight=1
|
|
|
|
# Make app public if necessary
|
|
if [ $is_public -eq 1 ]
|
|
then
|
|
ynh_permission_update --permission="main" --add="visitors"
|
|
fi
|
|
|
|
ynh_permission_create --permission="api" --url="/api" --allowed="all_users" --auth_header="false" --label="$app API" --show_tile="false" --protected="false"
|
|
if [ $is_public_api -eq 1 ]
|
|
then
|
|
ynh_permission_update --permission="api" --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
|