diff --git a/README.md b/README.md index e205150..00697f9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -18,7 +18,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Huginn is a system for building agents that perform automated tasks for you online. They can read the web, watch for events, and take actions on your behalf. Huginn's Agents create and consume events, propagating them along a directed graph. Think of it as a hackable version of IFTTT or Zapier on your own server. You always know who has your data. You do. -**Shipped version:** 2022.03.24~ynh3 +**Shipped version:** 2022.08.18~ynh1 ## Screenshots @@ -42,4 +42,4 @@ or sudo yunohost app upgrade huginn -u https://github.com/YunoHost-Apps/huginn_ynh/tree/testing --debug ``` -**More info regarding app packaging:** +**More info regarding app packaging:** \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index aa6fe27..785c274 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,5 +1,5 @@ @@ -18,7 +18,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po Huginn is a system for building agents that perform automated tasks for you online. They can read the web, watch for events, and take actions on your behalf. Huginn's Agents create and consume events, propagating them along a directed graph. Think of it as a hackable version of IFTTT or Zapier on your own server. You always know who has your data. You do. -**Version incluse :** 2022.03.24~ynh3 +**Version incluse :** 2022.08.18~ynh1 ## Captures d’écran diff --git a/check_process b/check_process deleted file mode 100644 index 794499f..0000000 --- a/check_process +++ /dev/null @@ -1,24 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - is_public=1 - admin="john" - password="1Strong-Password" - invitation="invitationcode" - ; Checks - pkg_linter=1 - setup_sub_dir=0 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - # 2022.03.24~ynh1 - upgrade=1 from_commit=a91277b139619ac194956c997f77a52172a822d3 - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index ea69a03..0000000 --- a/conf/app.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://codeload.github.com/huginn/huginn/tar.gz/c68274384cc7e7d2ab24ef70e5280bcbd5ca57c6 -SOURCE_SUM=5794a7a1b230ebac01b3d409eb40d90f68c1646e4f042777134499c68315f72e -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/jobs.service b/conf/jobs.service index 0ecf68c..68b255c 100644 --- a/conf/jobs.service +++ b/conf/jobs.service @@ -6,11 +6,11 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/.env +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/.env Environment="__YNH_RUBY_LOAD_PATH__" ExecStart=/opt/rbenv/versions/__APP__/bin/bundle exec rails runner bin/threaded.rb -StandardOutput=append:__FINALPATH__/log/__APP__-jobs.log +StandardOutput=append:__INSTALL_DIR__/log/__APP__-jobs.log StandardError=inherit [Install] diff --git a/conf/nginx.conf b/conf/nginx.conf index 0416ddf..07d021f 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -2,7 +2,7 @@ location __PATH__/ { # Path to source - alias __FINALPATH__/public/; + alias __INSTALL_DIR__/public/; ## @huginn is a named location for the upstream fallback, see below. try_files $uri $uri/index.html $uri.html @huginn; @@ -20,12 +20,12 @@ location @huginn { proxy_connect_timeout 300; proxy_redirect off; - proxy_set_header Host $http_host; + proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-Ssl on; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Frame-Options SAMEORIGIN; - proxy_pass http://unix:/__FINALPATH__/tmp/sockets/unicorn.socket; + proxy_pass http://unix:/__INSTALL_DIR__/tmp/sockets/unicorn.socket; } diff --git a/conf/web.service b/conf/web.service index 740b6a9..12a5b4d 100644 --- a/conf/web.service +++ b/conf/web.service @@ -6,11 +6,11 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/.env +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/.env Environment="__YNH_RUBY_LOAD_PATH__" ExecStart=/opt/rbenv/versions/__APP__/bin/bundle exec unicorn -c config/unicorn.rb -StandardOutput=append:__FINALPATH__/log/__APP__-web.log +StandardOutput=append:__INSTALL_DIR__/log/__APP__-web.log StandardError=inherit [Install] diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md deleted file mode 100644 index e69de29..0000000 diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 71ee51e..0000000 --- a/manifest.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "name": "Huginn", - "id": "huginn", - "packaging_format": 1, - "description": { - "en": " Build agents that monitor and act on your behalf. Your agents are standing by!" - }, - "version": "2022.03.24~ynh3", - "url": "https://github.com/huginn/hugin", - "upstream": { - "license": "MIT", - "code": "https://github.com/huginn/huginn" - }, - "license": "MIT", - "maintainer": { - "name": "aurel", - "email": "aurel@grudu.ovh", - "url": "https://github.com/onde2rock/huginn_ynh" - }, - "requirements": { - "yunohost": ">= 11.0.9" - }, - "multi_instance": true, - "services": [ - "nginx", - "php7.3-fpm", - "mysql" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "is_public", - "type": "boolean", - "default": true - }, - { - "name": "admin", - "type": "user" - }, - { - "name": "password", - "type": "password" - }, - { - "name": "invitation", - "type": "string", - "ask": { - "en": "Choose an invitation code for new users" - }, - "example": "invitationcode" - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..04b5d01 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,94 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "huginn" +name = "Huginn" +description.en = "Build agents that monitor and act on your behalf. Your agents are standing by" + +version = "2022.08.18~ynh1" + +maintainers = ["aurel"] + +[upstream] +license = "MIT" +code = "https://github.com/huginn/huginn" + +[integration] +yunohost = ">= 11.2" +architectures = "all" +multi_instance = true +ldap = false +sso = false +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.init_main_permission] + type = "group" + default = "visitors" + + [install.admin] + type = "user" + + [install.password] + type = "password" + + [install.invitation] + ask.en = "Choose an invitation code for new users" + type = "string" + example = "invitationcode" + +[resources] + [resources.sources.main] + url = "https://github.com/huginn/huginn/archive/refs/tags/v2022.08.18.tar.gz" + sha256 = "845042042089a35c274bef41fc498cfd23733d923ab3772f4311212b42b356d9" + autoupdate.strategy = "latest_github_release" + + [resources.ports] + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + + [resources.apt] + packages = [ + "mariadb-server", + "default-libmysqlclient-dev", + "libyaml-dev", + "libgdbm-dev", + "libncurses5-dev", + "libffi-dev", + "libcurl4-openssl-dev", + "libicu-dev", + "python3-docutils", + "pkg-config", + "cmake", + "graphviz", + "jq", + "openssl", + + "autoconf", + "automake", + "bison", + "build-essential", + "curl", + "libjemalloc-dev", + "libreadline-dev", + "libsqlite3-dev", + "libssl-dev", + "libtool", + "libxml2-dev", + "libxslt-dev", + "zlib1g-dev", + ] + + [resources.database] + type = "mysql" diff --git a/scripts/_common.sh b/scripts/_common.sh index 75df75e..1704b0d 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,11 +4,7 @@ # COMMON VARIABLES #================================================= -# dependencies used by the app -pkg_dependencies="" -build_pkg_dependencies="default-libmysqlclient-dev libyaml-dev libgdbm-dev libncurses5-dev libffi-dev libcurl4-openssl-dev libicu-dev python3-docutils pkg-config cmake nodejs graphviz jq" - -ruby_version=2.6 +ruby_version=2.7 #================================================= # PERSONAL HELPERS diff --git a/scripts/backup b/scripts/backup index be50587..b32f7ce 100644 --- a/scripts/backup +++ b/scripts/backup @@ -10,27 +10,6 @@ source ../settings/scripts/_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 - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -40,20 +19,14 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= -# BACKUP THE NGINX CONFIGURATION +# SYSTEM CONFIGURATION #================================================= ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# SPECIFIC BACKUP -#================================================= -# BACKUP SYSTEMD -#================================================= - ynh_backup --src_path="/etc/systemd/system/$app-web.service" ynh_backup --src_path="/etc/systemd/system/$app-jobs.service" diff --git a/scripts/change_url b/scripts/change_url index fef5119..d0706b9 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,138 +9,41 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path="/" - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -# Add settings here as needed by your application -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) -port=$(ynh_app_setting_get --app=$app --key=port) -secret=$(ynh_app_setting_get --app=$app --key=secret) -invitation=$(ynh_app_setting_get --app=$app --key=invitation) - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - ynh_clean_check_starting - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. - ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - -#================================================= -# STANDARD MODIFICATIONS #================================================= # STOP SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Stopping a systemd service..." +ynh_script_progression --message="Stopping $app's systemd service..." -ynh_systemd_action --service_name=$app-web --action="stop" --log_path="/var/log/$app/$app.log" -ynh_systemd_action --service_name=$app-jobs --action="stop" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name="$app-web" --action="stop" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name="$app-jobs" --action="stop" --log_path="/var/log/$app/$app.log" #================================================= # MODIFY URL IN NGINX CONF #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# Change the path in the NGINX config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original NGINX config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated NGINX config - ynh_add_nginx_config -fi - -# Change the domain for NGINX -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location - ynh_delete_file_checksum --file="$nginx_conf_path" - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location - ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi +ynh_change_url_nginx_config #================================================= # SPECIFIC MODIFICATIONS #================================================= -# UPDATE A CONFIG FILE -#================================================= -ynh_script_progression --message="Updating a configuration file..." +ynh_script_progression --message="Updating $app's configuration file..." -domain=$new_domain -path_url=$new_path -ynh_add_config --template="../conf/.env.example" --destination="$final_path/.env" +#domain=$new_domain +#path=$new_path +ynh_add_config --template=".env.example" --destination="$install_dir/.env" -chmod 400 "$final_path/.env" -chown $app:$app "$final_path/.env" +chmod 400 "$install_dir/.env" +chown "$app:$app" "$install_dir/.env" -#================================================= -# GENERIC FINALISATION #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." +ynh_script_progression --message="Starting $app's systemd service..." # Start a systemd service -ynh_systemd_action --service_name="$app-web" --action="start" --log_path="/var/log/$app/$app-web.log" --line_match="listening on addr" -ynh_systemd_action --service_name="$app-jobs" --action="start" --log_path="$final_path/log/huginn-jobs.log" --line_match="listening on addr" - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." - -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name="$app-web" --action="start" --log_path="$install_dir/log/unicorn.log" --line_match="listening on addr" +ynh_systemd_action --service_name="$app-jobs" --action="start" --log_path="$install_dir/log/huginn-jobs.log" #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 2f25a88..89e996e 100755 --- a/scripts/install +++ b/scripts/install @@ -11,135 +11,58 @@ source ynh_install_ruby__2 source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# INITIALIZE AND STORE SETTINGS #================================================= -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="/" -is_public=$YNH_APP_ARG_IS_PUBLIC -admin=$YNH_APP_ARG_ADMIN -password=$YNH_APP_ARG_PASSWORD -invitation=$YNH_APP_ARG_INVITATION - -app=$YNH_APP_INSTANCE_NAME - secret=$(ynh_string_random --length=16) -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." - -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..." - -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 -ynh_app_setting_set --app=$app --key=invitation --value=$invitation -ynh_app_setting_set --app=$app --key=secret --value=$secret - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# FIND AND OPEN A PORT -#================================================= -ynh_script_progression --message="Finding an available port..." - -# Find an available port -port=$(ynh_find_port --port=8095) -ynh_app_setting_set --app=$app --key=port --value=$port +ynh_app_setting_set --app="$app" --key="secret" --value="$secret" #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Installing dependencies..." +ynh_script_progression --message="Installing Ruby..." -ynh_install_app_dependencies $pkg_dependencies $build_pkg_dependencies ynh_install_ruby --ruby_version=$ruby_version -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." - -# 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..." - -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..." -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" +ynh_setup_source --dest_dir="$install_dir" -mkdir -p "$final_path/log" "$final_path/tmp/pids" "$final_path/tmp/sockets" +mkdir -p "$install_dir/log" "$install_dir/tmp/pids" "$install_dir/tmp/sockets" -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..." - -# Create a dedicated NGINX config -ynh_add_nginx_config +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # SPECIFIC SETUP #================================================= # ADD A CONFIGURATION #================================================= -ynh_script_progression --message="Adding a configuration file..." +ynh_script_progression --message="Adding $app's configuration file..." -ynh_add_config --template="../conf/.env.example" --destination="$final_path/.env" +ynh_add_config --template=".env.example" --destination="$install_dir/.env" -chmod 400 "$final_path/.env" -chown $app:$app "$final_path/.env" +chmod 400 "$install_dir/.env" +chown "$app:$app" "$install_dir/.env" #================================================= # BUILD APP #================================================= ynh_script_progression --message="Building app..." -pushd $final_path +pushd "$install_dir" ynh_use_ruby cp config/unicorn.rb.example config/unicorn.rb - chown -R $app:www-data "$final_path/config/unicorn.rb" + chown -R $app:www-data "$install_dir/config/unicorn.rb" + ynh_gem install rubygems-update -v 3.4 ynh_gem update --system --no-document - ynh_gem install rake bundler foreman --no-document + ynh_gem install bundler -v 2.4.22 + ynh_gem install rake foreman --no-document bundle config set --local deployment 'true' bundle config set --local without 'development test' bundle install @@ -149,59 +72,32 @@ pushd $final_path ynh_exec_warn_less bundle exec rake assets:precompile RAILS_ENV=production popd -ynh_install_app_dependencies $pkg_dependencies - -chmod 750 "$final_path/public" -chmod -R o-rwx "$final_path/public" -chown -R $app:www-data "$final_path/public" +chmod 750 "$install_dir/public" +chmod -R o-rwx "$install_dir/public" +chown -R $app:www-data "$install_dir/public" #================================================= -# SETUP SYSTEMD +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring a systemd service..." +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 + +# Create a dedicated NGINX config +ynh_add_nginx_config # Create a dedicated systemd config ynh_add_systemd_config --service="$app-web" --template="web.service" ynh_add_systemd_config --service="$app-jobs" --template="jobs.service" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add "$app-web" --log="$final_path/log/unicorn.log" -yunohost service add "$app-jobs" --log="$final_path/log/production.log" +yunohost service add "$app-web" --log="$install_dir/log/unicorn.log" +yunohost service add "$app-jobs" --log="$install_dir/log/production.log" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." +ynh_script_progression --message="Starting $app's systemd services..." # Start a systemd service -ynh_systemd_action --service_name="$app-web" --action="start" --log_path="$final_path/log/unicorn.log" --line_match="listening on addr" -ynh_systemd_action --service_name="$app-jobs" --action="start" --log_path="$final_path/log/huginn-jobs.log" --line_match="Starting" - -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." - -# 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..." - -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name="$app-web" --action="start" --log_path="$install_dir/log/unicorn.log" --line_match="listening on addr" +ynh_systemd_action --service_name="$app-jobs" --action="start" --log_path="$install_dir/log/huginn-jobs.log" --line_match="Starting" #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 2588aed..b22478c 100755 --- a/scripts/remove +++ b/scripts/remove @@ -11,94 +11,28 @@ source ynh_install_ruby__2 source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -port=$(ynh_app_setting_get --app=$app --key=port) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE SERVICE INTEGRATION IN YUNOHOST +# REMOVE SYSTEM CONFIGURATIONS #================================================= +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 # Remove the service from the list of services known by YunoHost (added from `yunohost service add`) -if ynh_exec_warn_less yunohost service status "$app-web" >/dev/null -then - ynh_script_progression --message="Removing $app-web service integration..." - yunohost service remove "$app-web" +if ynh_exec_warn_less yunohost service status "$app-web" >/dev/null; then + yunohost service remove "$app-web" fi -if ynh_exec_warn_less yunohost service status "$app-jobs" >/dev/null -then - ynh_script_progression --message="Removing $app-jobs service integration..." - yunohost service remove "$app-jobs" -fi - -#================================================= -# STOP AND REMOVE SERVICE -#================================================= -ynh_script_progression --message="Stopping and removing the systemd service..." - # Remove the dedicated systemd config ynh_remove_systemd_config --service="$app-web" + +if ynh_exec_warn_less yunohost service status "$app-jobs" >/dev/null; then + yunohost service remove "$app-jobs" +fi +# Remove the dedicated systemd config ynh_remove_systemd_config --service="$app-jobs" -#================================================= -# REMOVE THE MYSQL DATABASE -#================================================= -ynh_script_progression --message="Removing the MySQL database..." - -# Remove a database if it exists, along with the associated user -ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name - -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - -#================================================= -# REMOVE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." - # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." - # Remove metapackage and its dependencies ynh_remove_ruby -ynh_remove_app_dependencies - -#================================================= -# SPECIFIC REMOVE -#================================================= -# REMOVE VARIOUS FILES -#================================================= -ynh_script_progression --message="Removing various files..." - -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." - -# Delete a system user -ynh_system_user_delete --username=$app #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 9035b60..00b6157 100644 --- a/scripts/restore +++ b/scripts/restore @@ -12,140 +12,75 @@ source ../settings/scripts/ynh_install_ruby__2 source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# REINSTALL DEPENDENCIES #================================================= +ynh_script_progression --message="Reinstalling Ruby..." -ynh_clean_setup () { - ynh_clean_check_starting -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX web server configuration..." - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" - -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" +ynh_install_ruby --ruby_version=$ruby_version #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -mkdir -p "$final_path/log" "$final_path/tmp/pids" "$final_path/tmp/sockets" +mkdir -p "$install_dir/log" "$install_dir/tmp/pids" "$install_dir/tmp/sockets" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - -#================================================= -# SPECIFIC RESTORATION -#================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." - -# Define and install dependencies -ynh_install_app_dependencies $pkg_dependencies $build_pkg_dependencies -ynh_install_ruby --ruby_version=$ruby_version +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # RESTORE THE MYSQL DATABASE #================================================= -ynh_script_progression --message="Restoring the MySQL database..." +ynh_script_progression --message="Restoring the MySQL database..." --weight=1 -db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) -ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd -ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql +ynh_mysql_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" < ./db.sql #================================================= # BUILD APP #================================================= ynh_script_progression --message="Building app..." -pushd $final_path +pushd "$install_dir" ynh_use_ruby + ynh_gem install rubygems-update -v 3.4 ynh_gem update --system --no-document - ynh_gem install rake bundler foreman --no-document + ynh_gem install bundler -v 2.4.22 + ynh_gem install rake foreman --no-document bundle config set --local deployment 'true' ynh_exec_warn_less bundle config set --local without 'development test' ynh_exec_warn_less bundle install ynh_exec_warn_less bundle exec rake assets:clean assets:precompile tmp:cache:clear RAILS_ENV=production popd -ynh_install_app_dependencies $pkg_dependencies - -chmod 750 "$final_path/public" -chmod -R o-rwx "$final_path/public" -chown -R $app:www-data "$final_path/public" +chmod 750 "$install_dir/public" +chmod -R o-rwx "$install_dir/public" +chown -R "$app:www-data" "$install_dir/public" #================================================= -# RESTORE SYSTEMD +# RESTORE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Restoring the systemd configuration..." +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 + +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore_file --origin_path="/etc/systemd/system/$app-web.service" -systemctl enable $app-web.service --quiet +systemctl enable "$app-web.service" --quiet +yunohost service add "$app-web" --log="$install_dir/log/unicorn.log" + ynh_restore_file --origin_path="/etc/systemd/system/$app-jobs.service" -systemctl enable $app-jobs.service --quiet - -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add "$app-web" --log="$final_path/log/unicorn.log" -yunohost service add "$app-jobs" --log="$final_path/log/production.log" +systemctl enable "$app-jobs.service" --quiet +yunohost service add "$app-jobs" --log="$install_dir/log/production.log" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." +ynh_script_progression --message="Reloading NGINX web server and $app's service..." # Start a systemd service -ynh_systemd_action --service_name="$app-web" --action="start" --log_path="$final_path/log/unicorn.log" --line_match="listening on addr" -ynh_systemd_action --service_name="$app-jobs" --action="start" --log_path="$final_path/log/huginn-jobs.log" --line_match="Starting" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." +ynh_systemd_action --service_name="$app-web" --action="start" --log_path="$install_dir/log/unicorn.log" --line_match="listening on addr" +ynh_systemd_action --service_name="$app-jobs" --action="start" --log_path="$install_dir/log/huginn-jobs.log" --line_match="Starting" ynh_systemd_action --service_name=nginx --action=reload diff --git a/scripts/upgrade b/scripts/upgrade index 9013e65..e8d2425 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -10,108 +10,34 @@ source _common.sh source ynh_install_ruby__2 source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -admin=$(ynh_app_setting_get --app=$app --key=admin) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) -port=$(ynh_app_setting_get --app=$app --key=port) -secret=$(ynh_app_setting_get --app=$app --key=secret) -invitation=$(ynh_app_setting_get --app=$app --key=invitation) - -#================================================= -# CHECK VERSION -#================================================= -ynh_script_progression --message="Checking version..." - -upgrade_type=$(ynh_check_app_version_changed) - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - ynh_clean_check_starting - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - #================================================= # STANDARD UPGRADE STEPS #================================================= # STOP SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Stopping a systemd service..." +ynh_script_progression --message="Stopping $app's systemd services..." -ynh_systemd_action --service_name=$app-web --action="stop" --log_path="/var/log/$app/$app.log" -ynh_systemd_action --service_name=$app-jobs --action="stop" --log_path="/var/log/$app/$app.log" - -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - -#================================================= -# DOWNLOAD, CHECK AND UNPACK SOURCE -#================================================= - -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." - - # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" --keep=".env" - mkdir -p "$final_path/log" "$final_path/tmp/pids" "$final_path/tmp/sockets" -fi - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." - -# Create a dedicated NGINX config -ynh_add_nginx_config +ynh_systemd_action --service_name="$app-web" --action="stop" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name="$app-jobs" --action="stop" --log_path="/var/log/$app/$app.log" #================================================= # UPGRADE DEPENDENCIES #================================================= -ynh_script_progression --message="Upgrading dependencies..." +ynh_script_progression --message="Upgrading Ruby..." --weight=1 -ynh_install_app_dependencies $pkg_dependencies $build_pkg_dependencies -ynh_install_ruby --ruby_version=$ruby_version +ynh_exec_warn_less ynh_install_ruby --ruby_version=$ruby_version + +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= +ynh_script_progression --message="Upgrading source files..." + +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$install_dir" --full_replace=1 --keep=".env" +mkdir -p "$install_dir/log" "$install_dir/tmp/pids" "$install_dir/tmp/sockets" + +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # SPECIFIC UPGRADE @@ -120,22 +46,24 @@ ynh_install_ruby --ruby_version=$ruby_version #================================================= ynh_script_progression --message="Updating a configuration file..." -ynh_add_config --template="../conf/.env.example" --destination="$final_path/.env" +ynh_add_config --template="../conf/.env.example" --destination="$install_dir/.env" -chmod 400 "$final_path/.env" -chown $app:$app "$final_path/.env" +chmod 400 "$install_dir/.env" +chown "$app:$app" "$install_dir/.env" #================================================= # BUILD APP #================================================= ynh_script_progression --message="Building app..." -pushd $final_path +pushd $install_dir ynh_use_ruby cp -f config/unicorn.rb.example config/unicorn.rb - chown -R $app:www-data "$final_path/config/unicorn.rb" + chown -R "$app:www-data" "$install_dir/config/unicorn.rb" + ynh_gem install rubygems-update -v 3.4 ynh_gem update --system --no-document - ynh_gem install rake bundler foreman --no-document + ynh_gem install bundler -v 2.4.22 + ynh_gem install rake foreman --no-document bundle config set --local deployment 'true' bundle config set --local without 'development test' bundle install @@ -143,46 +71,33 @@ pushd $final_path ynh_exec_warn_less bundle exec rake assets:clean assets:precompile tmp:cache:clear RAILS_ENV=production popd -ynh_install_app_dependencies $pkg_dependencies - -chmod 750 "$final_path/public" -chmod -R o-rwx "$final_path/public" -chown -R $app:www-data "$final_path/public" +chmod 750 "$install_dir/public" +chmod -R o-rwx "$install_dir/public" +chown -R "$app:www-data" "$install_dir/public" #================================================= -# SETUP SYSTEMD +# REAPPLY SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Upgrading systemd configuration..." +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 + +# Create a dedicated NGINX config +ynh_add_nginx_config # Create a dedicated systemd config ynh_add_systemd_config --service="$app-web" --template="web.service" +yunohost service add "$app-web" --log="$install_dir/log/unicorn.log" + ynh_add_systemd_config --service="$app-jobs" --template="jobs.service" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add "$app-web" --log="$final_path/log/unicorn.log" -yunohost service add "$app-jobs" --log="$final_path/log/production.log" +yunohost service add "$app-jobs" --log="$install_dir/log/production.log" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." +ynh_script_progression --message="Starting $app's systemd service..." # Start a systemd service -ynh_systemd_action --service_name="$app-web" --action="start" --log_path="$final_path/log/unicorn.log" --line_match="listening on addr" -ynh_systemd_action --service_name="$app-jobs" --action="start" --log_path="$final_path/log/huginn-jobs.log" --line_match="Starting" - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." - -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name="$app-web" --action="start" --log_path="$install_dir/log/unicorn.log" --line_match="listening on addr" +ynh_systemd_action --service_name="$app-jobs" --action="start" --log_path="$install_dir/log/huginn-jobs.log" --line_match="Starting" #================================================= # END OF SCRIPT diff --git a/scripts/ynh_install_ruby__2 b/scripts/ynh_install_ruby__2 index 58a3135..2b629a4 100644 --- a/scripts/ynh_install_ruby__2 +++ b/scripts/ynh_install_ruby__2 @@ -35,7 +35,7 @@ build_pkg_dependencies="$build_pkg_dependencies $build_ruby_dependencies" # However, $PATH is duplicated into $ruby_path to outlast any manipulation of $PATH # You can use the variable `$ynh_ruby_load_path` to quickly load your Ruby version # in $PATH for an usage into a separate script. -# Exemple: $ynh_ruby_load_path $final_path/script_that_use_gem.sh` +# Exemple: $ynh_ruby_load_path $install_dir/script_that_use_gem.sh` # # # Finally, to start a Ruby service with the correct version, 2 solutions @@ -80,7 +80,7 @@ ynh_use_ruby () { ynh_ruby_load_path="PATH=$PATH" # Sets the local application-specific Ruby version - pushd $final_path + pushd $install_dir $rbenv_install_dir/bin/rbenv local $ruby_version popd } @@ -286,7 +286,7 @@ ynh_cleanup_ruby () { required_ruby_versions="${installed_app_ruby_version}\n${required_ruby_versions}" fi done - + # Remove no more needed Ruby versions local installed_ruby_versions=$(rbenv versions --bare --skip-aliases | grep -Ev '/') for installed_ruby_version in $installed_ruby_versions diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..aca06cc --- /dev/null +++ b/tests.toml @@ -0,0 +1,11 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + # ------------------------------- + # Default args to use for install + # ------------------------------- + + args.invitation = "invitationcode"