From fd77397a23e35287dda9b3b86ca989e52f0bf189 Mon Sep 17 00:00:00 2001 From: Thomas <51749973+Thovi98@users.noreply.github.com> Date: Sun, 19 Nov 2023 16:41:50 +0100 Subject: [PATCH] convert to v_2 --- .github/workflows/updater.sh | 137 -------------------- README.md | 1 - README_fr.md | 1 - conf/app.src | 7 -- conf/ldap.src | 7 -- conf/nginx.conf | 6 +- conf/overleaf-chat.service | 6 +- conf/overleaf-clsi.service | 6 +- conf/overleaf-contacts.service | 6 +- conf/overleaf-docstore.service | 6 +- conf/overleaf-document-updater.service | 6 +- conf/overleaf-filestore.service | 6 +- conf/overleaf-notifications.service | 6 +- conf/overleaf-real-time.service | 6 +- conf/overleaf-spelling.service | 6 +- conf/overleaf-track-changes.service | 6 +- conf/overleaf-web.service | 6 +- conf/settings.js | 4 +- conf/variables.env | 4 +- manifest.toml | 75 +++++++++++ scripts/_common.sh | 4 +- scripts/backup | 20 +-- scripts/change_url | 96 +++++++------- scripts/install | 166 ++++++++++++------------- scripts/remove | 30 ++--- scripts/restore | 56 ++++----- scripts/upgrade | 138 ++++++++++---------- 27 files changed, 371 insertions(+), 447 deletions(-) delete mode 100755 .github/workflows/updater.sh delete mode 100644 conf/app.src delete mode 100644 conf/ldap.src create mode 100644 manifest.toml diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh deleted file mode 100755 index 72eb5cb..0000000 --- a/.github/workflows/updater.sh +++ /dev/null @@ -1,137 +0,0 @@ -#!/bin/bash - -#================================================= -# PACKAGE UPDATING HELPER -#================================================= - -# This script is meant to be run by GitHub Actions -# The YunoHost-Apps organisation offers a template Action to run this script periodically -# Since each app is different, maintainers can adapt its contents so as to perform -# automatic actions when a new upstream release is detected. - -# Remove this exit command when you are ready to run this Action -exit 1 - -#================================================= -# FETCHING LATEST RELEASE AND ITS ASSETS -#================================================= - -# Fetching information -current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') -repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') -# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) -version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) -assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) - -# Later down the script, we assume the version has only digits and dots -# Sometimes the release name starts with a "v", so let's filter it out. -# You may need more tweaks here if the upstream repository has different naming conventions. -if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then - version=${version:1} -fi - -# Setting up the environment variables -echo "Current version: $current_version" -echo "Latest release from upstream: $version" -echo "VERSION=$version" >> $GITHUB_ENV -echo "REPO=$repo" >> $GITHUB_ENV -# For the time being, let's assume the script will fail -echo "PROCEED=false" >> $GITHUB_ENV - -# Proceed only if the retrieved version is greater than the current one -if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then - echo "::warning ::No new version available" - exit 0 -# Proceed only if a PR for this new version does not already exist -elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then - echo "::warning ::A branch already exists for this update" - exit 0 -fi - -# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.) -echo "${#assets[@]} available asset(s)" - -#================================================= -# UPDATE SOURCE FILES -#================================================= - -# Here we use the $assets variable to get the resources published in the upstream release. -# Here is an example for Grav, it has to be adapted in accordance with how the upstream releases look like. - -# Let's loop over the array of assets URLs -for asset_url in ${assets[@]}; do - -echo "Handling asset at $asset_url" - -# Assign the asset to a source file in conf/ directory -# Here we base the source file name upon a unique keyword in the assets url (admin vs. update) -# Leave $src empty to ignore the asset -case $asset_url in - *"admin"*) - src="app" - ;; - *"update"*) - src="app-upgrade" - ;; - *) - src="" - ;; -esac - -# If $src is not empty, let's process the asset -if [ ! -z "$src" ]; then - -# Create the temporary directory -tempdir="$(mktemp -d)" - -# Download sources and calculate checksum -filename=${asset_url##*/} -curl --silent -4 -L $asset_url -o "$tempdir/$filename" -checksum=$(sha256sum "$tempdir/$filename" | head -c 64) - -# Delete temporary directory -rm -rf $tempdir - -# Get extension -if [[ $filename == *.tar.gz ]]; then - extension=tar.gz -else - extension=${filename##*.} -fi - -# Rewrite source file -cat < conf/$src.src -SOURCE_URL=$asset_url -SOURCE_SUM=$checksum -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=$extension -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -EOT -echo "... conf/$src.src updated" - -else -echo "... asset ignored" -fi - -done - -#================================================= -# SPECIFIC UPDATE STEPS -#================================================= - -# Any action on the app's source code can be done. -# The GitHub Action workflow takes care of committing all changes after this script ends. - -#================================================= -# GENERIC FINALIZATION -#================================================= - -# Replace new version in manifest -echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json - -# No need to update the README, yunohost-bot takes care of it - -# The Action will proceed only if the PROCEED environment variable is set to true -echo "PROCEED=true" >> $GITHUB_ENV -exit 0 diff --git a/README.md b/README.md index 220f7dd..d0e59cc 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,6 @@ To create the initial administrator account: `https://yourdomain.com/launchpad` * Official app website: * Official user documentation: * Upstream app code repository: -* YunoHost Store: * Report a bug: ## Developer info diff --git a/README_fr.md b/README_fr.md index 338b60c..1c78cb1 100644 --- a/README_fr.md +++ b/README_fr.md @@ -34,7 +34,6 @@ Pour créer le compte administrateur initial : `https://yourdomain.com/launchpad * Site officiel de l’app : * Documentation officielle utilisateur : * Dépôt de code officiel de l’app : -* YunoHost Store: * Signaler un bug : ## Informations pour les développeurs diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index 7610a9b..0000000 --- a/conf/app.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/overleaf/overleaf/archive/f561650b6217f0dc8e5040415477361a646d970f.tar.gz -SOURCE_SUM=b801aa19a0e5bf39eb89f15d373bfed20e0458aa961d427a66bac6f4259c2b70 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/ldap.src b/conf/ldap.src deleted file mode 100644 index b1b571d..0000000 --- a/conf/ldap.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/smhaller/ldap-overleaf-sl/archive/489b158b5070abbfb7159f150260bebe84424535.tar.gz -SOURCE_SUM=a6589b789f19b03fb11deb8fb53b019fbd2e1a6943c55f862d461d61a7d989dd -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/nginx.conf b/conf/nginx.conf index 43b2798..a70559c 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -29,16 +29,16 @@ location __PATH__/socket.io/ { } location __PATH__/stylesheets/ { - alias __FINALPATH__/live/services/web/public/stylesheets/; + alias __INSTALL_DIR__/live/services/web/public/stylesheets/; expires 1y; } location __PATH__/minjs/ { - alias __FINALPATH__/live/services/web/public/minjs/; + alias __INSTALL_DIR__/live/services/web/public/minjs/; expires 1y; } location __PATH__/img/ { - alias __FINALPATH__/live/services/web/public/img/; + alias __INSTALL_DIR__/live/services/web/public/img/; expires 1y; } \ No newline at end of file diff --git a/conf/overleaf-chat.service b/conf/overleaf-chat.service index e851eb3..3cd42ad 100644 --- a/conf/overleaf-chat.service +++ b/conf/overleaf-chat.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/chat/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/chat/app.js StandardOutput=append:/var/log/__APP__/chat.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-clsi.service b/conf/overleaf-clsi.service index 8d42c9c..41832a0 100644 --- a/conf/overleaf-clsi.service +++ b/conf/overleaf-clsi.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/clsi/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/clsi/app.js StandardOutput=append:/var/log/__APP__/clsi.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-contacts.service b/conf/overleaf-contacts.service index 3480448..5c4c01e 100644 --- a/conf/overleaf-contacts.service +++ b/conf/overleaf-contacts.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/contacts/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/contacts/app.js StandardOutput=append:/var/log/__APP__/contacts.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-docstore.service b/conf/overleaf-docstore.service index 48653d1..2142f94 100644 --- a/conf/overleaf-docstore.service +++ b/conf/overleaf-docstore.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/docstore/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/docstore/app.js StandardOutput=append:/var/log/__APP__/docstore.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-document-updater.service b/conf/overleaf-document-updater.service index 37c5a99..a1f1c40 100644 --- a/conf/overleaf-document-updater.service +++ b/conf/overleaf-document-updater.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/document-updater/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/document-updater/app.js StandardOutput=append:/var/log/__APP__/document-updater.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-filestore.service b/conf/overleaf-filestore.service index 5eeb65b..10e3417 100644 --- a/conf/overleaf-filestore.service +++ b/conf/overleaf-filestore.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/filestore/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/filestore/app.js StandardOutput=append:/var/log/__APP__/filestore.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-notifications.service b/conf/overleaf-notifications.service index c56e62f..5699f45 100644 --- a/conf/overleaf-notifications.service +++ b/conf/overleaf-notifications.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/notifications/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/notifications/app.js StandardOutput=append:/var/log/__APP__/notifications.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-real-time.service b/conf/overleaf-real-time.service index 0b88a7e..9f7981c 100644 --- a/conf/overleaf-real-time.service +++ b/conf/overleaf-real-time.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/real-time/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/real-time/app.js StandardOutput=append:/var/log/__APP__/real-time.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-spelling.service b/conf/overleaf-spelling.service index 632cdc4..efb3a0c 100644 --- a/conf/overleaf-spelling.service +++ b/conf/overleaf-spelling.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/spelling/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/spelling/app.js StandardOutput=append:/var/log/__APP__/spelling.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-track-changes.service b/conf/overleaf-track-changes.service index 8ad18a5..d069c46 100644 --- a/conf/overleaf-track-changes.service +++ b/conf/overleaf-track-changes.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/track-changes/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/track-changes/app.js StandardOutput=append:/var/log/__APP__/track-changes.log StandardError=inherit Restart=on-failure diff --git a/conf/overleaf-web.service b/conf/overleaf-web.service index 7a4e04e..30f40bf 100644 --- a/conf/overleaf-web.service +++ b/conf/overleaf-web.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -EnvironmentFile=__FINALPATH__/variables.env -ExecStart=__YNH_NODE__ __FINALPATH__/live/services/web/app.js +WorkingDirectory=__INSTALL_DIR__/ +EnvironmentFile=__INSTALL_DIR__/variables.env +ExecStart=__YNH_NODE__ __INSTALL_DIR__/live/services/web/app.js StandardOutput=append:/var/log/__APP__/web.log StandardError=inherit Restart=on-failure diff --git a/conf/settings.js b/conf/settings.js index a801e5b..5852761 100644 --- a/conf/settings.js +++ b/conf/settings.js @@ -42,8 +42,8 @@ const parseIntOrFail = function (value) { return parsedValue } -const DATA_DIR = '__DATADIR__' -const TMP_DIR = '__FINALPATH__/tmp' +const DATA_DIR = '__DATA_DIR__' +const TMP_DIR = '__INSTALL_DIR__/tmp' const settings = { clsi: { diff --git a/conf/variables.env b/conf/variables.env index 81b1e77..82743ed 100644 --- a/conf/variables.env +++ b/conf/variables.env @@ -1,6 +1,6 @@ SHARELATEX_APP_NAME="YunoHost Overleaf Community Edition" -SHARELATEX_CONFIG="__FINALPATH__/settings.js" +SHARELATEX_CONFIG="__INSTALL_DIR__/settings.js" ADMIN_PRIVILEGE_AVAILABLE=true OPTIMISE_PDF=true NODE_ENV=production @@ -30,7 +30,7 @@ EMAIL_CONFIRMATION_DISABLED=true # temporary fix for LuaLaTex compiles # see https://github.com/overleaf/overleaf/issues/695 -TEXMFVAR=__FINALPATH__/tmp/texmf-var +TEXMFVAR=__INSTALL_DIR__/tmp/texmf-var ## Nginx # NGINX_WORKER_PROCESSES=4 diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..578f91f --- /dev/null +++ b/manifest.toml @@ -0,0 +1,75 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "overleaf" +name = "Overleaf" +description.en = "Open-source online real-time collaborative LaTeX editor." + +version = "2022.04.23~ynh1" + +maintainers = [] + +[upstream] +license = "AGPL-3.0-or-later" +website = "https://www.overleaf.com" +userdoc = "https://www.overleaf.com/learn" +code = "https://github.com/overleaf/overleaf" +cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number) +fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin. + +[integration] +yunohost = ">= 4.3.0" +architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"] +multi_instance = false +ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials. +sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal. +disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... +ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... +ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... + +[install] + [install.domain] + # this is a generic question - ask strings are automatically handled by Yunohost's core + type = "domain" + + [install.init_main_permission] + type = "group" + default = "visitors" + + [install.language] + ask.en = "Choose the application language" + ask.fr = "Choisissez la langue de l'application" + type = "string" + choices = ["fr", "en"] + default = "fr" + + [install.admin] + # this is a generic question - ask strings are automatically handled by Yunohost's core + type = "user" + +[resources] + [resources.sources] + [resources.sources.ldap] + url = "https://github.com/smhaller/ldap-overleaf-sl/archive/a0e70e4f1f618a23503eb80a4e7cb1a93b568b40.tar.gz" + sha256 = "18a3af6ee0f93aa20fa7c3f08da5264c5d052911a70a3edd4264fe929789e8f3" + + [resources.sources.main] + url = "https://github.com/overleaf/overleaf/archive/c90fafa8ac5cc5c40a2d61b1aba413a7f9102729.tar.gz" + sha256 = "322d906ad7bfda189cd8e6a68f6b0893f05d3085d87df9395e5af1a72964bbae" + + + [resources.system_user] + + [resources.install_dir] + + [resources.data_dir] + + [resources.permissions] + main.url = "/" + + [resources.ports] + main.default = 8095 + + [resources.apt] + packages = "texlive, redis-server, latexmk, python3-pygments" diff --git a/scripts/_common.sh b/scripts/_common.sh index e3193a8..adae341 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -5,9 +5,9 @@ #================================================= # dependencies used by the app -pkg_dependencies="texlive redis-server latexmk python3-pygments" +#REMOVEME? pkg_dependencies="texlive redis-server latexmk python3-pygments" -nodejs_version=14 +nodejs_version=18 #================================================= # PERSONAL HELPERS diff --git a/scripts/backup b/scripts/backup index 452638b..5f90944 100755 --- a/scripts/backup +++ b/scripts/backup @@ -15,23 +15,23 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { +#REMOVEME? ynh_clean_setup () { true } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_print_info --message="Loading installation settings..." +#REMOVEME? ynh_print_info --message="Loading installation settings..." -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir) #================================================= # DECLARE DATA AND CONF FILES TO BACKUP @@ -42,13 +42,13 @@ 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 DATA DIR #================================================= -ynh_backup --src_path="$datadir" --is_big +ynh_backup --src_path="$data_dir" --is_big #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index 165e0c2..1cf6aea 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -13,64 +13,64 @@ source /usr/share/yunohost/helpers # RETRIEVE ARGUMENTS #================================================= -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH +#REMOVEME? old_domain=$YNH_APP_OLD_DOMAIN +#REMOVEME? old_path=$YNH_APP_OLD_PATH -new_domain=$YNH_APP_NEW_DOMAIN -new_path="/" +#REMOVEME? new_domain=$YNH_APP_NEW_DOMAIN +#REMOVEME? new_path="/" -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? app=$YNH_APP_INSTANCE_NAME #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +#REMOVEME? 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) +#REMOVEME? # Needed for helper "ynh_add_nginx_config" +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) # Add settings here as needed by your application -language=$(ynh_app_setting_get --app=$app --key=language) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) -port=$(ynh_app_setting_get --app=$app --key=port) -web_api_password=$(ynh_app_setting_get --app=$app --key=web_api_password) -crypto_random=$(ynh_app_setting_get --app=$app --key=crypto_random) +#REMOVEME? language=$(ynh_app_setting_get --app=$app --key=language) +#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? db_user=$db_name +#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) +#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) +#REMOVEME? web_api_password=$(ynh_app_setting_get --app=$app --key=web_api_password) +#REMOVEME? crypto_random=$(ynh_app_setting_get --app=$app --key=crypto_random) #================================================= # BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP #================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." +#REMOVEME? 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 +#REMOVEME? ynh_backup_before_upgrade +#REMOVEME? ynh_clean_setup () { + #REMOVEME? 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" +#REMOVEME? ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" # Restore it if the upgrade fails - ynh_restore_upgradebackup +#REMOVEME? ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # CHECK WHICH PARTS SHOULD BE CHANGED #================================================= -change_domain=0 -if [ "$old_domain" != "$new_domain" ] +#REMOVEME? change_domain=0 +#REMOVEME? if [ "$old_domain" != "$new_domain" ] then - change_domain=1 + #REMOVEME? change_domain=1 fi -change_path=0 -if [ "$old_path" != "$new_path" ] +#REMOVEME? change_path=0 +#REMOVEME? if [ "$old_path" != "$new_path" ] then - change_path=1 + #REMOVEME? change_path=1 fi #================================================= @@ -97,28 +97,30 @@ ynh_systemd_action --service_name="$app-web" --action="stop" --log_path="/var/lo #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf +ynh_change_url_nginx_config + +#REMOVEME? 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" +#REMOVEME? ynh_backup_if_checksum_is_different --file="$nginx_conf_path" # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" +#REMOVEME? domain="$old_domain" +#REMOVEME? path="$new_path" # Create a dedicated NGINX config - ynh_add_nginx_config +#REMOVEME? 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 +#REMOVEME? ynh_delete_file_checksum --file="$nginx_conf_path" +#REMOVEME? 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" +#REMOVEME? ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" fi #================================================= @@ -127,17 +129,17 @@ fi # UPDATE A CONFIG FILE #================================================= ynh_script_progression --message="Updating a configuration file..." - +#REMOVEME? domain=$new_domain -path_url=$new_path +path=$new_path -ynh_add_config --template="../conf/variables.env" --destination="$final_path/variables.env" -chmod 400 "$final_path/variables.env" -chown $app:$app "$final_path/variables.env" +ynh_add_config --template="../conf/variables.env" --destination="$install_dir/variables.env" +chmod 400 "$install_dir/variables.env" +chown $app:$app "$install_dir/variables.env" -ynh_add_config --template="../conf/settings.js" --destination="$final_path/settings.js" -chmod 400 "$final_path/settings.js" -chown $app:$app "$final_path/settings.js" +ynh_add_config --template="../conf/settings.js" --destination="$install_dir/settings.js" +chmod 400 "$install_dir/settings.js" +chown $app:$app "$install_dir/settings.js" #================================================= # GENERIC FINALISATION @@ -162,9 +164,9 @@ ynh_systemd_action --service_name="$app-web" --action="start" --log_path="/var/l #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 76d0cbc..78888eb 100755 --- a/scripts/install +++ b/scripts/install @@ -14,23 +14,23 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { +#REMOVEME? ynh_clean_setup () { ynh_clean_check_starting } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= -domain=$YNH_APP_ARG_DOMAIN -path_url="/" -is_public=$YNH_APP_ARG_IS_PUBLIC -language=$YNH_APP_ARG_LANGUAGE -admin=$YNH_APP_ARG_ADMIN +#REMOVEME? domain=$YNH_APP_ARG_DOMAIN +path="/" +#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC +#REMOVEME? language=$YNH_APP_ARG_LANGUAGE +#REMOVEME? admin=$YNH_APP_ARG_ADMIN -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? app=$YNH_APP_INSTANCE_NAME web_api_password=$(ynh_string_random --length=32 | base64 -w 0 | rev | cut -b 2- | rev | tr -d '\n+/') crypto_random=$(ynh_string_random --length=32 | base64 -w 0 | rev | cut -b 2- | rev | tr -d '\n+/') @@ -39,24 +39,24 @@ admin_mail=$(ynh_user_get_info --username=$admin --key=mail) #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= -ynh_script_progression --message="Validating installation parameters..." +#REMOVEME? 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" +#REMOVEME? install_dir=/var/www/$app +#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder" # Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url +#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path #================================================= # STORE SETTINGS FROM MANIFEST #================================================= -ynh_script_progression --message="Storing installation settings..." +#REMOVEME? 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 +#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain +#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path ynh_app_setting_set --app=$app --key=language --value=$language -ynh_app_setting_set --app=$app --key=admin --value=$admin -ynh_app_setting_set --app=$app --key=web_api_password --value=$web_api_password +#REMOVEME? ynh_app_setting_set --app=$app --key=admin --value=$admin +#REMOVEME? ynh_app_setting_set --app=$app --key=web_api_password --value=$web_api_password ynh_app_setting_set --app=$app --key=crypto_random --value=$crypto_random #================================================= @@ -64,37 +64,37 @@ ynh_app_setting_set --app=$app --key=crypto_random --value=$crypto_random #================================================= # FIND AND OPEN A PORT #================================================= -ynh_script_progression --message="Finding an available port..." +#REMOVEME? 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 +#REMOVEME? port=$(ynh_find_port --port=8095) +#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$port #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Installing dependencies..." +#REMOVEME? ynh_script_progression --message="Installing dependencies..." -ynh_install_app_dependencies $pkg_dependencies +#REMOVEME? ynh_install_app_dependencies $pkg_dependencies ynh_install_nodejs --nodejs_version=$nodejs_version ynh_install_mongo #================================================= # CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Configuring system user..." +#REMOVEME? ynh_script_progression --message="Configuring system user..." # Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" +#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" #================================================= # CREATE A MONGODB DATABASE #================================================= ynh_script_progression --message="Creating a MongoDB 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 +#REMOVEME? db_name=$(ynh_sanitize_dbid --db_name=$app) +#REMOVEME? db_user=$db_name +#REMOVEME? ynh_app_setting_set --app=$app --key=db_name --value=$db_name ynh_mongo_setup_db --db_user=$db_user --db_name=$db_name #================================================= @@ -102,14 +102,14 @@ ynh_mongo_setup_db --db_user=$db_user --db_name=$db_name #================================================= ynh_script_progression --message="Setting up source files..." -ynh_app_setting_set --app=$app --key=final_path --value=$final_path +#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$final_path/build" -ynh_setup_source --dest_dir="$final_path/build_ldap" --source_id="ldap" +ynh_setup_source --dest_dir="$install_dir/build" +ynh_setup_source --dest_dir="$install_dir/build_ldap" --source_id="ldap" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # NGINX CONFIGURATION @@ -126,65 +126,65 @@ ynh_add_nginx_config #================================================= ynh_script_progression --message="Creating a data directory..." -datadir=/home/yunohost.app/$app -ynh_app_setting_set --app=$app --key=datadir --value=$datadir +#REMOVEME? data_dir=/home/yunohost.app/$app +#REMOVEME? ynh_app_setting_set --app=$app --key=data_dir --value=$data_dir -mkdir -p $datadir +mkdir -p $data_dir -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" +chmod 750 "$data_dir" +chmod -R o-rwx "$data_dir" +chown -R $app:www-data "$data_dir" #================================================= # ADD A CONFIGURATION #================================================= ynh_script_progression --message="Adding a configuration file..." -ynh_add_config --template="../conf/variables.env" --destination="$final_path/variables.env" -chmod 400 "$final_path/variables.env" -chown $app:$app "$final_path/variables.env" +ynh_add_config --template="../conf/variables.env" --destination="$install_dir/variables.env" +chmod 400 "$install_dir/variables.env" +chown $app:$app "$install_dir/variables.env" -ynh_add_config --template="../conf/settings.js" --destination="$final_path/settings.js" -chmod 400 "$final_path/settings.js" -chown $app:$app "$final_path/settings.js" +ynh_add_config --template="../conf/settings.js" --destination="$install_dir/settings.js" +chmod 400 "$install_dir/settings.js" +chown $app:$app "$install_dir/settings.js" #================================================= # BUILDING APP #================================================= ynh_script_progression --message="Building app..." -mkdir -p "$final_path/live" -cp "$final_path/build/server-ce/genScript.js" "$final_path/live/genScript.js" -cp "$final_path/build/server-ce/services.js" "$final_path/live/services.js" -cp "$final_path/build/package.json" "$final_path/live/package.json" -cp "$final_path/build/package-lock.json" "$final_path/live/package-lock.json" -cp -r "$final_path/build/libraries/" "$final_path/live/libraries/" -cp -r "$final_path/build/services/" "$final_path/live/services/" +mkdir -p "$install_dir/live" +cp "$install_dir/build/server-ce/genScript.js" "$install_dir/live/genScript.js" +cp "$install_dir/build/server-ce/services.js" "$install_dir/live/services.js" +cp "$install_dir/build/package.json" "$install_dir/live/package.json" +cp "$install_dir/build/package-lock.json" "$install_dir/live/package-lock.json" +cp -r "$install_dir/build/libraries/" "$install_dir/live/libraries/" +cp -r "$install_dir/build/services/" "$install_dir/live/services/" -cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/AuthenticationManager.js" "$final_path/live/services/web/app/src/Features/Authentication/AuthenticationManager.js" -cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/ContactController.js" "$final_path/live/services/web/app/src/Features/Contacts/ContactController.js" -#sed -iE '/type=.*email.*/d' $final_path/live/services/web/app/views/user/login.pug -#sed -iE "s/email@example.com/${login_text:-user}/g" $final_path/live/services/web/app/views/user/login.pug -#sed -iE '/email@example.com/{n;N;N;d}' $final_path/live/services/web/app/views/user/login.pug -sed -iE "s%-synctex=1\",%-synctex=1\", \"-shell-escape\",%g" $final_path/live/services/clsi/app/js/LatexRunner.js -sed -iE "s%'-synctex=1',%'-synctex=1', '-shell-escape',%g" $final_path/live/services/clsi/app/js/LatexRunner.js -cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/settings.pug" "$final_path/live/services/web/app/views/user/settings.pug" -cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/navbar.pug" "$final_path/live/services/web/app/views/layout/navbar.pug" -cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/admin-sysadmin.pug" "$final_path/live/services/web/app/views/admin/index.pug" -ynh_secure_remove --file="$final_path/live/services/web/app/views/admin/register.pug" -ynh_secure_remove --file="$final_path/live/services/web/app/views/project/editor/review-panel.pug" -touch "$final_path/live/services/web/app/views/project/editor/review-panel.pug" +cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/AuthenticationManager.js" "$install_dir/live/services/web/app/src/Features/Authentication/AuthenticationManager.js" +cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/ContactController.js" "$install_dir/live/services/web/app/src/Features/Contacts/ContactController.js" +#sed -iE '/type=.*email.*/d' $install_dir/live/services/web/app/views/user/login.pug +#sed -iE "s/email@example.com/${login_text:-user}/g" $install_dir/live/services/web/app/views/user/login.pug +#sed -iE '/email@example.com/{n;N;N;d}' $install_dir/live/services/web/app/views/user/login.pug +sed -iE "s%-synctex=1\",%-synctex=1\", \"-shell-escape\",%g" $install_dir/live/services/clsi/app/js/LatexRunner.js +sed -iE "s%'-synctex=1',%'-synctex=1', '-shell-escape',%g" $install_dir/live/services/clsi/app/js/LatexRunner.js +cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/settings.pug" "$install_dir/live/services/web/app/views/user/settings.pug" +cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/navbar.pug" "$install_dir/live/services/web/app/views/layout/navbar.pug" +cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/admin-sysadmin.pug" "$install_dir/live/services/web/app/views/admin/index.pug" +#REMOVEME? ynh_secure_remove --file="$install_dir/live/services/web/app/views/admin/register.pug" +#REMOVEME? ynh_secure_remove --file="$install_dir/live/services/web/app/views/project/editor/review-panel.pug" +touch "$install_dir/live/services/web/app/views/project/editor/review-panel.pug" -ynh_secure_remove --file="$final_path/build" -ynh_secure_remove --file="$final_path/build_ldap" +#REMOVEME? ynh_secure_remove --file="$install_dir/build" +#REMOVEME? ynh_secure_remove --file="$install_dir/build_ldap" -pushd "$final_path/live" +pushd "$install_dir/live" ynh_use_nodejs ynh_exec_warn_less $ynh_npm install -g npm@7.24.2 npm ci popd -pushd "$final_path/live/services/web" +pushd "$install_dir/live/services/web" ynh_exec_warn_less npm run webpack:production ynh_exec_warn_less npm install -g npm ynh_exec_warn_less npm install ldap-escape @@ -192,18 +192,18 @@ pushd "$final_path/live/services/web" ynh_exec_warn_less npm install ldapts ynh_exec_warn_less npm install ldap-escape ynh_exec_warn_less npm cache clean --force - ynh_secure_remove --file="$final_path/live/services/web/node_modules/.cache" +#REMOVEME? ynh_secure_remove --file="$install_dir/live/services/web/node_modules/.cache" popd -chmod 750 "$final_path/live" -chmod -R o-rwx "$final_path/live" -chown -R $app:www-data "$final_path/live" +chmod 750 "$install_dir/live" +chmod -R o-rwx "$install_dir/live" +chown -R $app:www-data "$install_dir/live" -mkdir -p "$final_path/tmp/uploads" +mkdir -p "$install_dir/tmp/uploads" -chmod 750 "$final_path/tmp" -chmod -R o-rwx "$final_path/tmp" -chown -R $app:www-data "$final_path/tmp" +chmod 750 "$install_dir/tmp" +chmod -R o-rwx "$install_dir/tmp" +chown -R $app:www-data "$install_dir/tmp" #================================================= # SETUP SYSTEMD @@ -273,26 +273,26 @@ ynh_systemd_action --service_name="$app-web" --action="start" --log_path="/var/l #================================================= # SETUP SSOWAT #================================================= -ynh_script_progression --message="Configuring permissions..." +#REMOVEME? ynh_script_progression --message="Configuring permissions..." # Make app public if necessary -if [ $is_public -eq 1 ] +#REMOVEME? 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" +#REMOVEME? ynh_permission_update --permission="main" --add="visitors" fi ynh_permission_url --permission="main" --auth_header=false -ynh_permission_create --permission="admin" --allowed="$admin" +#REMOVEME? ynh_permission_create --permission="admin" --allowed="$admin" #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index fdc3e8b..3ede65b 100755 --- a/scripts/remove +++ b/scripts/remove @@ -13,16 +13,16 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +#REMOVEME? ynh_script_progression --message="Loading installation settings..." -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) +#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? db_user=$db_name +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir) #================================================= # STANDARD REMOVE @@ -124,10 +124,10 @@ ynh_mongo_remove_db --db_user=$db_user --db_name=$db_name #================================================= # REMOVE APP MAIN DIR #================================================= -ynh_script_progression --message="Removing app main directory..." +#REMOVEME? ynh_script_progression --message="Removing app main directory..." # Remove the app directory securely -ynh_secure_remove --file="$final_path" +#REMOVEME? ynh_secure_remove --file="$install_dir" #================================================= # REMOVE DATA DIR @@ -137,7 +137,7 @@ ynh_secure_remove --file="$final_path" if [ "${YNH_APP_PURGE:-0}" -eq 1 ] then ynh_script_progression --message="Removing app data directory..." - ynh_secure_remove --file="$datadir" +#REMOVEME? ynh_secure_remove --file="$data_dir" fi #================================================= @@ -151,12 +151,12 @@ ynh_remove_nginx_config #================================================= # REMOVE DEPENDENCIES #================================================= -ynh_script_progression --message="Removing dependencies..." +#REMOVEME? ynh_script_progression --message="Removing dependencies..." # Remove metapackage and its dependencies ynh_remove_mongo ynh_remove_nodejs -ynh_remove_app_dependencies +#REMOVEME? ynh_remove_app_dependencies #================================================= # SPECIFIC REMOVE @@ -173,10 +173,10 @@ ynh_secure_remove --file="/var/log/$app" #================================================= # REMOVE DEDICATED USER #================================================= -ynh_script_progression --message="Removing the dedicated system user..." +#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." # Delete a system user -ynh_system_user_delete --username=$app +#REMOVEME? ynh_system_user_delete --username=$app #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 1c551ac..a17f902 100755 --- a/scripts/restore +++ b/scripts/restore @@ -15,34 +15,34 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { +#REMOVEME? ynh_clean_setup () { ynh_clean_check_starting } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +#REMOVEME? ynh_script_progression --message="Loading installation settings..." -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) -port=$(ynh_app_setting_get --app=$app --key=port) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -datadir=$(ynh_app_setting_get --app=$app --key=datadir) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) +#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? db_user=$db_name +#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir) #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= -ynh_script_progression --message="Validating restoration parameters..." +#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " +#REMOVEME? test ! -d $install_dir \ + || ynh_die --message="There is already a directory: $install_dir " #================================================= # STANDARD RESTORATION STEPS @@ -56,44 +56,44 @@ 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..." +#REMOVEME? 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" +#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" #================================================= # 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" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # RESTORE THE DATA DIRECTORY #================================================= ynh_script_progression --message="Restoring the data directory..." -ynh_restore_file --origin_path="$datadir" --not_mandatory +ynh_restore_file --origin_path="$data_dir" --not_mandatory -mkdir -p $datadir +mkdir -p $data_dir -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" +chmod 750 "$data_dir" +chmod -R o-rwx "$data_dir" +chown -R $app:www-data "$data_dir" #================================================= # SPECIFIC RESTORATION #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling dependencies..." +#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." # Define and install dependencies -ynh_install_app_dependencies $pkg_dependencies +#REMOVEME? ynh_install_app_dependencies $pkg_dependencies ynh_install_nodejs --nodejs_version=$nodejs_version ynh_install_mongo @@ -102,7 +102,7 @@ ynh_install_mongo #================================================= ynh_script_progression --message="Restoring the MongoDB database..." -db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) +#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) ynh_mongo_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd ynh_mongo_restore_db --database="$db_name" < ./dump.bson diff --git a/scripts/upgrade b/scripts/upgrade index 4e513a1..0f2087f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -13,22 +13,22 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." +#REMOVEME? ynh_script_progression --message="Loading installation settings..." -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? app=$YNH_APP_INSTANCE_NAME -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -language=$(ynh_app_setting_get --app=$app --key=language) -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=db_pwd) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) -port=$(ynh_app_setting_get --app=$app --key=port) -web_api_password=$(ynh_app_setting_get --app=$app --key=web_api_password) -crypto_random=$(ynh_app_setting_get --app=$app --key=crypto_random) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) +#REMOVEME? language=$(ynh_app_setting_get --app=$app --key=language) +#REMOVEME? admin=$(ynh_app_setting_get --app=$app --key=admin) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? db_user=$db_name +#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd) +#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) +#REMOVEME? web_api_password=$(ynh_app_setting_get --app=$app --key=web_api_password) +#REMOVEME? crypto_random=$(ynh_app_setting_get --app=$app --key=crypto_random) #================================================= # CHECK VERSION @@ -40,17 +40,17 @@ 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)..." +#REMOVEME? 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 () { +#REMOVEME? ynh_backup_before_upgrade +#REMOVEME? ynh_clean_setup () { ynh_clean_check_starting # Restore it if the upgrade fails - ynh_restore_upgradebackup +#REMOVEME? ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # STANDARD UPGRADE STEPS @@ -79,10 +79,10 @@ ynh_script_progression --message="Ensuring downward compatibility..." #================================================= # CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." +#REMOVEME? 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" +#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -93,13 +93,13 @@ 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/build" - ynh_setup_source --dest_dir="$final_path/build_ldap" --source_id="ldap" + ynh_setup_source --dest_dir="$install_dir/build" + ynh_setup_source --dest_dir="$install_dir/build_ldap" --source_id="ldap" fi -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # NGINX CONFIGURATION @@ -112,9 +112,9 @@ ynh_add_nginx_config #================================================= # UPGRADE DEPENDENCIES #================================================= -ynh_script_progression --message="Upgrading dependencies..." +#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." -ynh_install_app_dependencies $pkg_dependencies +#REMOVEME? ynh_install_app_dependencies $pkg_dependencies ynh_install_nodejs --nodejs_version=$nodejs_version ynh_install_mongo @@ -125,13 +125,13 @@ ynh_install_mongo #================================================= ynh_script_progression --message="Updating a configuration file..." -ynh_add_config --template="../conf/variables.env" --destination="$final_path/variables.env" -chmod 400 "$final_path/variables.env" -chown $app:$app "$final_path/variables.env" +ynh_add_config --template="../conf/variables.env" --destination="$install_dir/variables.env" +chmod 400 "$install_dir/variables.env" +chown $app:$app "$install_dir/variables.env" -ynh_add_config --template="../conf/settings.js" --destination="$final_path/settings.js" -chmod 400 "$final_path/settings.js" -chown $app:$app "$final_path/settings.js" +ynh_add_config --template="../conf/settings.js" --destination="$install_dir/settings.js" +chmod 400 "$install_dir/settings.js" +chown $app:$app "$install_dir/settings.js" #================================================= # BUILDING APP @@ -141,39 +141,39 @@ if [ "$upgrade_type" == "UPGRADE_APP" ] then ynh_script_progression --message="Building app..." - ynh_secure_remove --file="$final_path/live" - mkdir -p "$final_path/live" - cp "$final_path/build/server-ce/genScript.js" "$final_path/live/genScript.js" - cp "$final_path/build/server-ce/services.js" "$final_path/live/services.js" - cp "$final_path/build/package.json" "$final_path/live/package.json" - cp "$final_path/build/package-lock.json" "$final_path/live/package-lock.json" - cp -r "$final_path/build/libraries/" "$final_path/live/libraries/" - cp -r "$final_path/build/services/" "$final_path/live/services/" +#REMOVEME? ynh_secure_remove --file="$install_dir/live" + mkdir -p "$install_dir/live" + cp "$install_dir/build/server-ce/genScript.js" "$install_dir/live/genScript.js" + cp "$install_dir/build/server-ce/services.js" "$install_dir/live/services.js" + cp "$install_dir/build/package.json" "$install_dir/live/package.json" + cp "$install_dir/build/package-lock.json" "$install_dir/live/package-lock.json" + cp -r "$install_dir/build/libraries/" "$install_dir/live/libraries/" + cp -r "$install_dir/build/services/" "$install_dir/live/services/" - cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/AuthenticationManager.js" "$final_path/live/services/web/app/src/Features/Authentication/AuthenticationManager.js" - cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/ContactController.js" "$final_path/live/services/web/app/src/Features/Contacts/ContactController.js" - #sed -iE '/type=.*email.*/d' $final_path/live/services/web/app/views/user/login.pug - #sed -iE "s/email@example.com/${login_text:-user}/g" $final_path/live/services/web/app/views/user/login.pug - #sed -iE '/email@example.com/{n;N;N;d}' $final_path/live/services/web/app/views/user/login.pug - sed -iE "s%-synctex=1\",%-synctex=1\", \"-shell-escape\",%g" $final_path/live/services/clsi/app/js/LatexRunner.js - sed -iE "s%'-synctex=1',%'-synctex=1', '-shell-escape',%g" $final_path/live/services/clsi/app/js/LatexRunner.js - cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/settings.pug" "$final_path/live/services/web/app/views/user/settings.pug" - cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/navbar.pug" "$final_path/live/services/web/app/views/layout/navbar.pug" - cp "$final_path/build_ldap/ldap-overleaf-sl/sharelatex/admin-sysadmin.pug" "$final_path/live/services/web/app/views/admin/index.pug" - ynh_secure_remove --file="$final_path/live/services/web/app/views/admin/register.pug" - ynh_secure_remove --file="$final_path/live/services/web/app/views/project/editor/review-panel.pug" - touch "$final_path/live/services/web/app/views/project/editor/review-panel.pug" + cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/AuthenticationManager.js" "$install_dir/live/services/web/app/src/Features/Authentication/AuthenticationManager.js" + cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/ContactController.js" "$install_dir/live/services/web/app/src/Features/Contacts/ContactController.js" + #sed -iE '/type=.*email.*/d' $install_dir/live/services/web/app/views/user/login.pug + #sed -iE "s/email@example.com/${login_text:-user}/g" $install_dir/live/services/web/app/views/user/login.pug + #sed -iE '/email@example.com/{n;N;N;d}' $install_dir/live/services/web/app/views/user/login.pug + sed -iE "s%-synctex=1\",%-synctex=1\", \"-shell-escape\",%g" $install_dir/live/services/clsi/app/js/LatexRunner.js + sed -iE "s%'-synctex=1',%'-synctex=1', '-shell-escape',%g" $install_dir/live/services/clsi/app/js/LatexRunner.js + cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/settings.pug" "$install_dir/live/services/web/app/views/user/settings.pug" + cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/navbar.pug" "$install_dir/live/services/web/app/views/layout/navbar.pug" + cp "$install_dir/build_ldap/ldap-overleaf-sl/sharelatex/admin-sysadmin.pug" "$install_dir/live/services/web/app/views/admin/index.pug" +#REMOVEME? ynh_secure_remove --file="$install_dir/live/services/web/app/views/admin/register.pug" +#REMOVEME? ynh_secure_remove --file="$install_dir/live/services/web/app/views/project/editor/review-panel.pug" + touch "$install_dir/live/services/web/app/views/project/editor/review-panel.pug" - ynh_secure_remove --file="$final_path/build" - ynh_secure_remove --file="$final_path/build_ldap" +#REMOVEME? ynh_secure_remove --file="$install_dir/build" +#REMOVEME? ynh_secure_remove --file="$install_dir/build_ldap" - pushd "$final_path/live" + pushd "$install_dir/live" ynh_use_nodejs ynh_exec_warn_less $ynh_npm install -g npm@7.24.2 npm ci popd - pushd "$final_path/live/services/web" + pushd "$install_dir/live/services/web" ynh_exec_warn_less npm run webpack:production ynh_exec_warn_less npm install -g npm ynh_exec_warn_less npm install ldap-escape @@ -181,18 +181,18 @@ then ynh_exec_warn_less npm install ldapts ynh_exec_warn_less npm install ldap-escape ynh_exec_warn_less npm cache clean --force - ynh_secure_remove --file="$final_path/live/services/web/node_modules/.cache" +#REMOVEME? ynh_secure_remove --file="$install_dir/live/services/web/node_modules/.cache" popd - chmod 750 "$final_path/live" - chmod -R o-rwx "$final_path/live" - chown -R $app:www-data "$final_path/live" + chmod 750 "$install_dir/live" + chmod -R o-rwx "$install_dir/live" + chown -R $app:www-data "$install_dir/live" - mkdir -p "$final_path/tmp/uploads" + mkdir -p "$install_dir/tmp/uploads" - chmod 750 "$final_path/tmp" - chmod -R o-rwx "$final_path/tmp" - chown -R $app:www-data "$final_path/tmp" + chmod 750 "$install_dir/tmp" + chmod -R o-rwx "$install_dir/tmp" + chown -R $app:www-data "$install_dir/tmp" fi #================================================= @@ -262,9 +262,9 @@ ynh_systemd_action --service_name="$app-web" --action="start" --log_path="/var/l #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT