diff --git a/scripts/install b/scripts/install index 933018a..a99e3af 100644 --- a/scripts/install +++ b/scripts/install @@ -13,10 +13,17 @@ 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 +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= + domain=$YNH_APP_ARG_DOMAIN path=$YNH_APP_ARG_PATH is_public=$YNH_APP_ARG_IS_PUBLIC @@ -25,76 +32,117 @@ app=$YNH_APP_INSTANCE_NAME script_dir=$PWD -# Check variables are not empty -CHECK_VAR "$app" "app name not set" -CHECK_VAR "$script_dir" "script_dir not set" +#================================================= +# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS +#================================================= -CHECK_PATH # Check and fix path syntax -CHECK_DOMAINPATH # Check and fix domain disponibility +### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app". +### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app" +final_path=/var/www/$app +test ! -e "$final_path" || ynh_die "This path already contains a folder" -CHECK_FINALPATH # Check final path - -# Check domain with regex domain_regex=$(echo "$domain" | sed 's@-@.@g') + +# Normalize the url path syntax +path_url=$(ynh_normalize_url_path $path_url) + +# Check web path availability +ynh_webpath_available $domain $path_url +# Register (book) web path +ynh_webpath_register $app $domain $path_url CHECK_VAR "$domain_regex" "domain_regex empty" -FIND_PORT 8096 # Check port availability +#================================================= +# FIND AND OPEN A PORT +#================================================= + +# Find a free port +port=$(ynh_find_port 8095) +# Open this port +yunohost firewall allow --no-upnp TCP $port 2>&1 + +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= -# Save app settings ynh_app_setting_set $app domain $domain ynh_app_setting_set $app is_public $is_public ynh_app_setting_set $app port $port -# Install dependencies -ynh_package_update -ynh_package_install build-essential libssl-dev libpq-dev - -# Copy files to the right place -sudo mkdir "${final_path}" -ynh_app_setting_set $app final_path $final_path - -# Get source -SETUP_SOURCE - -# Copy it to Nginx conf directory -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf - -if [ $is_public -eq 1 ]; -then - sudo sed -i "s@#--PRIVATE--@@g" /etc/nginx/conf.d/$domain.d/$app.conf -fi - -## Copy and fix variable into lstu config -sudo cp ../conf/lstu.conf.template "${final_path}/lstu.conf" -sudo sed -i "s@__DOMAIN__@$domain@g" "${final_path}/lstu.conf" -sudo sed -i "s@__PATH__@$path@g" "${final_path}/lstu.conf" -sudo sed -i "s@__PORT__@$port@g" "${final_path}/lstu.conf" - -secret=$(ynh_string_random 24) -CHECK_VAR "$secret" "secret empty" -sudo sed -i "s@__SECRET__@$secret@g" "${final_path}/lstu.conf" -STORE_MD5_CONFIG "lstu.conf" "${final_path}/lstu.conf" - -# Install systemd script -sudo cp ../conf/lstu.service /etc/systemd/system/lstu.service -sudo chown root: /etc/systemd/system/lstu.service -sudo sed -i "s@__FINALPATH__@$final_path/@g" /etc/systemd/system/lstu.service - -# Install logrotate -sudo cp ../conf/logrotate /etc/logrotate.d/$app -sudo sed -i "s@__FINALPATH__@$final_path@g" /etc/logrotate.d/$app +#================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_install_app_dependencies build-essential libssl-dev libpq-dev # Install Carton echo yes | sudo cpan Carton -# Install lstu's dependencies via carton -sudo mkdir -p /var/log/$app/ -cd $final_path -sudo carton install 2>&1 | sudo tee -a "/var/log/$app/setup_carton.log" +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= -# Change variables in nginx configuration -sudo sed -i "s@__PATH__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf -sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf +ynh_app_setting_set $app final_path $final_path +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source "$final_path" + +#================================================= +# NGINX CONFIGURATION +#================================================= + +### `ynh_add_nginx_config` will use the file conf/nginx.conf + +# Create a dedicated nginx config +ynh_add_nginx_config + +#================================================= +# CREATE DEDICATED USER +#================================================= + +# Create a system user +ynh_system_user_create $app + +#================================================= +## Copy and fix variable into lstu config +#================================================= + +cp ../conf/lstu.conf.template "${final_path}/lstu.conf" +ynh_replace_string "__DOMAIN__" "$domain" "${final_path}/lstu.conf" +ynh_replace_string "__PATH__" "$path_url" "${final_path}/lstu.conf" +ynh_replace_string "__PORT__" "$port" "${final_path}/lstu.conf" + +secret=$(ynh_string_random 24) +ynh_replace_string "__SECRET__" "$secret" "${final_path}/lstu.conf" +ynh_store_file_checksum "${final_path}/lstu.conf" + +#================================================= +# SETUP SYSTEMD +#================================================= + +# Create a dedicated systemd config +ynh_add_systemd_config + +#================================================= +# Install lstu's dependencies via carton +#================================================= + +carton install 2>&1 | sudo tee -a "/var/log/$app/setup_carton.log" + +#================================================= +# SETUP LOGROTATE +#================================================= + +# Use logrotate to manage application logfile(s) +ynh_use_logrotate + +#================================================= +# ADVERTISE SERVICE IN ADMIN PANEL +#================================================= + +yunohost service add $app --log "/var/log/$app.log" + +#================================================= +# SETUP SSOWAT +#================================================= # Make app public or private ynh_app_setting_set $app skipped_uris "/" @@ -104,34 +152,35 @@ then # If the app is private, only the shortened URLs are publics path="" fi ynh_app_setting_set $app protected_regex "$domain_regex$path/login$","$domain_regex$path/logout$","$domain_regex$path/api$","$domain_regex$path/extensions$","$domain_regex$path/stats$","$domain_regex$path/d/.*$","$domain_regex$path/a$","$domain_regex$path/$" +else + ynh_replace_string "#--PRIVATE--" "" "/etc/nginx/conf.d/$domain.d/$app.conf" fi + +#================================================= # Making log symbolic link to /var/log -sudo touch /var/log/$app/production.log -sudo chown www-data: /var/log/$app/production.log -sudo ln -s /var/log/$app/production.log "$final_path/log/production.log" +#================================================= +touch /var/log/$app/production.log +chown $app:$app /var/log/$app/production.log +ln -s /var/log/$app/production.log "$final_path/log/production.log" + +#================================================= # Configure owner -sudo chown -R www-data: $final_path +#================================================= +sudo chown -R $app:$app $final_path + +#================================================= # Start lstu -sudo systemctl daemon-reload -sudo systemctl start lstu.service -sudo systemctl enable lstu.service +#================================================= -# Set right permissions on new files created at first start -sudo chown -R www-data: "$final_path" +systemctl enable lstu.service +systemctl start lstu.service -# Add lstu as a service -sudo yunohost service add lstu -l $final_path/log/production.log - -if [ $is_public -eq 0 ]; -then - # Delete public access - ynh_app_setting_delete $app unprotected_uris - # Regenerate SSOwat's configuration - sudo yunohost app ssowatconf -fi +#================================================= +# RELOAD NGINX +#================================================= # Reload Nginx sudo service nginx reload