From 7543c864ac9795c345421f6685b0ca3970e3617a Mon Sep 17 00:00:00 2001 From: Fabian Wilkens Date: Tue, 22 Dec 2020 17:40:51 +0100 Subject: [PATCH] Updatet scripts. Cleanup --- README.md | 77 ++++++++---------- README_fr.md | 77 ------------------ conf/app.src | 5 -- manifest.json | 16 +--- scripts/_common.sh | 1 - scripts/backup | 14 +--- scripts/change_url | 5 +- scripts/install | 11 ++- scripts/restore | 38 ++++----- scripts/upgrade | 199 ++++++++++++++++++++++++++++++--------------- 10 files changed, 201 insertions(+), 242 deletions(-) delete mode 100644 README_fr.md delete mode 100644 conf/app.src diff --git a/README.md b/README.md index c4bc9db..b73becf 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,63 @@ -# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE) -- Copy this app before working on it. -- Edit `conf/nginx.conf` file to match application prerequisites. -- Edit `manifest.json` with application specific information. -- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts. - - Using the [script helpers documentation.](https://helpers.yunohost.org/) -- Add a `LICENSE` file for the package. -- Edit `README.md` and README_fr.md. +# Standard Notes Web App for YunoHost -# Example app for YunoHost +[![Integration level](https://dash.yunohost.org/integration/snweb.svg)](https://dash.yunohost.org/appci/app/snweb) +[![Install snweb with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=snweb) -[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) -[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP) - -*[Lire ce readme en français.](./README_fr.md)* - -> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server. +> *This package allow you to install snweb quickly and simply on a YunoHost server. If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* ## Overview -Quick description of this app. +Standard Notes -**Shipped version:** 1.0 +A safe and private place for your life's work. + +Standard Notes is a simple and private notes app available on most platforms, including Web, Mac, Windows, Linux, iOS, and Android. It focuses on simplicity, and encrypts data locally before it ever touches a cloud. This means no one can read your notes but you (not even us). + +**Shipped version:** 3.5.11 +* Apps available for free. https://standardnotes.org/ +* Desktop (Windows, Mac, Linux) +* Mobile (Android and iOS) +* Web https://app.standardnotes.org/ +* Self-Hosted Yunohost - Syncing Server https://github.com/FabianWilkens/snweb_ynh ## Screenshots -![](Link to an screenshot for this app) +![](https://camo.githubusercontent.com/ca3744729c6c33f2f42d7917a4e7167c12a786615e14d1719f7d1ec6ed77aae8/68747470733a2f2f7374616e646172646e6f7465732e6f72672f6173736574732f686f6d65706167652d6865726f2e706e67) +Extensions, Editors, Themes: https://standardnotes.org/extensions + ## Demo -* [Official demo](Link to a demo site for this app) + * [Official demo - Web App](https://standardnotes.org/demo) ## Configuration -How to configure this app: by an admin panel, a plain file with SSH, or any other way. +How to configure this app: +* The config-file is stored under "/opt/yunohost/$app/live/.env" ## Documentation - * Official documentation: Link to the official documentation of this app - * YunoHost documentation: If specific documentation is needed, feel free to contribute. + * Official Help & Support: https://standardnotes.org/help + * Official documentation: https://docs.standardnotes.org (Only delevopment documentation) ## YunoHost specific features #### Multi-users support -Are LDAP and HTTP auth supported? -Can the app be used by multiple users? +Are LDAP and HTTP auth supported? LDAP -> NO, HTTP auth -> Yes + +Can the app be used by multiple users? Yes #### Supported architectures -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other information you would add about this application - -**More information on the documentation page:** -https://yunohost.org/packaging_apps + * x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/snweb%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/snweb/) + * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/snweb%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/snweb/) ## Links - * Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues - * App website: Link to the official website of this app - * Upstream app repository: Link to the official repository of the upstream app + * Report a bug: https://github.com/YunoHost-Apps/snweb_ynh/issues + * App website: https://standardnotes.org/ + * Upstream app repository: https://github.com/standardnotes/web * YunoHost website: https://yunohost.org/ --- @@ -75,11 +66,11 @@ Developers info ---------------- **Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). +Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/snweb_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/snweb_ynh/tree/testing --debug or -sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app upgrade snweb -u https://github.com/YunoHost-Apps/snweb_ynh/tree/testing --debug ``` diff --git a/README_fr.md b/README_fr.md deleted file mode 100644 index c37d358..0000000 --- a/README_fr.md +++ /dev/null @@ -1,77 +0,0 @@ -# App exemple pour YunoHost - -[![Niveau d'intégration](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) -[![Installer REPLACEBYYOURAPP avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP) - -*[Read this readme in english.](./README.md)* - -> *Ce package vous permet d'installer REPLACEBYYOURAPP rapidement et simplement sur un serveur Yunohost. -Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* - -## Vue d'ensemble -Description rapide de cette application. - -**Version incluse:** 1.0 - -## Captures d'écran - -![](Lien vers une capture d'écran pour cette application) - -## Démo - -* [Démo officielle](Lien vers un site de démonstration pour cette application) - -## Configuration - -Comment configurer cette application: via le panneau d'administration, un fichier brut en SSH ou tout autre moyen. - -## Documentation - - * Documentation officielle: Lien vers la documentation officielle de cette application - * Documentation YunoHost: Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateurs - -L'authentification LDAP et HTTP est-elle prise en charge? -L'application peut-elle être utilisée par plusieurs utilisateurs? - -#### Architectures supportées - -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/) -* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/) - -## Limitations - -* Limitations connues. - -## Informations additionnelles - -* Autres informations à ajouter sur cette application - -**Plus d'informations sur la page de documentation:** -https://yunohost.org/packaging_apps - -## Liens - - * Signaler un bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues - * Site de l'application: Lien vers le site officiel de cette application - * Dépôt de l'application principale: Lien vers le dépôt officiel de l'application principale - * Site web YunoHost: https://yunohost.org/ - ---- - -Informations pour les développeurs ----------------- - -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). - -Pour essayer la branche testing, procédez comme suit. -``` -sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug -ou -sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug -``` diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index 17c6249..0000000 --- a/conf/app.src +++ /dev/null @@ -1,5 +0,0 @@ -SOURCE_URL=https://github.com/standardnotes/web/archive/3.5.11.tar.gz -SOURCE_SUM=6f3cbc638c9ba357696da52be2b9cbfadcc1d0b75d62355b182047b527086b09 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true diff --git a/manifest.json b/manifest.json index d5425ef..211c378 100644 --- a/manifest.json +++ b/manifest.json @@ -3,9 +3,9 @@ "id": "snweb", "packaging_format": 1, "description": { - "en": "Standard Notes Web App. An end-to-end encrypted note-taking app. Web, Mac, Windows, Linux, iOS, and Android." + "en": "The Standard Notes Web App. An end-to-end encrypted note-taking app. Web, Mac, Windows, Linux, iOS, and Android." }, - "version": "3.0.14~ynh1", + "version": "3.5.11~ynh1", "url": "https://github.com/standardnotes/web", "license": "free", "maintainer": { @@ -14,7 +14,7 @@ "url": "https://github.com/FabianWilkens/snweb_ynh" }, "requirements": { - "yunohost": ">= 3.5" + "yunohost": ">= 4.0" }, "multi_instance": true, "services": [ @@ -63,16 +63,6 @@ }, "default": true }, - { - "name": "language", - "type": "string", - "ask": { - "en": "Choose the application language", - "fr": "Choisissez la langue de l'application", - "de": "Wähle die Application Sprache" - }, - "default": "en" - }, { "name": "snserver_domain", "type": "string", diff --git a/scripts/_common.sh b/scripts/_common.sh index 1c65ab0..f3ad9eb 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -5,7 +5,6 @@ #================================================= # dependencies used by the app -#pkg_dependencies="libsqlite3-dev default-libmysqlclient-dev" pkg_dependencies="\ zlib1g-dev \ libssl-dev \ diff --git a/scripts/backup b/scripts/backup index 870a408..2e567d3 100755 --- a/scripts/backup +++ b/scripts/backup @@ -30,7 +30,6 @@ 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) #================================================= # STANDARD BACKUP STEPS @@ -55,20 +54,13 @@ ynh_script_progression --message="Backing up nginx web server configuration..." ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# BACKUP THE MYSQL DATABASE -#================================================= -ynh_script_progression --message="Backing up the MySQL database..." --time --weight=1 - -ynh_mysql_dump_db --database="$db_name" > db.sql - #================================================= # BACKUP FAIL2BAN CONFIGURATION #================================================= -ynh_script_progression --message="Backing up fail2ban configuration..." --time --weight=1 +#ynh_script_progression --message="Backing up fail2ban configuration..." --time --weight=1 -ynh_backup --src_path="/etc/fail2ban/jail.d/$app.conf" -ynh_backup --src_path="/etc/fail2ban/filter.d/$app.conf" +#ynh_backup --src_path="/etc/fail2ban/jail.d/$app.conf" +#ynh_backup --src_path="/etc/fail2ban/filter.d/$app.conf" #================================================= # SPECIFIC BACKUP diff --git a/scripts/change_url b/scripts/change_url index 3f21bc8..c3b6f73 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -108,7 +108,10 @@ fi #================================================= # SPECIFIC MODIFICATIONS #================================================= -# ... + +config_file="$final_path/live/.env" +ynh_replace_string --match_string="APP_HOST=http://localhost:3001" --replace_string="APP_HOST=https://$domain${path_url%/}" --target_file="$config_file" + #================================================= #================================================= diff --git a/scripts/install b/scripts/install index d1302b7..0974e43 100644 --- a/scripts/install +++ b/scripts/install @@ -123,8 +123,7 @@ ynh_replace_string --match_string="RAILS_ENV=development" --replace_string="RAIL ynh_replace_string --match_string="PORT=3001" --replace_string="PORT=$port" --target_file="$config_file" secret_key=$(ynh_string_random --length=48 | base64) ynh_replace_string --match_string="SECRET_KEY_BASE=test" --replace_string="SECRET_KEY_BASE=$secret_key" --target_file="$config_file" - - +ynh_replace_string --match_string="APP_HOST=http://localhost:3001" --replace_string="APP_HOST=https://$domain${path_url%/}" --target_file="$config_file" if [ "$snserver_domain" = "" ]; then snserver_domain="sync.standardnotes.org" fi @@ -142,7 +141,6 @@ chown -R $app: "$final_path" pushd "$final_path/live" git submodule update --init --recursive ynh_use_nodejs - #exec_as $app $ENV_PATH $ynh_npm run setup exec_as $app $ENV_PATH $ynh_npm ci env PATH=$ENV_PATH /opt/rbenv/versions/$RUBY_VERSION/bin/gem install bundler env PATH=$ENV_PATH /opt/rbenv/versions/$RUBY_VERSION/bin/bundler install @@ -202,14 +200,14 @@ ynh_script_progression --message="Configuring log rotation..." # Use logrotate to manage application logfile(s) ynh_use_logrotate --logfile="$final_path/live/log/production.log" -ynh_use_logrotate --logfile="/var/log/$app/snweb.log" +ynh_use_logrotate --logfile="/var/log/$app/$app.log" #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= ynh_script_progression --message="Integrating service in YunoHost..." -yunohost service add $app --description "Standard Notes - Web Frontend" +yunohost service add $app --description "Standard Notes" --log "/var/log/$app/$app.log" #================================================= # START SYSTEMD SERVICE @@ -217,7 +215,8 @@ yunohost service add $app --description "Standard Notes - Web Frontend" ynh_script_progression --message="Starting a systemd service..." # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" + #================================================= # SETUP SSOWAT diff --git a/scripts/restore b/scripts/restore index 272e31c..6a6667c 100755 --- a/scripts/restore +++ b/scripts/restore @@ -8,6 +8,7 @@ #Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh +source ../settings/scripts/ynh_install_ruby source /usr/share/yunohost/helpers #================================================= @@ -31,8 +32,6 @@ 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 @@ -65,16 +64,24 @@ ynh_restore_file --origin_path="$final_path" ynh_script_progression --message="Recreating the dedicated system user..." --time --weight=1 # Create the dedicated user (if not existing) -ynh_system_user_create --username=$app +ynh_system_user_create --username=$app --home_dir=$final_path #================================================= # RESTORE USER RIGHTS #================================================= # Restore permissions on app files -chown -R "$app":"$app" $final_path -mkdir -p "/var/log/$app" -chown -R "$app":"$app" /var/log/$app +chown -R root:root "$final_path" +chown $app: "$final_path" +mkdir -p $app: "$final_path/.config" +chown $app: "$final_path/.config" +mkdir -p "$final_path/live/log" +chown -R $app: "$final_path/live/log" +mkdir -p "$final_path/live/public" +chown -R $app: "$final_path/live/public" +mkdir -p "$final_path/live/tmp" +chown -R $app: "$final_path/live/tmp" +chown $app: "$final_path/live/Gemfile.lock" #================================================= # RESTORE FAIL2BAN CONFIGURATION @@ -94,15 +101,9 @@ ynh_script_progression --message="Reinstalling dependencies..." --time --weight= # Define and install dependencies ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# RESTORE THE MYSQL DATABASE -#================================================= -ynh_script_progression --message="Restoring the MySQL database..." --time --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_install_nodejs --nodejs_version=$NODEJS_VERSION +ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" +ynh_install_ruby --ruby_version=$RUBY_VERSION #================================================= # RESTORE SYSTEMD @@ -116,7 +117,7 @@ systemctl enable $app.service # INTEGRATE SERVICE IN YUNOHOST #================================================= -yunohost service add $app --description "A short description of the app" --log "/var/log/$app/$app.log" +yunohost service add $app --description "Standard Notes" --log "/var/log/$app/$app.log" #================================================= # START SYSTEMD SERVICE @@ -134,11 +135,10 @@ ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= # GENERIC FINALIZATION #================================================= -# RELOAD NGINX AND PHP-FPM +# RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading nginx web server and php-fpm..." --time --weight=1 +ynh_script_progression --message="Reloading nginx web server..." --time --weight=1 -ynh_systemd_action --service_name=php7.0-fpm --action=reload ynh_systemd_action --service_name=nginx --action=reload #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 593550f..de82f3c 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -7,6 +7,7 @@ #================================================= source _common.sh +source ynh_install_ruby source /usr/share/yunohost/helpers #================================================= @@ -18,11 +19,8 @@ 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) is_public=$(ynh_app_setting_get --app=$app --key=is_public) final_path=$(ynh_app_setting_get --app=$app --key=final_path) -language=$(ynh_app_setting_get --app=$app --key=language) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) #================================================= # CHECK VERSION @@ -50,15 +48,9 @@ elif [ "$is_public" = "No" ]; then is_public=0 fi -# If db_name doesn't exist, create it -if [ -z "$db_name" ]; then - db_name=$(ynh_sanitize_dbid --db_name=$app) - ynh_app_setting_set --app=$app --key=db_name --value=$db_name -fi - # If final_path doesn't exist, create it if [ -z "$final_path" ]; then - final_path=/var/www/$app + final_path=/opt/yunohost/$app ynh_app_setting_set --app=$app --key=final_path --value=$final_path fi @@ -76,18 +68,6 @@ ynh_clean_setup () { # Exit if an error occurs during the execution of the script ynh_abort_if_errors -#================================================= -# CHECK THE PATH -#================================================= - -# Normalize the URL path syntax -# N.B. : this is for app installations before YunoHost 2.7 -# where this value might be something like /foo/ or foo/ -# instead of /foo .... -# If nobody installed your app before 2.7, then you may -# safely remove this line -path_url=$(ynh_normalize_url_path --path_url=$path_url) - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -97,16 +77,39 @@ ynh_script_progression --message="Stopping a systemd service..." --time --weight ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" +#================================================= +# UPGRADE DEPENDENCIES +#================================================= +ynh_script_progression --message="Upgrading dependencies..." --time --weight=1 + +ynh_install_app_dependencies $pkg_dependencies +ynh_install_nodejs --nodejs_version=$NODEJS_VERSION +ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" + #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= - if [ "$upgrade_type" == "UPGRADE_APP" ] then ynh_script_progression --message="Upgrading source files..." --time --weight=1 - # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" + # Backup files to keep + tmpdir=$(mktemp -d) + if [ -d $final_path/live/log ] ; then + cp -Rp $final_path/live/log $tmpdir + fi + # Remove destination directory + ynh_secure_remove --file=$final_path + # Download + mkdir -p "$final_path" + git clone $SOURCE "$final_path/live" --quiet + pushd "$final_path/live" + git checkout $COMMIT --quiet + popd + # Restore files + if [ -d $tmpdir/log ] ; then + cp -Rp $tmpdir/log $final + fi fi #================================================= @@ -115,14 +118,8 @@ fi ynh_script_progression --message="Upgrading nginx web server configuration..." --time --weight=1 # Create a dedicated nginx config -ynh_add_nginx_config +ynh_add_nginx_config "port" -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --time --weight=1 - -ynh_install_app_dependencies $pkg_dependencies #================================================= # CREATE DEDICATED USER @@ -130,31 +127,59 @@ ynh_install_app_dependencies $pkg_dependencies ynh_script_progression --message="Making sure dedicated system user exists..." --time --weight=1 # Create a dedicated user (if not existing) -ynh_system_user_create --username=$app +ynh_system_user_create --username=$app --home_dir=$final_path #================================================= # SPECIFIC UPGRADE #================================================= -# ... +# INSTALLING RUBY AND BUNDLER #================================================= +ynh_script_progression --message="Installing Ruby..." --weight=331 + +ynh_install_ruby --ruby_version=$RUBY_VERSION #================================================= -# STORE THE CONFIG FILE CHECKSUM +# MODIFY A CONFIG FILE #================================================= - -### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. -### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it. -ynh_backup_if_checksum_is_different --file="$final_path/CONFIG_FILE" -# Recalculate and store the checksum of the file for the next upgrade. -ynh_store_file_checksum --file="$final_path/CONFIG_FILE" +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Modifying a config file..." --time --weight=2 + + config_file="$final_path/live/.env" + cp -f ../conf/env.sample $config_file + + ynh_replace_string --match_string="RAILS_ENV=development" --replace_string="RAILS_ENV=production" --target_file="$config_file" + ynh_replace_string --match_string="PORT=3001" --replace_string="PORT=$port" --target_file="$config_file" + secret_key=$(ynh_string_random --length=48 | base64) + ynh_replace_string --match_string="SECRET_KEY_BASE=test" --replace_string="SECRET_KEY_BASE=$secret_key" --target_file="$config_file" + ynh_replace_string --match_string="APP_HOST=http://localhost:3001" --replace_string="APP_HOST=https://$domain${path_url%/}" --target_file="$config_file" + if [ "$snserver_domain" = "" ]; then + snserver_domain="sync.standardnotes.org" + fi + ynh_replace_string --match_string="SF_DEFAULT_SERVER=http://localhost:3000" --replace_string="SF_DEFAULT_SERVER=https://$snserver_domain" --target_file="$config_file" +fi #================================================= -# SETUP LOGROTATE +# BUILDING #================================================= -ynh_script_progression --message="Upgrading logrotate configuration..." --time --weight=1 - -# Use logrotate to manage app-specific logfile(s) -ynh_use_logrotate --non-append +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Building..." + + ENV_PATH="$ynh_node_load_PATH:/opt/rbenv/versions/$RUBY_VERSION/bin" + + chown -R $app: "$final_path" + + pushd "$final_path/live" + git submodule update --init --recursive + ynh_use_nodejs + exec_as $app $ENV_PATH $ynh_npm ci + env PATH=$ENV_PATH /opt/rbenv/versions/$RUBY_VERSION/bin/gem install bundler + env PATH=$ENV_PATH /opt/rbenv/versions/$RUBY_VERSION/bin/bundler install + exec_as $app $ENV_PATH $ynh_npm run bundle + exec_as $app $ENV_PATH /opt/rbenv/versions/$RUBY_VERSION/bin/bundle exec rails assets:precompile + popd +fi #================================================= # SETUP SYSTEMD @@ -162,24 +187,73 @@ ynh_use_logrotate --non-append ynh_script_progression --message="Upgrading systemd configuration..." --time --weight=1 # Create a dedicated systemd config -ynh_add_systemd_config +ynh_add_systemd_config --others_var="\ + port \ + ENV_PATH \ + RUBY_VERSION \ +" + +#================================================= +# STORE THE CONFIG FILE CHECKSUM +#================================================= + +ynh_store_file_checksum --file="$config_file" +ynh_store_file_checksum --file="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # GENERIC FINALIZATION -#================================================= -# UPGRADE FAIL2BAN -#================================================= -ynh_script_progression --message="Reconfiguring fail2ban..." --time --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" - #================================================= # SECURE FILES AND DIRECTORIES #================================================= +ynh_script_progression --message="Securing files and directories..." -# Set permissions on app files -chown -R root: $final_path +# Set permissions to app files +chown -R root:root "$final_path" +chown $app: "$final_path" +mkdir -p $app: "$final_path/.config" +chown $app: "$final_path/.config" +mkdir -p "$final_path/live/log" +chown -R $app: "$final_path/live/log" +mkdir -p "$final_path/live/public" +chown -R $app: "$final_path/live/public" +mkdir -p "$final_path/live/tmp" +chown -R $app: "$final_path/live/tmp" +chown $app: "$final_path/live/Gemfile.lock" + +mkdir -p "/var/log/$app" +chown -R $app: "/var/log/$app" + +#================================================= +# SETUP LOGROTATE +#================================================= +ynh_script_progression --message="Upgrading logrotate configuration..." + +# Use logrotate to manage application logfile(s) +ynh_use_logrotate --logfile="$final_path/live/log/production.log" +ynh_use_logrotate --logfile="/var/log/$app/$app.log" + +#================================================= +# INTEGRATE SERVICE IN YUNOHOST +#================================================= +ynh_script_progression --message="Integrating service in YunoHost..." + +yunohost service add $app --description "Standard Notes" --log "/var/log/$app/$app.log" + +#================================================= +# START SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Starting a systemd service..." + +# Start a systemd service +ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" + +#================================================= +# UPGRADE FAIL2BAN +#================================================= +#ynh_script_progression --message="Reconfiguring fail2ban..." --time --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" #================================================= # SETUP SSOWAT @@ -189,17 +263,10 @@ ynh_script_progression --message="Upgrading SSOwat configuration..." --time --we # Make app public if necessary if [ $is_public -eq 1 ] then - # unprotected_uris allows SSO credentials to be passed anyway - ynh_app_setting_set --app=$app --key=unprotected_uris --value="/" + # Create the visitors permission if needed + ynh_permission_update --permission "main" --add "visitors" fi -#================================================= -# START SYSTEMD SERVICE -#================================================= -ynh_script_progression --message="Starting a systemd service..." --time --weight=1 - -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" - #================================================= # RELOAD NGINX #=================================================