From 5b9d7c2221aa7d3f6892614be0a2745f608e1d41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 15:51:31 +0100 Subject: [PATCH 01/18] Manifest v2 --- .github/workflows/updater.sh | 134 ------------------- .github/workflows/updater.yml | 52 -------- check_process | 39 ------ conf/amd64.src | 6 - conf/arm64.src | 6 - conf/armhf.src | 6 - conf/nginx.conf | 4 +- conf/systemd.service | 6 +- conf/uploads.exs | 2 +- doc/{DISCLAIMER.md => ADMIN.md} | 3 - doc/DESCRIPTION.md | 4 +- manifest.json | 59 --------- manifest.toml | 95 ++++++++++++++ scripts/_common.sh | 3 - scripts/backup | 20 +-- scripts/change_url | 68 +++++----- scripts/install | 225 ++++++++------------------------ scripts/remove | 34 ++--- scripts/restore | 68 +++++----- scripts/upgrade | 144 ++++++++++---------- tests.toml | 16 +++ 21 files changed, 342 insertions(+), 652 deletions(-) delete mode 100644 .github/workflows/updater.sh delete mode 100644 .github/workflows/updater.yml delete mode 100644 check_process delete mode 100644 conf/amd64.src delete mode 100644 conf/arm64.src delete mode 100644 conf/armhf.src rename doc/{DISCLAIMER.md => ADMIN.md} (57%) delete mode 100644 manifest.json create mode 100644 manifest.toml create mode 100644 tests.toml diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh deleted file mode 100644 index 9e98810..0000000 --- a/.github/workflows/updater.sh +++ /dev/null @@ -1,134 +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. - -#================================================= -# FETCHING LATEST RELEASE AND ITS ASSETS -#================================================= - -# Fetching information -current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') -# 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://framagit.org/api/v4/projects/20125/releases" | jq -r '.[] | select( .tag_name | contains("rc") or contains("beta") | not ) | .tag_name' | sort -V | tail -1) -assets=($(curl --silent "https://framagit.org/api/v4/projects/20125/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets.links[].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 -# 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 - *"amd64"*) - src="amd64" - ;; - *"arm64"*) - src="arm64" - ;; - *"arm"*) - src="armhf" - ;; - *) - 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/.github/workflows/updater.yml b/.github/workflows/updater.yml deleted file mode 100644 index 64f2a2f..0000000 --- a/.github/workflows/updater.yml +++ /dev/null @@ -1,52 +0,0 @@ -# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected. -# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization. -# This file should be enough by itself, but feel free to tune it to your needs. -# It calls updater.sh, which is where you should put the app-specific update steps. -name: Check for new upstream releases -on: - # Allow to manually trigger the workflow - workflow_dispatch: - # Run it every day at 6:00 UTC - schedule: - - cron: '0 6 * * *' -jobs: - updater: - runs-on: ubuntu-latest - steps: - - name: Fetch the source code - uses: actions/checkout@v3 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Run the updater script - id: run_updater - run: | - # Setting up Git user - git config --global user.name 'yunohost-bot' - git config --global user.email 'yunohost-bot@users.noreply.github.com' - # Run the updater script - /bin/bash .github/workflows/updater.sh - - name: Commit changes - id: commit - if: ${{ env.PROCEED == 'true' }} - run: | - git commit -am "Upgrade to v$VERSION" - - name: Create Pull Request - id: cpr - if: ${{ env.PROCEED == 'true' }} - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: Update to version ${{ env.VERSION }} - committer: 'yunohost-bot ' - author: 'yunohost-bot ' - signoff: false - base: testing - branch: ci-auto-update-v${{ env.VERSION }} - delete-branch: true - title: 'Upgrade to version ${{ env.VERSION }}' - body: | - Upgrade to v${{ env.VERSION }} - [See upstream release page](${{ env.RELEASE }}) - Provided description: - ${{ env.DESCRIPTION }} - draft: false diff --git a/check_process b/check_process deleted file mode 100644 index c6cdead..0000000 --- a/check_process +++ /dev/null @@ -1,39 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - is_public=1 - language="fr" - admin="john" - password="1Strong-Password" - name="My_Mobilizon" - ; Checks - pkg_linter=1 - setup_sub_dir=0 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - # 1.1.3~ynh1 - # upgrade=1 from_commit=87d34001dd0b77aed4fa7be2911bc04f58b069ee - # 1.1.4~ynh1 - # upgrade=1 from_commit=215b20b0d35178a2c3405a7e3239eba81e22c060 - # 1.2.2~ynh1 - # upgrade=1 from_commit=b63c7833f80de56bbc4a255ddda3b865a5637afc - # 1.2.3~ynh1 - # upgrade=1 from_commit=42d479d2cc5bcdc40806ac01802d8eac9df5b2ea - # 1.3.2~ynh1 - # upgrade=1 from_commit=e3c0b208c0b76a55e8df2a3947f57bb762b017d4 - # 2.0.2~ynh1 - upgrade=1 from_commit=0159fc6123536cdf2929b4617d89753283f6946d - # 2.0.2~ynh2 - upgrade=1 from_commit=2dd97e495207a1b5e58b8ba5f501fe84d1db7623 - # 2.1.0~ynh1 - upgrade=1 from_commit=f9c1792c86cffd17b72a48160a64ee2083d5ccf6 - backup_restore=1 - multi_instance=0 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none diff --git a/conf/amd64.src b/conf/amd64.src deleted file mode 100644 index a28e301..0000000 --- a/conf/amd64.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://packages.joinmobilizon.org/4.0.0/mobilizon_4.0.0_amd64-debian-bullseye.tar.gz -SOURCE_SUM=a0007f7564c01ea8b0bfc9b3b32742473839b0217aae59dea74eacfd3b1774ac -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/conf/arm64.src b/conf/arm64.src deleted file mode 100644 index 0b8c115..0000000 --- a/conf/arm64.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://packages.joinmobilizon.org/4.0.0/mobilizon_4.0.0_arm64-debian-bullseye.tar.gz -SOURCE_SUM=c63495d8a176e28843d0217c2b273bb5aca84123658286101a962467fc6f045b -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/conf/armhf.src b/conf/armhf.src deleted file mode 100644 index 6c27f1f..0000000 --- a/conf/armhf.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://packages.joinmobilizon.org/3.0.4/mobilizon_3.0.4_arm.tar.gz -SOURCE_SUM=9710a47ac29111419021fd7f4da2c33288e5741f695268a5067bab538acaa5da -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/conf/nginx.conf b/conf/nginx.conf index f96a856..819ee7e 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -23,7 +23,7 @@ location / { } location ~ ^/(js|css) { - root __FINALPATH__/live/priv/static; + root __INSTALL_DIR__/live/priv/static; etag off; access_log off; more_set_headers "Cache-Control: public, max-age=31536000, immutable"; @@ -38,6 +38,6 @@ location ~ ^/(media|proxy) { error_page 500 501 502 503 504 @error; location @error { - root __FINALPATH__/live/priv/errors; + root __INSTALL_DIR__/live/priv/errors; try_files /error.html 502; } diff --git a/conf/systemd.service b/conf/systemd.service index 7719bd3..a5783b0 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -7,9 +7,9 @@ Type=simple User=__APP__ Group=__APP__ Environment=MIX_ENV=prod -WorkingDirectory=__FINALPATH__/live/ -ExecStart=__FINALPATH__/live/bin/mobilizon start -ExecStop=__FINALPATH__/live/bin/mobilizon stop +WorkingDirectory=__INSTALL_DIR__/live/ +ExecStart=__INSTALL_DIR__/live/bin/mobilizon start +ExecStop=__INSTALL_DIR__/live/bin/mobilizon stop KillMode=process Restart=on-failure diff --git a/conf/uploads.exs b/conf/uploads.exs index 5b15f28..8f786fd 100644 --- a/conf/uploads.exs +++ b/conf/uploads.exs @@ -1,2 +1,2 @@ -config :mobilizon, Mobilizon.Web.Upload.Uploader.Local, uploads: "__DATADIR__/uploads" +config :mobilizon, Mobilizon.Web.Upload.Uploader.Local, uploads: "__DATA_DIR__/uploads" diff --git a/doc/DISCLAIMER.md b/doc/ADMIN.md similarity index 57% rename from doc/DISCLAIMER.md rename to doc/ADMIN.md index c114b1b..ed190fc 100644 --- a/doc/DISCLAIMER.md +++ b/doc/ADMIN.md @@ -1,6 +1,3 @@ -* **Mobilizon** require a dedicated **root domain**, eg. mobilizon.domain.tld * To connect as **Mobilizon** administrator, use the email address and password of the user you choose during install * By default registrations are closed * All YunoHost users are allowed to connect - -* Configuration can be made in the Mobilizon administration panel. diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index e9fa04c..c90c8d5 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,6 +1,4 @@ -A decentralized and federated platform to organize events +A decentralized and federated platform to organize events. - Mobilizon is a tool that helps you find, create and organize events. - - You can also create a page for your group where the members will be able to get organized together. - diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 91afcfc..0000000 --- a/manifest.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "name": "Mobilizon", - "id": "mobilizon", - "packaging_format": 1, - "description": { - "en": "Decentralized and federated platform to organize events", - "fr": "Plateforme décentralisée et fédérée pour organiser des événements" - }, - "version": "4.0.0~ynh1", - "url": "https://joinmobilizon.org/", - "upstream": { - "license": "AGPL-3.0-or-later", - "website": "https://joinmobilizon.org/", - "demo": "https://demo.mobilizon.org", - "userdoc": "https://docs.joinmobilizon.org", - "code": "https://framagit.org/framasoft/mobilizon/" - }, - "license": "AGPL-3.0-or-later", - "maintainer": { - "name": "yalh76" - }, - "requirements": { - "yunohost": ">= 11.2" - }, - "multi_instance": false, - "services": [ - "nginx" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "is_public", - "type": "boolean", - "default": true - }, - { - "name": "language", - "type": "select", - "ask": { - "en": "Choose the application language", - "fr": "Choisissez la langue de l'application" - }, - "choices": [ - "fr", - "en" - ], - "default": "fr" - }, - { - "name": "admin", - "type": "user" - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..d3611d3 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,95 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "mobilizon" +name = "Mobilizon" +description.en = "Decentralized and federated platform to organize events" +description.fr = "Plateforme décentralisée et fédérée pour organiser des événements" + +version = "4.0.0~ynh1" + +maintainers = ["yalh76"] + +[upstream] +license = "AGPL-3.0-or-later" +website = "https://joinmobilizon.org/" +demo = "https://demo.mobilizon.org" +userdoc = "https://docs.joinmobilizon.org" +code = "https://framagit.org/framasoft/mobilizon/" +fund = "https://soutenir.framasoft.org/" + +[integration] +yunohost = ">= 11.2" +architectures = ["amd64", "arm64"] +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] + 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 = "select" + choices = ["fr", "en"] + default = "fr" + + [install.admin] + type = "user" + +[resources] + [resources.sources.main] + amd64.url = "https://packages.joinmobilizon.org/4.0.2/mobilizon_4.0.2_amd64-debian-bullseye.tar.gz" + amd64.sha256 = "a0007f7564c01ea8b0bfc9b3b32742473839b0217aae59dea74eacfd3b1774ac" + arm64.url = "https://packages.joinmobilizon.org/4.0.0/mobilizon_4.0.0_arm64-debian-bullseye.tar.gz" + arm64.sha256 = "c63495d8a176e28843d0217c2b273bb5aca84123658286101a962467fc6f045b" + + autoupdate.strategy = "latest_gitlab_release" + autoupdate.asset.amd64 = "mobilizon_.*_amd64-debian-bullseye.tar.gz" + autoupdate.asset.arm64 = "mobilizon_.*_arm64-debian-bullseye.tar.gz" + + [resources.system_user] + + [resources.install_dir] + + [resources.data_dir] + subdirs = ["uploads"] + owner = "__APP__:rwx" + group = "__APP__:rwx" + + [resources.permissions] + main.url = "/" + + [resources.ports] + main.default = 8095 + + [resources.apt] + packages = [ + "postgresql", + "postgresql-client", + "postgresql-contrib", + "postgis", + "postgresql-postgis-scripts", + "postgresql-postgis", + "argon2", + "imagemagick", + "webp", + "gifsicle", + "jpegoptim", + "optipng", + "pngquant", + "file", + ] + + [resources.database] + type = "postgresql" diff --git a/scripts/_common.sh b/scripts/_common.sh index fa1a46b..944a65e 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,9 +4,6 @@ # COMMON VARIABLES #================================================= -# dependencies used by the app -pkg_dependencies="postgresql postgresql-client postgresql-contrib postgis postgresql-postgis-scripts postgresql-postgis argon2 imagemagick webp gifsicle jpegoptim optipng pngquant file" - #================================================= # PERSONAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index fd70fe0..c10996d 100644 --- a/scripts/backup +++ b/scripts/backup @@ -14,23 +14,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 @@ -41,13 +41,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 92c4b51..58c6124 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -13,59 +13,59 @@ 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 -#db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? #db_name=$(ynh_app_setting_get --app=$app --key=db_name) #db_user=$db_name -#db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) +#REMOVEME? #db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) #================================================= # 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 #================================================= @@ -82,28 +82,30 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path=systemd #================================================= 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" yunohost user update "${app}_notifs" --mail "${app}_notifs@${new_domain}" --add-mailalias "${app}@${new_domain}" fi @@ -138,9 +140,9 @@ ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --lin #================================================= # 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 ed64863..281f828 100644 --- a/scripts/install +++ b/scripts/install @@ -10,196 +10,105 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# INITIALIZE AND STORE SETTINGS #================================================= -ynh_clean_setup () { - ynh_clean_check_starting -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors +admin_email=$(ynh_user_get_info --username="$admin" --key="mail") +ynh_app_setting_set --app="$app" --key="admin_email" --value="$admin_email" -#================================================= -# 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 - -app=$YNH_APP_INSTANCE_NAME - -admin_email=$(ynh_user_get_info --username=$admin --key="mail") +ynh_user="${app}_notifs" ynh_user_password=$(ynh_string_random --length=30) -architecture=$YNH_ARCH - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - -[ -n "$admin_email" ] || ynh_die --message="Did not found the email address for the admin user ?" - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -ynh_script_progression --message="Storing installation settings..." - -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url -ynh_app_setting_set --app=$app --key=language --value=$language -ynh_app_setting_set --app=$app --key=admin --value=$admin -ynh_app_setting_set --app=$app --key=admin_email --value=$admin_email -ynh_app_setting_set --app=$app --key=ynh_user_password --value=$ynh_user_password - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# FIND AND OPEN A PORT -#================================================= -ynh_script_progression --message="Finding an available port..." - -# Find an available port -port=$(ynh_find_port --port=8095) -ynh_app_setting_set --app=$app --key=port --value=$port - -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." - -ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies +ynh_app_setting_set --app="$app" --key="ynh_user_password" --value="$ynh_user_password" #================================================= # CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Configuring system user..." +ynh_script_progression --message="Configuring yunohost users..." -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" - -yunohost user create ${app}_notifs --firstname "Mobilizon" --lastname "Notifications" --domain "$domain" --password "$ynh_user_password" -q 0 -yunohost user update ${app}_notifs --add-mailalias $app@$domain --add-mailforward $admin_email +yunohost user create "$ynh_user" --firstname "Mobilizon" --lastname "Notifications" --domain "$domain" --password "$ynh_user_password" -q 0 +yunohost user update "$ynh_user" --add-mailalias "$app@$domain" --add-mailforward "$admin_email" #================================================= # CREATE A POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Creating a PostgreSQL database..." +ynh_script_progression --message="Configuring the PostgreSQL database..." -db_name=$(ynh_sanitize_dbid --db_name=$app) -db_user=$db_name -ynh_app_setting_set --app=$app --key=db_name --value=$db_name -ynh_psql_test_if_first_run -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name -ynh_psql_execute_as_root --sql="ALTER USER $db_user WITH SUPERUSER;" --database="$db_name" -ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS postgis;" --database=$db_name -ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS pg_trgm;" --database=$db_name -ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS unaccent;" --database=$db_name -ynh_psql_execute_as_root --sql="ALTER USER $db_user WITH NOSUPERUSER;" --database="$db_name" -ynh_psql_execute_as_root --sql="ALTER USER $db_user PASSWORD '$db_pwd';" --database=$db_name -db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) +# FIXME: Really superuser ?? +ynh_psql_execute_as_root --database="$db_name" --sql="ALTER USER $db_user WITH SUPERUSER;" +ynh_psql_execute_as_root --database="$db_name" --sql="CREATE EXTENSION IF NOT EXISTS postgis;" +ynh_psql_execute_as_root --database="$db_name" --sql="CREATE EXTENSION IF NOT EXISTS pg_trgm;" +ynh_psql_execute_as_root --database="$db_name" --sql="CREATE EXTENSION IF NOT EXISTS unaccent;" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." -ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$final_path/live" --source_id=$architecture +ynh_setup_source --dest_dir="$install_dir/live" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring NGINX web server..." - -# Create a dedicated NGINX config -ynh_add_nginx_config - -#================================================= -# SPECIFIC SETUP -#================================================= -# CREATE DATA DIRECTORY -#================================================= -ynh_script_progression --message="Creating a data directory..." - -datadir=/home/yunohost.app/$app -ynh_app_setting_set --app=$app --key=datadir --value=$datadir - -mkdir -p $datadir -mkdir -p "$datadir/uploads/" - -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:$app "$datadir" - -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring a systemd service..." - -# Create a dedicated systemd config -ynh_add_systemd_config +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # MAKE SETUP #================================================= ynh_script_progression --message="Making setup..." -mkdir -p /etc/$app -chown -R $app:$app /etc/$app +config_file="$install_dir/config.exs" -config="/etc/$app/config.exs" - -pushd $final_path/live - ynh_exec_as $app MIX_ENV=prod ./bin/mobilizon_ctl instance gen --force --output $config --output-psql /tmp/setup_db.psql --domain $domain --instance-name "Mobilizon" --admin-email "$app@$domain" --dbhost localhost --dbname $db_name --dbuser $db_user --dbpass $db_pwd --listen-port $port - ynh_secure_remove --file="/tmp/setup_db.psql" +pushd "$install_dir/live" + ynh_exec_as "$app" MIX_ENV=prod ./bin/mobilizon_ctl instance gen --force \ + --output "$config_file" \ + --output-psql "$install_dir/setub_db.psql" \ + --domain "$domain" \ + --instance-name "Mobilizon" \ + --admin-email "$app@$domain" \ + --dbhost localhost \ + --dbname "$db_name" \ + --dbuser "$db_user" \ + --dbpass "$db_pwd" \ + --listen-port "$port" + ynh_secure_remove --file="$install_dir/setup_db.psql" popd -cat "../conf/ldap.exs" >> "$config" -ynh_replace_string --match_string="__YNH_USER__" --replace_string="${app}_notifs" --target_file="../conf/mail.exs" -ynh_replace_string --match_string="__YNH_USER_PASSWORD__" --replace_string="${ynh_user_password}" --target_file="../conf/mail.exs" -cat "../conf/mail.exs" >> "$config" -ynh_replace_string --match_string="__DATADIR__" --replace_string="$datadir" --target_file="../conf/uploads.exs" -cat "../conf/uploads.exs" >> "$config" +ynh_add_config --template="ldap.exs" --destination="$install_dir/ldap.exs" +ynh_add_config --template="mail.exs" --destination="$install_dir/mail.exs" +ynh_add_config --template="uploads.exs" --destination="$install_dir/uploads.exs" -ynh_store_file_checksum --file="$config" +cat "$install_dir/ldap.exs" "$install_dir/mail.exs" "$install_dir/uploads.exs" >> "$config_file" +ynh_store_file_checksum --file="$config_file" -chmod 400 "$config" -chown $app:$app "$config" +ynh_secure_remove --file="$install_dir/ldap.exs" +ynh_secure_remove --file="$install_dir/mail.exs" +ynh_secure_remove --file="$install_dir/uploads.exs" -pushd $final_path/live - ynh_exec_as $app ./bin/mobilizon_ctl migrate +chmod 400 "$config_file" +chown "$app:$app" "$config_file" - ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" +pushd "$install_dir/live" + ynh_exec_as "$app" ./bin/mobilizon_ctl migrate + + # ynh_systemd_action --service_name="$app" --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" # We generate a dummy password ... this will actually *not* be used because the admin is supposed to connect via the ldap password=$(ynh_string_random --length=30) - ynh_exec_as $app ./bin/mobilizon_ctl users.new "$admin_email" --admin --password "$password" + ynh_exec_as "$app" ./bin/mobilizon_ctl users.new "$admin_email" --admin --password "$password" - ynh_systemd_action --service_name=$app --action="stop" --log_path=systemd + # ynh_systemd_action --service_name="$app" --action="stop" --log_path=systemd popd #================================================= -# GENERIC FINALIZATION +# SYSTEM CONFIGURATION #================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 -yunohost service add $app --description="$app daemon for Mobilizon" +# Create a dedicated NGINX config +ynh_add_nginx_config + +# Create a dedicated systemd config +ynh_add_systemd_config +yunohost service add "$app" --description="$app daemon for Mobilizon" #================================================= # START SYSTEMD SERVICE @@ -207,29 +116,7 @@ yunohost service add $app --description="$app daemon for Mobilizon" ynh_script_progression --message="Starting a systemd service..." # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" - -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." - -# Make app public if necessary -if [ $is_public -eq 1 ] -then - # Everyone can access the app. - # The "main" permission is automatically created before the install script. - ynh_permission_update --permission="main" --add="visitors" -fi - -ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true" - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." - -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name="$app" --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index b7167f6..e168b31 100644 --- a/scripts/remove +++ b/scripts/remove @@ -12,16 +12,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 @@ -47,18 +47,18 @@ ynh_remove_systemd_config #================================================= # REMOVE THE POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Removing the PostgreSQL database..." +#REMOVEME? ynh_script_progression --message="Removing the PostgreSQL database..." # Remove a database if it exists, along with the associated user -ynh_psql_remove_db --db_user=$db_user --db_name=$db_name +#REMOVEME? ynh_psql_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 @@ -68,7 +68,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 #================================================= @@ -82,10 +82,10 @@ 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_app_dependencies +#REMOVEME? ynh_remove_app_dependencies #================================================= # SPECIFIC REMOVE @@ -105,10 +105,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 yunohost user delete ${app}_notifs diff --git a/scripts/restore b/scripts/restore index d2f1f25..01ddee9 100644 --- a/scripts/restore +++ b/scripts/restore @@ -14,46 +14,46 @@ 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) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -port=$(ynh_app_setting_get --app=$app --key=port) -ynh_user_password=$(ynh_app_setting_get --app=$app --key=ynh_user_password) -admin_email=$(ynh_app_setting_get --app=$app --key=admin_email) -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? db_name=$(ynh_app_setting_get --app=$app --key=db_name) +#REMOVEME? db_user=$db_name +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) +#REMOVEME? ynh_user_password=$(ynh_app_setting_get --app=$app --key=ynh_user_password) +#REMOVEME? admin_email=$(ynh_app_setting_get --app=$app --key=admin_email) +#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 #================================================= # 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 yunohost user create ${app}_notifs --firstname "Mobilizon" --lastname "Notifications" --domain "$domain" --password "$ynh_user_password" -q 0 yunohost user update ${app}_notifs --add-mailalias $app@$domain --add-mailforward $admin_email @@ -63,35 +63,35 @@ yunohost user update ${app}_notifs --add-mailalias $app@$domain --add-mailforwar #================================================= 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 "$datadir/uploads/" +mkdir -p $data_dir +mkdir -p "$data_dir/uploads/" -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:$app "$datadir" +chmod 750 "$data_dir" +chmod -R o-rwx "$data_dir" +chown -R $app:$app "$data_dir" #================================================= # SPECIFIC RESTORATION #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling dependencies..." +#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." # Define and install dependencies -ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies +#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies #================================================= # RESTORE THE NGINX CONFIGURATION @@ -103,11 +103,11 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # RESTORE THE POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Restoring the PostgreSQL database..." +#REMOVEME? ynh_script_progression --message="Restoring the PostgreSQL database..." -ynh_psql_test_if_first_run -db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd +#REMOVEME? ynh_psql_test_if_first_run +#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) +#REMOVEME? ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd ynh_psql_execute_as_root --sql="ALTER USER $db_user WITH SUPERUSER;" --database="$db_name" ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS postgis;" --database=$db_name ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS pg_trgm;" --database=$db_name diff --git a/scripts/upgrade b/scripts/upgrade index 52e3113..b3ce0a8 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=psqlpwd) -port=$(ynh_app_setting_get --app=$app --key=port) -secret=$(ynh_app_setting_get --app=$app --key=secret) -admin_email=$(ynh_app_setting_get --app=$app --key=admin_email) -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? 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=psqlpwd) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) +#REMOVEME? secret=$(ynh_app_setting_get --app=$app --key=secret) +#REMOVEME? admin_email=$(ynh_app_setting_get --app=$app --key=admin_email) +#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir) architecture=$YNH_ARCH #================================================= @@ -45,17 +45,17 @@ previous_version="${version}" #================================================= # 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 @@ -72,23 +72,23 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path=systemd ynh_script_progression --message="Ensuring downward compatibility..." # Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all +#REMOVEME? if ynh_legacy_permissions_exists; then +#REMOVEME? ynh_legacy_permissions_delete_all ynh_app_setting_delete --app=$app --key=is_public fi -if ynh_permission_exists --permission="admin"; then +#REMOVEME? if ynh_permission_exists --permission="admin"; then # Create the required permissions ynh_permission_delete --permission="admin" fi # Create a permission if needed -if ! ynh_permission_exists --permission="api"; then - ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --show_tile="false" --protected="true" +#REMOVEME? if ! ynh_permission_exists --permission="api"; then +#REMOVEME? ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --show_tile="false" --protected="true" fi -ynh_secure_remove --file="$final_path/$app/priv/data/GeoLite2-City.mmdb" +#REMOVEME? ynh_secure_remove --file="$install_dir/$app/priv/data/GeoLite2-City.mmdb" ynh_secure_remove --file="/usr/share/GeoIP" @@ -96,18 +96,18 @@ if ynh_version_gt "1.0.0~ynh1" "${previous_version}" ; then ynh_script_progression --message="Upgrade configuration to 1.0.0..." ynh_user_password=$(ynh_string_random --length=30) - ynh_app_setting_set --app=$app --key=ynh_user_password --value=$ynh_user_password +#REMOVEME? ynh_app_setting_set --app=$app --key=ynh_user_password --value=$ynh_user_password yunohost user create ${app}_notifs --firstname "Mobilizon" --lastname "Notifications" --domain $domain --password "$ynh_user_password" -q 0 yunohost user update ${app}_notifs --add-mailalias $app@$domain --add-mailforward $admin_email # Manage previous .env file - ynh_backup_if_checksum_is_different --file="$final_path/$app/.env" - ynh_delete_file_checksum --file="$final_path/$app/.env" - ynh_secure_remove --file="$final_path/$app/.env" + ynh_backup_if_checksum_is_different --file="$install_dir/$app/.env" + ynh_delete_file_checksum --file="$install_dir/$app/.env" +#REMOVEME? ynh_secure_remove --file="$install_dir/$app/.env" # Configure Mobilizon - config="$final_path/$app/config/runtime.exs" + config="$install_dir/$app/config/runtime.exs" ynh_add_config --template="../conf/runtime.exs" --destination="$config" # Implement ldap and mail @@ -120,30 +120,30 @@ if ynh_version_gt "1.0.0~ynh1" "${previous_version}" ; then ynh_store_file_checksum --file="$config" fi -# If datadir doesn't exist, create it -if [ -z "$datadir" ]; then - ynh_script_progression --message="Create datadir folder..." +# If data_dir doesn't exist, create it +if [ -z "$data_dir" ]; then + ynh_script_progression --message="Create data_dir folder..." # Define app's data directory - datadir="/home/yunohost.app/${app}" + data_dir="/home/yunohost.app/${app}" - ynh_app_setting_set --app=$app --key=datadir --value="$datadir" +#REMOVEME? ynh_app_setting_set --app=$app --key=data_dir --value="$data_dir" # Create app folders - mkdir -p "$datadir/" - mkdir -p "$datadir/uploads/" + mkdir -p "$data_dir/" + mkdir -p "$data_dir/uploads/" - chmod 750 "$datadir" - chmod -R o-rwx "$datadir" - chown -R $app:$app "$datadir" + chmod 750 "$data_dir" + chmod -R o-rwx "$data_dir" + chown -R $app:$app "$data_dir" - rsync -a $final_path/$app/uploads/ $datadir/uploads/ + rsync -a $install_dir/$app/uploads/ $data_dir/uploads/ - config="$final_path/$app/config/runtime.exs" + config="$install_dir/$app/config/runtime.exs" ynh_backup_if_checksum_is_different --file="$config" - ynh_replace_string --match_string="__DATADIR__" --replace_string="$datadir" --target_file="../conf/uploads.exs" + ynh_replace_string --match_string="__DATA_DIR__" --replace_string="$data_dir" --target_file="../conf/uploads.exs" cat "../conf/uploads.exs" >> "$config" ynh_store_file_checksum --file="$config" @@ -151,25 +151,25 @@ if [ -z "$datadir" ]; then chmod 400 "$config" chown $app:$app "$config" - ynh_secure_remove --file="$final_path/$app/uploads" +#REMOVEME? ynh_secure_remove --file="$install_dir/$app/uploads" fi if ynh_version_gt "1.2.3~ynh1" "${previous_version}" ; then ynh_script_progression --message="Upgrade to 1.2.3~ynh1..." - ynh_delete_file_checksum --file="$final_path/$app/config/runtime.exs" - mv "$final_path/$app/" "$final_path/live/" - ynh_store_file_checksum --file="$final_path/live/config/runtime.exs" + ynh_delete_file_checksum --file="$install_dir/$app/config/runtime.exs" + mv "$install_dir/$app/" "$install_dir/live/" + ynh_store_file_checksum --file="$install_dir/live/config/runtime.exs" fi if ynh_version_gt "2.0.2~ynh1" "${previous_version}" ; then mkdir -p /etc/$app - if [ -f "$final_path/live/config/prod.secret.exs" ]; then - ynh_delete_file_checksum --file="$final_path/live/config/prod.secret.exs" - mv -f "$final_path/live/config/prod.secret.exs" "/etc/$app/config.exs" + if [ -f "$install_dir/live/config/prod.secret.exs" ]; then + ynh_delete_file_checksum --file="$install_dir/live/config/prod.secret.exs" + mv -f "$install_dir/live/config/prod.secret.exs" "/etc/$app/config.exs" fi - if [ -f "$final_path/live/config/runtime.exs" ]; then - ynh_delete_file_checksum --file="$final_path/live/config/runtime.exs" - mv -f "$final_path/live/config/runtime.exs" "/etc/$app/config.exs" + if [ -f "$install_dir/live/config/runtime.exs" ]; then + ynh_delete_file_checksum --file="$install_dir/live/config/runtime.exs" + mv -f "$install_dir/live/config/runtime.exs" "/etc/$app/config.exs" fi chown -R $app:$app /etc/$app ynh_store_file_checksum --file="/etc/$app/config.exs" @@ -178,10 +178,10 @@ fi #================================================= # 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 @@ -192,22 +192,22 @@ then ynh_script_progression --message="Upgrading source files..." # Remove the app directory securely - ynh_secure_remove --file="$final_path/live" +#REMOVEME? ynh_secure_remove --file="$install_dir/live" # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path/live" --source_id=$architecture + ynh_setup_source --dest_dir="$install_dir/live" --source_id=$architecture 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" #================================================= # UPGRADE DEPENDENCIES #================================================= -ynh_script_progression --message="Upgrading dependencies..." +#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." -ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies +#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies #================================================= # NGINX CONFIGURATION @@ -220,23 +220,23 @@ ynh_add_nginx_config #================================================= # SPECIFIC UPGRADE #================================================= -# CREATE DATADIR FOLDER +# CREATE DATA_DIR FOLDER #================================================= -ynh_script_progression --message="Create datadir folder..." +ynh_script_progression --message="Create data_dir folder..." -mkdir -p $datadir -mkdir -p "$datadir/uploads/" +mkdir -p $data_dir +mkdir -p "$data_dir/uploads/" -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:$app "$datadir" +chmod 750 "$data_dir" +chmod -R o-rwx "$data_dir" +chown -R $app:$app "$data_dir" #================================================= # MAKE SETUP #================================================= ynh_script_progression --message="Making setup..." -pushd $final_path/live +pushd $install_dir/live ynh_exec_as $app ./bin/mobilizon_ctl migrate popd @@ -282,9 +282,9 @@ ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --lin #================================================= # 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/tests.toml b/tests.toml new file mode 100644 index 0000000..3a88245 --- /dev/null +++ b/tests.toml @@ -0,0 +1,16 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + # args.domain="domain.tld" + # args.is_public=1 + # args.language="fr" + # args.admin="john" + # args.password="1Strong-Password" + # args.name="My_Mobilizon" + + test_upgrade_from.0159fc6123536cdf2929b4617d89753283f6946d.name = "2.0.2~ynh1" + test_upgrade_from.2dd97e495207a1b5e58b8ba5f501fe84d1db7623.name = "2.0.2~ynh2" + test_upgrade_from.f9c1792c86cffd17b72a48160a64ee2083d5ccf6.name = "2.1.0~ynh1" From b579126b2d0195d91e83e0fd20fb84a8d0b8c8d4 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Tue, 6 Feb 2024 14:51:36 +0000 Subject: [PATCH 02/18] Auto-update README --- README.md | 13 +------------ README_fr.md | 13 +------------ 2 files changed, 2 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 127c7a2..05c2ac9 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,12 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -A decentralized and federated platform to organize events +A decentralized and federated platform to organize events. - Mobilizon is a tool that helps you find, create and organize events. - - You can also create a page for your group where the members will be able to get organized together. - **Shipped version:** 4.0.0~ynh1 **Demo:** https://demo.mobilizon.org @@ -32,15 +30,6 @@ A decentralized and federated platform to organize events ![Screenshot of Mobilizon](./doc/screenshots/screenshot1.jpg) -## Disclaimers / important information - -* **Mobilizon** require a dedicated **root domain**, eg. mobilizon.domain.tld -* To connect as **Mobilizon** administrator, use the email address and password of the user you choose during install -* By default registrations are closed -* All YunoHost users are allowed to connect - -* Configuration can be made in the Mobilizon administration panel. - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index bb9f194..8526d30 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,14 +16,12 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -A decentralized and federated platform to organize events +A decentralized and federated platform to organize events. - Mobilizon is a tool that helps you find, create and organize events. - - You can also create a page for your group where the members will be able to get organized together. - **Version incluse :** 4.0.0~ynh1 **Démo :** https://demo.mobilizon.org @@ -32,15 +30,6 @@ A decentralized and federated platform to organize events ![Capture d’écran de Mobilizon](./doc/screenshots/screenshot1.jpg) -## Avertissements / informations importantes - -* **Mobilizon** require a dedicated **root domain**, eg. mobilizon.domain.tld -* To connect as **Mobilizon** administrator, use the email address and password of the user you choose during install -* By default registrations are closed -* All YunoHost users are allowed to connect - -* Configuration can be made in the Mobilizon administration panel. - ## Documentations et ressources * Site officiel de l’app : From 995558ee46bab1db07afc854b3fe6d341328f19c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 16:39:07 +0100 Subject: [PATCH 03/18] fix url to artifacts --- manifest.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/manifest.toml b/manifest.toml index d3611d3..0dc3a75 100644 --- a/manifest.toml +++ b/manifest.toml @@ -7,7 +7,7 @@ name = "Mobilizon" description.en = "Decentralized and federated platform to organize events" description.fr = "Plateforme décentralisée et fédérée pour organiser des événements" -version = "4.0.0~ynh1" +version = "4.0.0~ynh2" maintainers = ["yalh76"] @@ -49,7 +49,7 @@ ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requiremen [resources] [resources.sources.main] - amd64.url = "https://packages.joinmobilizon.org/4.0.2/mobilizon_4.0.2_amd64-debian-bullseye.tar.gz" + amd64.url = "https://packages.joinmobilizon.org/4.0.0/mobilizon_4.0.0_amd64-debian-bullseye.tar.gz" amd64.sha256 = "a0007f7564c01ea8b0bfc9b3b32742473839b0217aae59dea74eacfd3b1774ac" arm64.url = "https://packages.joinmobilizon.org/4.0.0/mobilizon_4.0.0_arm64-debian-bullseye.tar.gz" arm64.sha256 = "c63495d8a176e28843d0217c2b273bb5aca84123658286101a962467fc6f045b" From ca2c65da2a823aec62fa6748d7472da650a15709 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Tue, 6 Feb 2024 15:39:13 +0000 Subject: [PATCH 04/18] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 05c2ac9..8eea4fe 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ A decentralized and federated platform to organize events. - You can also create a page for your group where the members will be able to get organized together. -**Shipped version:** 4.0.0~ynh1 +**Shipped version:** 4.0.0~ynh2 **Demo:** https://demo.mobilizon.org diff --git a/README_fr.md b/README_fr.md index 8526d30..61696c2 100644 --- a/README_fr.md +++ b/README_fr.md @@ -22,7 +22,7 @@ A decentralized and federated platform to organize events. - You can also create a page for your group where the members will be able to get organized together. -**Version incluse :** 4.0.0~ynh1 +**Version incluse :** 4.0.0~ynh2 **Démo :** https://demo.mobilizon.org From 62cad43cbc73a41455dfe401d8279d6cb058847c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 16:45:13 +0100 Subject: [PATCH 05/18] fix user create cli --- scripts/install | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/install b/scripts/install index 281f828..3da3d23 100644 --- a/scripts/install +++ b/scripts/install @@ -25,7 +25,7 @@ ynh_app_setting_set --app="$app" --key="ynh_user_password" --value="$ynh_user_pa #================================================= ynh_script_progression --message="Configuring yunohost users..." -yunohost user create "$ynh_user" --firstname "Mobilizon" --lastname "Notifications" --domain "$domain" --password "$ynh_user_password" -q 0 +yunohost user create "$ynh_user" -F "Mobilizon Notifications" --domain "$domain" --password "$ynh_user_password" -q 0 yunohost user update "$ynh_user" --add-mailalias "$app@$domain" --add-mailforward "$admin_email" #================================================= From 9ae02e08bfa48550c8dd2041b7f569f26d04a7e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 17:15:50 +0100 Subject: [PATCH 06/18] fix mobilizon_config_path --- conf/systemd.service | 1 + scripts/install | 19 ++++++++++--------- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/conf/systemd.service b/conf/systemd.service index a5783b0..02f8387 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -7,6 +7,7 @@ Type=simple User=__APP__ Group=__APP__ Environment=MIX_ENV=prod +Environment=MOBILIZON_CONFIG_PATH="__INSTALL_DIR__/config.exs" WorkingDirectory=__INSTALL_DIR__/live/ ExecStart=__INSTALL_DIR__/live/bin/mobilizon start ExecStop=__INSTALL_DIR__/live/bin/mobilizon stop diff --git a/scripts/install b/scripts/install index 3da3d23..7d82fa4 100644 --- a/scripts/install +++ b/scripts/install @@ -55,11 +55,12 @@ chown -R "$app:www-data" "$install_dir" #================================================= ynh_script_progression --message="Making setup..." -config_file="$install_dir/config.exs" +MOBILIZON_CONFIG_PATH="$install_dir/config.exs" pushd "$install_dir/live" - ynh_exec_as "$app" MIX_ENV=prod ./bin/mobilizon_ctl instance gen --force \ - --output "$config_file" \ + ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" MIX_ENV=prod \ + ./bin/mobilizon_ctl instance gen --force \ + --output "$MOBILIZON_CONFIG_PATH" \ --output-psql "$install_dir/setub_db.psql" \ --domain "$domain" \ --instance-name "Mobilizon" \ @@ -76,24 +77,24 @@ ynh_add_config --template="ldap.exs" --destination="$install_dir/ldap.exs" ynh_add_config --template="mail.exs" --destination="$install_dir/mail.exs" ynh_add_config --template="uploads.exs" --destination="$install_dir/uploads.exs" -cat "$install_dir/ldap.exs" "$install_dir/mail.exs" "$install_dir/uploads.exs" >> "$config_file" -ynh_store_file_checksum --file="$config_file" +cat "$install_dir/ldap.exs" "$install_dir/mail.exs" "$install_dir/uploads.exs" >> "$MOBILIZON_CONFIG_PATH" +ynh_store_file_checksum --file="$MOBILIZON_CONFIG_PATH" ynh_secure_remove --file="$install_dir/ldap.exs" ynh_secure_remove --file="$install_dir/mail.exs" ynh_secure_remove --file="$install_dir/uploads.exs" -chmod 400 "$config_file" -chown "$app:$app" "$config_file" +chmod 400 "$MOBILIZON_CONFIG_PATH" +chown "$app:$app" "$MOBILIZON_CONFIG_PATH" pushd "$install_dir/live" - ynh_exec_as "$app" ./bin/mobilizon_ctl migrate + ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" ./bin/mobilizon_ctl migrate # ynh_systemd_action --service_name="$app" --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" # We generate a dummy password ... this will actually *not* be used because the admin is supposed to connect via the ldap password=$(ynh_string_random --length=30) - ynh_exec_as "$app" ./bin/mobilizon_ctl users.new "$admin_email" --admin --password "$password" + ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" ./bin/mobilizon_ctl users.new "$admin_email" --admin --password "$password" # ynh_systemd_action --service_name="$app" --action="stop" --log_path=systemd popd From ab9a4e837b8a4a33199bad42cb5961e0637c484a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 17:32:34 +0100 Subject: [PATCH 07/18] reorg the finalization step --- scripts/install | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/scripts/install b/scripts/install index 7d82fa4..58d244a 100644 --- a/scripts/install +++ b/scripts/install @@ -87,17 +87,7 @@ ynh_secure_remove --file="$install_dir/uploads.exs" chmod 400 "$MOBILIZON_CONFIG_PATH" chown "$app:$app" "$MOBILIZON_CONFIG_PATH" -pushd "$install_dir/live" - ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" ./bin/mobilizon_ctl migrate - - # ynh_systemd_action --service_name="$app" --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" - - # We generate a dummy password ... this will actually *not* be used because the admin is supposed to connect via the ldap - password=$(ynh_string_random --length=30) - ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" ./bin/mobilizon_ctl users.new "$admin_email" --admin --password "$password" - - # ynh_systemd_action --service_name="$app" --action="stop" --log_path=systemd -popd +ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" "$install_dir/live/bin/mobilizon_ctl" migrate #================================================= # SYSTEM CONFIGURATION @@ -111,6 +101,19 @@ ynh_add_nginx_config ynh_add_systemd_config yunohost service add "$app" --description="$app daemon for Mobilizon" +#================================================= +# SETUP APPLICATION +#================================================= +ynh_script_progression --message="Finalizing installation..." --weight=1 + +ynh_systemd_action --service_name="$app" --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" + +# We generate a dummy password ... this will actually *not* be used because the admin is supposed to connect via the ldap +ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" "$install_dir/live/bin/mobilizon_ctl" \ + users.new "$admin_email" --admin --password "$(ynh_string_random --length=30)" + +ynh_systemd_action --service_name="$app" --action="stop" --log_path=systemd + #================================================= # START SYSTEMD SERVICE #================================================= From ddc9cf485601129d36e38ce6493a50b4f0a12989 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 17:32:50 +0100 Subject: [PATCH 08/18] indent with spaces --- scripts/install | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/scripts/install b/scripts/install index 58d244a..a7b6059 100644 --- a/scripts/install +++ b/scripts/install @@ -58,19 +58,19 @@ ynh_script_progression --message="Making setup..." MOBILIZON_CONFIG_PATH="$install_dir/config.exs" pushd "$install_dir/live" - ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" MIX_ENV=prod \ - ./bin/mobilizon_ctl instance gen --force \ - --output "$MOBILIZON_CONFIG_PATH" \ - --output-psql "$install_dir/setub_db.psql" \ - --domain "$domain" \ - --instance-name "Mobilizon" \ - --admin-email "$app@$domain" \ - --dbhost localhost \ - --dbname "$db_name" \ - --dbuser "$db_user" \ - --dbpass "$db_pwd" \ - --listen-port "$port" - ynh_secure_remove --file="$install_dir/setup_db.psql" + ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" MIX_ENV=prod \ + ./bin/mobilizon_ctl instance gen --force \ + --output "$MOBILIZON_CONFIG_PATH" \ + --output-psql "$install_dir/setub_db.psql" \ + --domain "$domain" \ + --instance-name "Mobilizon" \ + --admin-email "$app@$domain" \ + --dbhost localhost \ + --dbname "$db_name" \ + --dbuser "$db_user" \ + --dbpass "$db_pwd" \ + --listen-port "$port" + ynh_secure_remove --file="$install_dir/setup_db.psql" popd ynh_add_config --template="ldap.exs" --destination="$install_dir/ldap.exs" From 6b11805073ef7a80fcc2d66a1f7e91bb1f832bb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 18:00:30 +0100 Subject: [PATCH 09/18] fix remove --- scripts/_common.sh | 2 + scripts/install | 1 - scripts/remove | 95 +++++----------------------------------------- 3 files changed, 11 insertions(+), 87 deletions(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index 944a65e..4f3dd2c 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,6 +4,8 @@ # COMMON VARIABLES #================================================= +ynh_user="${app}_notifs" + #================================================= # PERSONAL HELPERS #================================================= diff --git a/scripts/install b/scripts/install index a7b6059..616fcf2 100644 --- a/scripts/install +++ b/scripts/install @@ -16,7 +16,6 @@ source /usr/share/yunohost/helpers admin_email=$(ynh_user_get_info --username="$admin" --key="mail") ynh_app_setting_set --app="$app" --key="admin_email" --value="$admin_email" -ynh_user="${app}_notifs" ynh_user_password=$(ynh_string_random --length=30) ynh_app_setting_set --app="$app" --key="ynh_user_password" --value="$ynh_user_password" diff --git a/scripts/remove b/scripts/remove index e168b31..92bd396 100644 --- a/scripts/remove +++ b/scripts/remove @@ -10,107 +10,30 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#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 -#================================================= -# REMOVE SERVICE INTEGRATION IN YUNOHOST +# REMOVE SYSTEM CONFIGURATIONS #================================================= +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 # Remove the service from the list of services known by YunoHost (added from `yunohost service add`) -if ynh_exec_warn_less yunohost service status $app >/dev/null -then - ynh_script_progression --message="Removing $app service integration..." - yunohost service remove $app +if ynh_exec_warn_less yunohost service status "$app" >/dev/null; then + yunohost service remove "$app" fi -#================================================= -# STOP AND REMOVE SERVICE -#================================================= -ynh_script_progression --message="Stopping and removing the systemd service..." +# Properly kill the service processes +ynh_systemd_action --service_name="$app" --action="stop" --log_path=systemd +pkill -f "$app" || true # Remove the dedicated systemd config ynh_remove_systemd_config -#================================================= -# REMOVE THE POSTGRESQL DATABASE -#================================================= -#REMOVEME? ynh_script_progression --message="Removing the PostgreSQL database..." - -# Remove a database if it exists, along with the associated user -#REMOVEME? ynh_psql_remove_db --db_user=$db_user --db_name=$db_name - -#================================================= -# REMOVE APP MAIN DIR -#================================================= -#REMOVEME? ynh_script_progression --message="Removing app main directory..." - -# Remove the app directory securely -#REMOVEME? ynh_secure_remove --file="$install_dir" - -#================================================= -# REMOVE DATA DIR -#================================================= - -# Remove the data directory if --purge option is used -if [ "${YNH_APP_PURGE:-0}" -eq 1 ] -then - ynh_script_progression --message="Removing app data directory..." -#REMOVEME? ynh_secure_remove --file="$data_dir" -fi - -#================================================= -# REMOVE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." - # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -#REMOVEME? ynh_script_progression --message="Removing dependencies..." - -# Remove metapackage and its dependencies -#REMOVEME? ynh_remove_app_dependencies - -#================================================= -# SPECIFIC REMOVE -#================================================= -# REMOVE VARIOUS FILES -#================================================= -ynh_script_progression --message="Removing various files..." - -# Remove a directory securely -ynh_secure_remove --file="/etc/$app" - # Remove the log files ynh_secure_remove --file="/var/log/$app" -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." - -# Delete a system user -#REMOVEME? ynh_system_user_delete --username=$app - -yunohost user delete ${app}_notifs +# Remove the notifications user +yunohost user delete "$ynh_user" #================================================= # END OF SCRIPT From 4c35e73dc85eade07082cdb8be04b684370f1b39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 18:18:09 +0100 Subject: [PATCH 10/18] fix remove again --- scripts/remove | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/remove b/scripts/remove index 92bd396..1cb6029 100644 --- a/scripts/remove +++ b/scripts/remove @@ -21,7 +21,7 @@ fi # Properly kill the service processes ynh_systemd_action --service_name="$app" --action="stop" --log_path=systemd -pkill -f "$app" || true +pkill -u "$app" || true # Remove the dedicated systemd config ynh_remove_systemd_config From 65156b66cb514b7affedeb686a5cc66520b263d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 18:54:23 +0100 Subject: [PATCH 11/18] update backup/restore change_url --- scripts/_common.sh | 2 + scripts/backup | 32 +----------- scripts/change_url | 107 +++----------------------------------- scripts/install | 2 - scripts/restore | 124 ++++++++------------------------------------- 5 files changed, 33 insertions(+), 234 deletions(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index 4f3dd2c..4154ebc 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -6,6 +6,8 @@ ynh_user="${app}_notifs" +MOBILIZON_CONFIG_PATH="$install_dir/config.exs" + #================================================= # PERSONAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index c10996d..6a81403 100644 --- a/scripts/backup +++ b/scripts/backup @@ -10,28 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -#REMOVEME? ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_print_info --message="Loading installation settings..." - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#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 #================================================= @@ -50,24 +28,18 @@ ynh_backup --src_path="$install_dir" ynh_backup --src_path="$data_dir" --is_big #================================================= -# BACKUP THE NGINX CONFIGURATION +# SYSTEM CONFIGURATION #================================================= ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# SPECIFIC BACKUP -#================================================= -# BACKUP SYSTEMD -#================================================= - ynh_backup --src_path="/etc/systemd/system/$app.service" #================================================= # BACKUP VARIOUS FILES #================================================= -ynh_backup --src_path="/etc/$app/" +ynh_backup --src_path="/var/log/$app/" #================================================= # BACKUP THE POSTGRESQL DATABASE diff --git a/scripts/change_url b/scripts/change_url index 58c6124..3f71b7c 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,65 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -#REMOVEME? old_domain=$YNH_APP_OLD_DOMAIN -#REMOVEME? old_path=$YNH_APP_OLD_PATH - -#REMOVEME? new_domain=$YNH_APP_NEW_DOMAIN -#REMOVEME? new_path="/" - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." - -#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 -#REMOVEME? #db_name=$(ynh_app_setting_get --app=$app --key=db_name) -#db_user=$db_name -#REMOVEME? #db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -#REMOVEME? ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." - -# Backup the current version of the app -#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. -#REMOVEME? ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # Restore it if the upgrade fails -#REMOVEME? ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -#REMOVEME? change_domain=0 -#REMOVEME? if [ "$old_domain" != "$new_domain" ] -then - #REMOVEME? change_domain=1 -fi - -#REMOVEME? change_path=0 -#REMOVEME? if [ "$old_path" != "$new_path" ] -then - #REMOVEME? change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -84,31 +25,6 @@ ynh_script_progression --message="Updating NGINX web server configuration..." 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 -#REMOVEME? ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper -#REMOVEME? domain="$old_domain" -#REMOVEME? path="$new_path" - # Create a dedicated 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 -#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 -#REMOVEME? ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - yunohost user update "${app}_notifs" --mail "${app}_notifs@${new_domain}" --add-mailalias "${app}@${new_domain}" -fi - #================================================= # SPECIFIC MODIFICATIONS #================================================= @@ -116,16 +32,16 @@ fi #================================================= ynh_script_progression --message="Modifying a config file..." -config="/etc/$app/config.exs" -ynh_backup_if_checksum_is_different --file="$config" +if [ $change_domain -eq 1 ]; then + yunohost user update "$ynh_user" --mail "$ynh_user@$domain" --add-mailalias "$app@$domain" +fi -ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="$config" - -# Recalculate and store the checksum of the file for the next upgrade. -ynh_store_file_checksum --file="$config" +ynh_backup_if_checksum_is_different --file="$install_dir/config.exs" +ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="$install_dir/config.exs" +ynh_store_file_checksum --file="$install_dir/config.exs" chmod 400 "$config" -chown $app:$app "$config" +chown "$app:$app" "$config" #================================================= # GENERIC FINALISATION @@ -135,14 +51,7 @@ chown $app:$app "$config" ynh_script_progression --message="Starting a systemd service..." # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" - -#================================================= -# RELOAD NGINX -#================================================= -#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." - -#REMOVEME? #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name="$app" --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 616fcf2..2c3a487 100644 --- a/scripts/install +++ b/scripts/install @@ -54,8 +54,6 @@ chown -R "$app:www-data" "$install_dir" #================================================= ynh_script_progression --message="Making setup..." -MOBILIZON_CONFIG_PATH="$install_dir/config.exs" - pushd "$install_dir/live" ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" MIX_ENV=prod \ ./bin/mobilizon_ctl instance gen --force \ diff --git a/scripts/restore b/scripts/restore index 01ddee9..719d8f9 100644 --- a/scripts/restore +++ b/scripts/restore @@ -11,52 +11,12 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# CREATE DEDICATED USER #================================================= +ynh_script_progression --message="Configuring yunohost users..." -#REMOVEME? ynh_clean_setup () { - ynh_clean_check_starting -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#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? db_name=$(ynh_app_setting_get --app=$app --key=db_name) -#REMOVEME? db_user=$db_name -#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) -#REMOVEME? ynh_user_password=$(ynh_app_setting_get --app=$app --key=ynh_user_password) -#REMOVEME? admin_email=$(ynh_app_setting_get --app=$app --key=admin_email) -#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." - -#REMOVEME? test ! -d $install_dir \ - || ynh_die --message="There is already a directory: $install_dir " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -#REMOVEME? ynh_script_progression --message="Recreating the dedicated system user..." - -# Create the dedicated user (if not existing) -#REMOVEME? ynh_system_user_create --username=$app --home_dir=$install_dir - -yunohost user create ${app}_notifs --firstname "Mobilizon" --lastname "Notifications" --domain "$domain" --password "$ynh_user_password" -q 0 -yunohost user update ${app}_notifs --add-mailalias $app@$domain --add-mailforward $admin_email +yunohost user create "$ynh_user" --firstname "Mobilizon" --lastname "Notifications" --domain "$domain" --password "$ynh_user_password" -q 0 +yunohost user update "$ynh_user" --add-mailalias "$app@$domain" --add-mailforward "$admin_email" #================================================= # RESTORE THE APP MAIN DIR @@ -65,9 +25,8 @@ ynh_script_progression --message="Restoring the app main directory..." ynh_restore_file --origin_path="$install_dir" -chmod 750 "$install_dir" chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # RESTORE THE DATA DIRECTORY @@ -76,80 +35,39 @@ ynh_script_progression --message="Restoring the data directory..." ynh_restore_file --origin_path="$data_dir" --not_mandatory -mkdir -p $data_dir -mkdir -p "$data_dir/uploads/" - -chmod 750 "$data_dir" chmod -R o-rwx "$data_dir" -chown -R $app:$app "$data_dir" - -#================================================= -# SPECIFIC RESTORATION -#================================================= -# REINSTALL DEPENDENCIES -#================================================= -#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." - -# Define and install dependencies -#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX web server configuration..." - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" +chown -R "$app:$app" "$data_dir" #================================================= # RESTORE THE POSTGRESQL DATABASE #================================================= -#REMOVEME? ynh_script_progression --message="Restoring the PostgreSQL database..." +ynh_script_progression --message="Restoring the PostgreSQL database..." -#REMOVEME? ynh_psql_test_if_first_run -#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) -#REMOVEME? ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd -ynh_psql_execute_as_root --sql="ALTER USER $db_user WITH SUPERUSER;" --database="$db_name" -ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS postgis;" --database=$db_name -ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS pg_trgm;" --database=$db_name -ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS unaccent;" --database=$db_name -ynh_psql_execute_as_root --sql="ALTER USER $db_user WITH NOSUPERUSER;" --database="$db_name" -ynh_psql_execute_file_as_root --file="./db.sql" --database=$db_name +ynh_psql_execute_as_root --database="$db_name" --sql="ALTER USER $db_user WITH SUPERUSER;" +ynh_psql_execute_as_root --database="$db_name" --sql="CREATE EXTENSION IF NOT EXISTS postgis;" +ynh_psql_execute_as_root --database="$db_name" --sql="CREATE EXTENSION IF NOT EXISTS pg_trgm;" +ynh_psql_execute_as_root --database="$db_name" --sql="CREATE EXTENSION IF NOT EXISTS unaccent;" +ynh_psql_execute_as_root --database="$db_name" --sql="ALTER USER $db_user WITH NOSUPERUSER;" + +ynh_mysql_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" < ./db.sql #================================================= -# RESTORE VARIOUS FILES +# RESTORE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Restoring various files..." +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 -ynh_restore_file --origin_path="/etc/$app/" - -#================================================= -# RESTORE SYSTEMD -#================================================= -ynh_script_progression --message="Restoring the systemd configuration..." +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore_file --origin_path="/etc/systemd/system/$app.service" -systemctl enable $app.service --quiet - -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add $app --description="$app daemon for Mobilizon" +systemctl enable "$app.service" --quiet +yunohost service add "$app" --description="$app daemon for Mobilizon" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." +ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1 -ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." +ynh_systemd_action --service_name="$app" --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" ynh_systemd_action --service_name=nginx --action=reload From 5a933aa8ac74f5cc6c9fd8cf52e09ad469039927 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 19:25:53 +0100 Subject: [PATCH 12/18] Try upgrade --- scripts/upgrade | 290 ++++++++---------------------------- scripts/ynh_package_version | 26 ---- 2 files changed, 61 insertions(+), 255 deletions(-) delete mode 100644 scripts/ynh_package_version diff --git a/scripts/upgrade b/scripts/upgrade index b3ce0a8..c58982a 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -7,56 +7,8 @@ #================================================= source _common.sh -source ynh_package_version source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -#REMOVEME? ynh_script_progression --message="Loading installation settings..." - -#REMOVEME? app=$YNH_APP_INSTANCE_NAME - -#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=psqlpwd) -#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) -#REMOVEME? secret=$(ynh_app_setting_get --app=$app --key=secret) -#REMOVEME? admin_email=$(ynh_app_setting_get --app=$app --key=admin_email) -#REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir) -architecture=$YNH_ARCH - -#================================================= -# CHECK VERSION -#================================================= -ynh_script_progression --message="Checking version..." - -upgrade_type=$(ynh_check_app_version_changed) - -abort_if_up_to_date -# previous function is what defines 'version', more precisely the 'previous version' -previous_version="${version}" - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -#REMOVEME? ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." - -# Backup the current version of the app -#REMOVEME? ynh_backup_before_upgrade -#REMOVEME? ynh_clean_setup () { - ynh_clean_check_starting - # Restore it if the upgrade fails -#REMOVEME? ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -#REMOVEME? ynh_abort_if_errors - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -71,220 +23,100 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path=systemd #================================================= ynh_script_progression --message="Ensuring downward compatibility..." -# Cleaning legacy permissions -#REMOVEME? if ynh_legacy_permissions_exists; then -#REMOVEME? ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -#REMOVEME? if ynh_permission_exists --permission="admin"; then - # Create the required permissions - ynh_permission_delete --permission="admin" -fi - -# Create a permission if needed -#REMOVEME? if ! ynh_permission_exists --permission="api"; then -#REMOVEME? ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --show_tile="false" --protected="true" -fi - -#REMOVEME? ynh_secure_remove --file="$install_dir/$app/priv/data/GeoLite2-City.mmdb" - +# Cleanup +ynh_secure_remove --file="$install_dir/$app/priv/data/GeoLite2-City.mmdb" ynh_secure_remove --file="/usr/share/GeoIP" -if ynh_version_gt "1.0.0~ynh1" "${previous_version}" ; then - ynh_script_progression --message="Upgrade configuration to 1.0.0..." - - ynh_user_password=$(ynh_string_random --length=30) -#REMOVEME? ynh_app_setting_set --app=$app --key=ynh_user_password --value=$ynh_user_password - - yunohost user create ${app}_notifs --firstname "Mobilizon" --lastname "Notifications" --domain $domain --password "$ynh_user_password" -q 0 - yunohost user update ${app}_notifs --add-mailalias $app@$domain --add-mailforward $admin_email - - # Manage previous .env file - ynh_backup_if_checksum_is_different --file="$install_dir/$app/.env" - ynh_delete_file_checksum --file="$install_dir/$app/.env" -#REMOVEME? ynh_secure_remove --file="$install_dir/$app/.env" - - # Configure Mobilizon - config="$install_dir/$app/config/runtime.exs" - ynh_add_config --template="../conf/runtime.exs" --destination="$config" - - # Implement ldap and mail - cat "../conf/ldap.exs" >> "$config" - ynh_replace_string --match_string="__YNH_USER__" --replace_string="${app}_notifs" --target_file="../conf/mail.exs" - ynh_replace_string --match_string="__YNH_USER_PASSWORD__" --replace_string="${ynh_user_password}" --target_file="../conf/mail.exs" - cat "../conf/mail.exs" >> "$config" - - # Recalculate and store the checksum of the file for the next upgrade. - ynh_store_file_checksum --file="$config" +# Move legacy configuration files +if [ ! -f "$install_dir/config.exs" ]; then + if [ -f "$install_dir/live/config/prod.secret.exs" ]; then + ynh_delete_file_checksum --file="$install_dir/live/config/prod.secret.exs" + mv -f "$install_dir/live/config/prod.secret.exs" "$install_dir/config.exs" + fi + if [ -f "$install_dir/live/config/runtime.exs" ]; then + ynh_delete_file_checksum --file="$install_dir/live/config/runtime.exs" + mv -f "$install_dir/live/config/runtime.exs" "$install_dir/config.exs" + fi + if [ -f "/etc/$app/config.exs" ]; then + ynh_delete_file_checksum --file="/etc/$app/config.exs" + mv -f "/etc/$app/config.exs" "$install_dir/config.exs" + ynh_secure_remove --file="/etc/$app" + fi + chown -R "$app:$app" "$install_dir/config.exs" + ynh_store_file_checksum --file="$install_dir/config.exs" +fi +# Check if previous "if block" did the job +if [ ! -f "$install_dir/config.exs" ]; then + ynh_die --message="Could not find a previous configuration file. Please contact maintainers on the forum." fi -# If data_dir doesn't exist, create it -if [ -z "$data_dir" ]; then - ynh_script_progression --message="Create data_dir folder..." +# Migrate data to data_dir +# FIXME: could be old, might be nice to remove +if [ -n "$(ls -A "$install_dir/$app/uploads/")" ]; then + ynh_script_progression --message="Moving data directory..." + rsync -a "$install_dir/$app/uploads/" "$data_dir/uploads/" + ynh_secure_remove "$install_dir/$app/uploads" - # Define app's data directory - data_dir="/home/yunohost.app/${app}" - -#REMOVEME? ynh_app_setting_set --app=$app --key=data_dir --value="$data_dir" - - # Create app folders - mkdir -p "$data_dir/" - mkdir -p "$data_dir/uploads/" - - chmod 750 "$data_dir" - chmod -R o-rwx "$data_dir" - chown -R $app:$app "$data_dir" - - rsync -a $install_dir/$app/uploads/ $data_dir/uploads/ - - config="$install_dir/$app/config/runtime.exs" - - ynh_backup_if_checksum_is_different --file="$config" - - ynh_replace_string --match_string="__DATA_DIR__" --replace_string="$data_dir" --target_file="../conf/uploads.exs" - cat "../conf/uploads.exs" >> "$config" - - ynh_store_file_checksum --file="$config" - - chmod 400 "$config" - chown $app:$app "$config" - -#REMOVEME? ynh_secure_remove --file="$install_dir/$app/uploads" + if grep "Mobilizon.Web.Upload.Uploader.Local" "$MOBILIZON_CONFIG_PATH" >/dev/null; then + ynh_replace_string --target_file="$MOBILIZON_CONFIG_PATH" \ + --match_string="uploads: \".*/uploads\"" \ + --replace_string="$data_dir/uploads" + else + ynh_add_config --template="uploads.exs" --destination="$install_dir/uploads.exs" + cat "$install_dir/uploads.exs" >> "$MOBILIZON_CONFIG_PATH" + ynh_secure_remove --file="$install_dir/uploads.exs" + fi fi -if ynh_version_gt "1.2.3~ynh1" "${previous_version}" ; then - ynh_script_progression --message="Upgrade to 1.2.3~ynh1..." - ynh_delete_file_checksum --file="$install_dir/$app/config/runtime.exs" - mv "$install_dir/$app/" "$install_dir/live/" - ynh_store_file_checksum --file="$install_dir/live/config/runtime.exs" -fi - -if ynh_version_gt "2.0.2~ynh1" "${previous_version}" ; then - mkdir -p /etc/$app - if [ -f "$install_dir/live/config/prod.secret.exs" ]; then - ynh_delete_file_checksum --file="$install_dir/live/config/prod.secret.exs" - mv -f "$install_dir/live/config/prod.secret.exs" "/etc/$app/config.exs" - fi - if [ -f "$install_dir/live/config/runtime.exs" ]; then - ynh_delete_file_checksum --file="$install_dir/live/config/runtime.exs" - mv -f "$install_dir/live/config/runtime.exs" "/etc/$app/config.exs" - fi - chown -R $app:$app /etc/$app - ynh_store_file_checksum --file="/etc/$app/config.exs" -fi - -#================================================= -# CREATE DEDICATED USER -#================================================= -#REMOVEME? ynh_script_progression --message="Making sure dedicated system user exists..." - -# Create a dedicated user (if not existing) -#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= +ynh_script_progression --message="Upgrading source files..." -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$install_dir/live" --full_replace=1 - # Remove the app directory securely -#REMOVEME? ynh_secure_remove --file="$install_dir/live" - - # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$install_dir/live" --source_id=$architecture -fi - -chmod 750 "$install_dir" chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" - -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." - -#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." - -# Create a dedicated NGINX config -ynh_add_nginx_config - -#================================================= -# SPECIFIC UPGRADE -#================================================= -# CREATE DATA_DIR FOLDER -#================================================= -ynh_script_progression --message="Create data_dir folder..." - -mkdir -p $data_dir -mkdir -p "$data_dir/uploads/" - -chmod 750 "$data_dir" -chmod -R o-rwx "$data_dir" -chown -R $app:$app "$data_dir" - -#================================================= -# MAKE SETUP -#================================================= -ynh_script_progression --message="Making setup..." - -pushd $install_dir/live - ynh_exec_as $app ./bin/mobilizon_ctl migrate -popd +chown -R "$app:www-data" "$install_dir" #================================================= # UPDATE A CONFIG FILE #================================================= ynh_script_progression --message="Updating a configuration file..." -config="/etc/$app/config.exs" - -ynh_backup_if_checksum_is_different --file="$config" -ynh_replace_string --match_string="adapter: Bamboo.SMTPAdapter," --replace_string="adapter: Swoosh.Adapters.SMTP," --target_file="$config" -ynh_replace_string --match_string="server: \"127.0.0.1\"," --replace_string="relay: \"127.0.0.1\"," --target_file="$config" -ynh_store_file_checksum --file="$config" +ynh_backup_if_checksum_is_different --file="$MOBILIZON_CONFIG_PATH" +ynh_replace_string --match_string="adapter: Bamboo.SMTPAdapter," --replace_string="adapter: Swoosh.Adapters.SMTP," --target_file="$MOBILIZON_CONFIG_PATH" +ynh_replace_string --match_string="server: \"127.0.0.1\"," --replace_string="relay: \"127.0.0.1\"," --target_file="$MOBILIZON_CONFIG_PATH" +ynh_store_file_checksum --file="$MOBILIZON_CONFIG_PATH" chmod 400 "$config" -chown $app:$app "$config" +chown "$app:$app" "$config" #================================================= -# SETUP SYSTEMD +# MAKE SETUP #================================================= -ynh_script_progression --message="Upgrading systemd configuration..." +ynh_script_progression --message="Migrating app..." + +ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" ./bin/mobilizon_ctl migrate + +#================================================= +# REAPPLY SYSTEM CONFIGURATIONS +#================================================= +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 + +# Create a dedicated NGINX config +ynh_add_nginx_config # Create a dedicated systemd config ynh_add_systemd_config - -#================================================= -# GENERIC FINALIZATION -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add $app --description="$app daemon for Mobilizon" +yunohost service add "$app" --description="$app daemon for Mobilizon" #================================================= # START SYSTEMD SERVICE #================================================= ynh_script_progression --message="Starting a systemd service..." -ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" - -#================================================= -# RELOAD NGINX -#================================================= -#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." - -#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name="$app" --action="start" --log_path=systemd --line_match="Access Mobilizon.Web.Endpoint at" #================================================= # END OF SCRIPT diff --git a/scripts/ynh_package_version b/scripts/ynh_package_version deleted file mode 100644 index 678eb61..0000000 --- a/scripts/ynh_package_version +++ /dev/null @@ -1,26 +0,0 @@ -#!/bin/bash - -read_json () { - sudo python3 -c "import sys, json;print(json.load(open('$1'))['$2'])" -} - -read_manifest () { - if [ -f '../manifest.json' ] ; then - read_json '../manifest.json' "$1" - else - read_json '../settings/manifest.json' "$1" - fi -} -abort_if_up_to_date () { - version=$(read_json "/etc/yunohost/apps/$YNH_APP_INSTANCE_NAME/manifest.json" 'version' 2> /dev/null || echo '20160501-7') - last_version=$(read_manifest 'version') - if [ "${version}" = "${last_version}" ] && [ "$YNH_APP_UPGRADE_TYPE" != "UPGRADE_FORCED" ]; then - ynh_print_info "Up-to-date, nothing to do" - ynh_die "" 0 - fi -} - -ynh_version_gt () -{ - dpkg --compare-versions "$1" gt "$2" -} From 2627bd8b0e798128fa79fb2bd62f9d330cda1f3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 19:26:50 +0100 Subject: [PATCH 13/18] Fix backup --- scripts/backup | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/backup b/scripts/backup index 6a81403..366b1a3 100644 --- a/scripts/backup +++ b/scripts/backup @@ -39,7 +39,7 @@ ynh_backup --src_path="/etc/systemd/system/$app.service" # BACKUP VARIOUS FILES #================================================= -ynh_backup --src_path="/var/log/$app/" +# ynh_backup --src_path="/var/log/$app/" #================================================= # BACKUP THE POSTGRESQL DATABASE From be46683dce1f48ad0976d460745bb3a4a0eaa6f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 19:27:19 +0100 Subject: [PATCH 14/18] fix change_url --- scripts/change_url | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/change_url b/scripts/change_url index 3f71b7c..044ddaa 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -40,8 +40,8 @@ ynh_backup_if_checksum_is_different --file="$install_dir/config.exs" ynh_replace_string --match_string="$old_domain" --replace_string="$new_domain" --target_file="$install_dir/config.exs" ynh_store_file_checksum --file="$install_dir/config.exs" -chmod 400 "$config" -chown "$app:$app" "$config" +chmod 400 "$install_dir/config.exs" +chown "$app:$app" "$install_dir/config.exs" #================================================= # GENERIC FINALISATION From 9c0bb0104d456be2fde7c2f70d20d5795a36a07a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 20:25:46 +0100 Subject: [PATCH 15/18] try to fix restore --- scripts/restore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/restore b/scripts/restore index 719d8f9..3e63efc 100644 --- a/scripts/restore +++ b/scripts/restore @@ -49,7 +49,7 @@ ynh_psql_execute_as_root --database="$db_name" --sql="CREATE EXTENSION IF NOT EX ynh_psql_execute_as_root --database="$db_name" --sql="CREATE EXTENSION IF NOT EXISTS unaccent;" ynh_psql_execute_as_root --database="$db_name" --sql="ALTER USER $db_user WITH NOSUPERUSER;" -ynh_mysql_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" < ./db.sql +ynh_psql_execute_file_as_root --database="$db_name" --file="./db.sql" #================================================= # RESTORE SYSTEM CONFIGURATIONS From 438ba686cfd725cb0b893cddb928900c21c5d324 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 20:27:23 +0100 Subject: [PATCH 16/18] fix upgrade --- scripts/upgrade | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/upgrade b/scripts/upgrade index c58982a..da12de8 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -52,7 +52,7 @@ fi # Migrate data to data_dir # FIXME: could be old, might be nice to remove -if [ -n "$(ls -A "$install_dir/$app/uploads/")" ]; then +if [ -e "$install_dir/$app/uploads/" ] && [ -n "$(ls -A "$install_dir/$app/uploads/")" ]; then ynh_script_progression --message="Moving data directory..." rsync -a "$install_dir/$app/uploads/" "$data_dir/uploads/" ynh_secure_remove "$install_dir/$app/uploads" @@ -89,8 +89,8 @@ ynh_replace_string --match_string="adapter: Bamboo.SMTPAdapter," --replace_strin ynh_replace_string --match_string="server: \"127.0.0.1\"," --replace_string="relay: \"127.0.0.1\"," --target_file="$MOBILIZON_CONFIG_PATH" ynh_store_file_checksum --file="$MOBILIZON_CONFIG_PATH" -chmod 400 "$config" -chown "$app:$app" "$config" +chmod 400 "$MOBILIZON_CONFIG_PATH" +chown "$app:$app" "$MOBILIZON_CONFIG_PATH" #================================================= # MAKE SETUP From 1f3a3096146b51010ece9e2adaed499bef64679c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 20:54:47 +0100 Subject: [PATCH 17/18] Fix upgrade --- scripts/upgrade | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/upgrade b/scripts/upgrade index da12de8..67f340a 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -97,7 +97,7 @@ chown "$app:$app" "$MOBILIZON_CONFIG_PATH" #================================================= ynh_script_progression --message="Migrating app..." -ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" ./bin/mobilizon_ctl migrate +ynh_exec_as "$app" MOBILIZON_CONFIG_PATH="$MOBILIZON_CONFIG_PATH" "$install_dir/live/bin/mobilizon_ctl" migrate #================================================= # REAPPLY SYSTEM CONFIGURATIONS From 9409bea149327860f413408d7b819498bdbaeebb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 6 Feb 2024 21:41:09 +0100 Subject: [PATCH 18/18] fix manifest --- manifest.toml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/manifest.toml b/manifest.toml index 0dc3a75..80da9db 100644 --- a/manifest.toml +++ b/manifest.toml @@ -23,11 +23,11 @@ fund = "https://soutenir.framasoft.org/" yunohost = ">= 11.2" architectures = ["amd64", "arm64"] 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, ... +ldap = true +sso = true +disk = "200M" +ram.build = "700M" +ram.runtime = "400M" [install] [install.domain]