mirror of
https://github.com/YunoHost-Apps/pytition_ynh.git
synced 2024-09-03 20:16:08 +02:00
265 lines
9.7 KiB
Bash
Executable file
265 lines
9.7 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
|
|
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
|
|
|
|
#=================================================
|
|
# 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"
|
|
|
|
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=password --value=$password
|
|
|
|
#=================================================
|
|
# STANDARD MODIFICATIONS
|
|
#=================================================
|
|
# INSTALL DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Installing dependencies..." --weight=3
|
|
|
|
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"
|
|
|
|
#=================================================
|
|
# CREATE A MYSQL DATABASE
|
|
#=================================================
|
|
ynh_script_progression --message="Creating a MySQL 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_mysql_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
|
|
|
|
mkdir -p "$final_path/static"
|
|
mkdir -p "$final_path/mediaroot"
|
|
ynh_setup_source --dest_dir="$final_path/pytition"
|
|
|
|
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
|
|
ynh_add_nginx_config
|
|
|
|
#=================================================
|
|
# SPECIFIC SETUP
|
|
#=================================================
|
|
# ...
|
|
#=================================================
|
|
ynh_script_progression --message="Installing python dependencies..." --weight=4
|
|
|
|
# Setup virtualenv and install dependencies
|
|
virtualenv --python=python3 --system-site-packages "${final_path}/venv"
|
|
(
|
|
set +o nounset
|
|
source "${final_path}/venv/bin/activate"
|
|
set -o nounset
|
|
|
|
python3 -m pip install --upgrade pip
|
|
python3 -m pip install -r "$final_path/pytition/requirements.txt"
|
|
)
|
|
|
|
#=================================================
|
|
# CREATE DATA DIRECTORY
|
|
#=================================================
|
|
ynh_script_progression --message="Creating the log directory..." --weight=1
|
|
|
|
mkdir -p "/var/log/$app"
|
|
chmod 750 "/var/log/$app"
|
|
chown -R $app:www-data "/var/log/$app"
|
|
|
|
# ### Use these lines if you need to create a directory to store "persistent files" for the application.
|
|
# ### Usually this directory is used to store uploaded files or any file that won't be updated during
|
|
# ### an upgrade and that won't be deleted during app removal unless "--purge" option is used.
|
|
# ### If you're not using these lines:
|
|
# ### - Remove the section "BACKUP THE DATA DIR" in the backup script
|
|
# ### - Remove the section "RESTORE THE DATA DIRECTORY" in the restore script
|
|
# ### - As well as the section "REMOVE DATA DIR" in the remove script
|
|
|
|
# datadir=/home/yunohost.app/$app
|
|
# ynh_app_setting_set --app=$app --key=datadir --value=$datadir
|
|
|
|
# mkdir -p $datadir
|
|
|
|
# # FIXME: this should be managed by the core in the future
|
|
# # Here, as a packager, you may have to tweak the ownerhsip/permissions
|
|
# # such that the appropriate users (e.g. maybe www-data) can access
|
|
# # files in some cases.
|
|
# # But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
|
|
# # this will be treated as a security issue.
|
|
# chmod 750 "$datadir"
|
|
# chmod -R o-rwx "$datadir"
|
|
# chown -R $app:www-data "$datadir"
|
|
|
|
#=================================================
|
|
# ADD A CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Adding configuration files..." --weight=1
|
|
secret_key=$(generate_secret_key)
|
|
|
|
config_path="$final_path/pytition/pytition/pytition/settings/config.py"
|
|
ynh_add_config --template="../conf/config.py" --destination="$config_path"
|
|
|
|
# FIXME: this should be handled by the core in the future
|
|
# You may need to use chmod 600 instead of 400,
|
|
# for example if the app is expected to be able to modify its own config
|
|
chmod 400 "$config_path"
|
|
chown $app:$app "$config_path"
|
|
|
|
ynh_add_config --template="../conf/uwsgi.yaml" --destination="$final_path/uwsgi.yaml"
|
|
chmod 400 "$final_path/uwsgi.yaml"
|
|
chown $app:$app "$final_path/uwsgi.yaml"
|
|
|
|
#=================================================
|
|
# Run app configuration
|
|
#=================================================
|
|
ynh_script_progression --message="Running app configuration..." --weight=3
|
|
|
|
ynh_exec_as $app bash -c "
|
|
set +o nounset
|
|
source '$final_path/venv/bin/activate'
|
|
set -o nounset
|
|
cd '$final_path/pytition/pytition'
|
|
export DJANGO_SETTINGS_MODULE=pytition.settings.config
|
|
python3 manage.py migrate
|
|
python3 manage.py collectstatic
|
|
python3 manage.py compilemessages
|
|
DJANGO_SUPERUSER_PASSWORD='$password' \
|
|
python3 manage.py createsuperuser --noinput --username admin --email 'admin@$domain'
|
|
"
|
|
|
|
chmod 750 "$final_path/static"
|
|
chown -R $app:www-data "$final_path/static"
|
|
|
|
#=================================================
|
|
# 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)
|
|
# TODO: ynh_use_logrotate
|
|
|
|
#=================================================
|
|
# INTEGRATE SERVICE IN YUNOHOST
|
|
#=================================================
|
|
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
|
|
|
|
yunohost service add $app --description="Pytition uWSGI app $app" --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 FAIL2BAN
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring Fail2Ban..." --weight=1
|
|
|
|
# Create a dedicated Fail2Ban config
|
|
# TODO: ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
|
|
|
|
#=================================================
|
|
# 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
|
|
|
|
# Only the admin can access the admin panel of the app (if the app has an admin panel)
|
|
# ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin
|
|
|
|
# Everyone can access the API part
|
|
# We don't want to display the tile in the SSO so we put --show_tile="false"
|
|
# And we don't want the YunoHost admin to be able to remove visitors group to this permission, so we put --protected="true"
|
|
# ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --show_tile="false" --protected="true"
|
|
|
|
#=================================================
|
|
# 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
|