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"