diff --git a/manifest.toml b/manifest.toml index 11ccd62..c1fe782 100644 --- a/manifest.toml +++ b/manifest.toml @@ -17,7 +17,8 @@ website = "https://magicstone.dev" code = "https://github.com/magicstone-dev/acropolis" [integration] -yunohost = ">=11.2.12" +yunohost = ">=11.2.30" +helpers_version = "2.1" architectures = "all" multi_instance = false diff --git a/scripts/_common.sh b/scripts/_common.sh index 5f5307a..6d2613d 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -12,106 +12,6 @@ MEMORY_NEEDED="2560" # PERSONAL HELPERS #================================================= -# Returns true if a swap partition is enabled, false otherwise -# usage: is_swap_present -is_swap_present() { - [ $(awk '/^SwapTotal:/{print $2}' /proc/meminfo) -gt 0 ] -} - -# Returns true if swappiness higher than 50 -# usage: is_swappiness_sufficient -is_swappiness_sufficient() { - [ $(cat /proc/sys/vm/swappiness) -gt 50 ] -} - -# Returns true if specified free memory is available (RAM + swap) -# usage: is_memory_available MEMORY (in bytes) -is_memory_available() { - local needed_memory=$1 - local freemem="$(awk '/^MemAvailable:/{print $2}' /proc/meminfo)" - local freeswap="$(awk '/^SwapFree:/{print $2}' /proc/meminfo)" - [ $(($freemem+$freeswap)) -gt $needed_memory ] -} - -# Checks discourse install memory requirements -# terminates installation if requirements not met -check_memory_requirements() { - if ! is_swap_present ; then - ynh_die --message="You must have a swap partition in order to install and use this application" - elif ! is_swappiness_sufficient ; then - ynh_die --message="Your swappiness must be higher than 50; please see https://en.wikipedia.org/wiki/Swappiness" - elif ! is_memory_available 1000000 ; then - ynh_die --message="You must have a minimum of 1Gb available memory (RAM+swap) for the installation" - fi -} -# Checks discourse upgrade memory requirements -# Less requirements as the software is already installed and running -# terminates upgrade if requirements not met -check_memory_requirements_upgrade() { - if ! is_memory_available 400000 ; then - ynh_die --message="You must have a minimum of 400Mb available memory (RAM+swap) for the upgrade" - fi -} - -ynh_maintenance_mode_ON () { - # Create an html to serve as maintenance notice - echo " - -
- -This app has been put under maintenance by your administrator at $(date)
-Please wait until the maintenance operation is done. This page will be reloaded as soon as your app will be back.
- -" > "/var/www/html/maintenance.$app.html" - - # Create a new nginx config file to redirect all access to the app to the maintenance notice instead. - echo "# All request to the app will be redirected to ${path}_maintenance and fall on the maintenance notice -rewrite ^${path}/(.*)$ ${path}_maintenance/? redirect; -# Use another location, to not be in conflict with the original config file -location ${path}_maintenance/ { -alias /var/www/html/ ; -try_files maintenance.$app.html =503; -# Include SSOWAT user panel. -include conf.d/yunohost_panel.conf.inc; -}" > "/etc/nginx/conf.d/$domain.d/maintenance.$app.conf" - - # The current config file will redirect all requests to the root of the app. - # To keep the full path, we can use the following rewrite rule: - # rewrite ^${path}/(.*)$ ${path}_maintenance/\$1? redirect; - # The difference will be in the $1 at the end, which keep the following queries. - # But, if it works perfectly for a html request, there's an issue with any php files. - # This files are treated as simple files, and will be downloaded by the browser. - # Would be really be nice to be able to fix that issue. So that, when the page is reloaded after the maintenance, the user will be redirected to the real page he was. - - systemctl reload nginx -} - -ynh_maintenance_mode_OFF () { - - # Rewrite the nginx config file to redirect from ${path}_maintenance to the real url of the app. - echo "rewrite ^${path}_maintenance/(.*)$ ${path}/\$1 redirect;" > "/etc/nginx/conf.d/$domain.d/maintenance.$app.conf" - systemctl reload nginx - - # Sleep 4 seconds to let the browser reload the pages and redirect the user to the app. - sleep 4 - - # Then remove the temporary files used for the maintenance. - rm "/var/www/html/maintenance.$app.html" - rm "/etc/nginx/conf.d/$domain.d/maintenance.$app.conf" - - systemctl reload nginx -} - #================================================= # EXPERIMENTAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index 7a474c5..249bf60 100644 --- a/scripts/backup +++ b/scripts/backup @@ -6,7 +6,6 @@ # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh -source ../settings/scripts/ynh_add_swap source /usr/share/yunohost/helpers #================================================= diff --git a/scripts/install b/scripts/install index 289b379..bd1467f 100644 --- a/scripts/install +++ b/scripts/install @@ -5,7 +5,6 @@ #================================================= source _common.sh -source ynh_add_swap source /usr/share/yunohost/helpers #================================================= diff --git a/scripts/remove b/scripts/remove index e31f498..e21710f 100644 --- a/scripts/remove +++ b/scripts/remove @@ -5,7 +5,6 @@ #================================================= source _common.sh -source ynh_add_swap source /usr/share/yunohost/helpers #================================================= diff --git a/scripts/restore b/scripts/restore index 0aab10f..db7f98b 100644 --- a/scripts/restore +++ b/scripts/restore @@ -6,7 +6,6 @@ # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh -source ../settings/scripts/ynh_add_swap source /usr/share/yunohost/helpers #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 8dbb61f..c5556f4 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -5,7 +5,6 @@ #================================================= source _common.sh -source ynh_add_swap source /usr/share/yunohost/helpers #================================================= diff --git a/scripts/ynh_add_swap b/scripts/ynh_add_swap deleted file mode 100644 index d7ec44b..0000000 --- a/scripts/ynh_add_swap +++ /dev/null @@ -1,93 +0,0 @@ -#!/bin/bash - -# Add swap -# -# usage: ynh_add_swap --size=SWAP in Mb -# | arg: -s, --size= - Amount of SWAP to add in Mb. -ynh_add_swap () { - # Declare an array to define the options of this helper. - declare -Ar args_array=( [s]=size= ) - local size - # Manage arguments with getopts - ynh_handle_getopts_args "$@" - - local swap_max_size=$(( $size * 1024 )) - - local free_space=$(df --output=avail / | sed 1d) - # Because we don't want to fill the disk with a swap file, divide by 2 the available space. - local usable_space=$(( $free_space / 2 )) - - SD_CARD_CAN_SWAP=${SD_CARD_CAN_SWAP:-0} - - # Swap on SD card only if it's is specified - if ynh_is_main_device_a_sd_card && [ "$SD_CARD_CAN_SWAP" == "0" ] - then - ynh_print_warn --message="The main mountpoint of your system '/' is on an SD card, swap will not be added to prevent some damage of this one, but that can cause troubles for the app $app. If you still want activate the swap, you can relaunch the command preceded by 'SD_CARD_CAN_SWAP=1'" - return - fi - - # Compare the available space with the size of the swap. - # And set a acceptable size from the request - if [ $usable_space -ge $swap_max_size ] - then - local swap_size=$swap_max_size - elif [ $usable_space -ge $(( $swap_max_size / 2 )) ] - then - local swap_size=$(( $swap_max_size / 2 )) - elif [ $usable_space -ge $(( $swap_max_size / 3 )) ] - then - local swap_size=$(( $swap_max_size / 3 )) - elif [ $usable_space -ge $(( $swap_max_size / 4 )) ] - then - local swap_size=$(( $swap_max_size / 4 )) - else - echo "Not enough space left for a swap file" >&2 - local swap_size=0 - fi - - # If there's enough space for a swap, and no existing swap here - if [ $swap_size -ne 0 ] && [ ! -e /swap_$app ] - then - # Preallocate space for the swap file, fallocate may sometime not be used, use dd instead in this case - if ! fallocate -l ${swap_size}K /swap_$app - then - dd if=/dev/zero of=/swap_$app bs=1024 count=${swap_size} - fi - chmod 0600 /swap_$app - # Create the swap - mkswap /swap_$app - # And activate it - swapon /swap_$app - # Then add an entry in fstab to load this swap at each boot. - echo -e "/swap_$app swap swap defaults 0 0 #Swap added by $app" >> /etc/fstab - fi -} - -ynh_del_swap () { - # If there a swap at this place - if [ -e /swap_$app ] - then - # Clean the fstab - sed -i "/#Swap added by $app/d" /etc/fstab - # Desactive the swap file - swapoff /swap_$app - # And remove it - rm /swap_$app - fi -} - -# Check if the device of the main mountpoint "/" is an SD card -# -# [internal] -# -# return 0 if it's an SD card, else 1 -ynh_is_main_device_a_sd_card () { - local main_device=$(lsblk --output PKNAME --noheadings $(findmnt / --nofsroot --uniq --output source --noheadings --first-only)) - - if echo $main_device | grep --quiet "mmc" && [ $(tail -n1 /sys/block/$main_device/queue/rotational) == "0" ] - then - return 0 - else - return 1 - fi -}