2018-04-02 16:36:02 +02:00
#!/bin/bash
2020-04-27 13:41:00 +02:00
#=================================================
# COMMON VARIABLES
#=================================================
2024-01-12 20:10:31 +01:00
ruby_version = "3.0.0"
2022-07-27 04:15:08 +02:00
2024-05-25 23:11:49 +02:00
nodejs_version = "18"
2018-04-02 16:36:02 +02:00
2024-01-26 22:16:29 +01:00
libjemalloc = " $( ldconfig -p | grep libjemalloc | awk 'END {print $NF}' ) "
2020-04-27 13:41:00 +02:00
#=================================================
# PERSONAL HELPERS
#=================================================
2018-04-30 18:53:20 +02:00
# 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 ]
}
2023-09-25 14:51:10 +02:00
# Returns true if swappiness higher than 10
2018-04-30 18:53:20 +02:00
# usage: is_swappiness_sufficient
is_swappiness_sufficient( ) {
2023-09-25 14:51:10 +02:00
[ $( cat /proc/sys/vm/swappiness) -gt 10 ]
2018-04-30 18:53:20 +02:00
}
# 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
2023-09-25 15:36:40 +02:00
ynh_print_warn --message= "You must have a swap partition in order to install and use this application"
2018-04-30 18:53:20 +02:00
elif ! is_swappiness_sufficient ; then
2023-09-25 15:36:40 +02:00
ynh_print_warn --message= "Your swappiness must be higher than 10; please see https://en.wikipedia.org/wiki/Swappiness"
2018-04-30 18:53:20 +02:00
elif ! is_memory_available 1000000 ; then
2023-09-25 15:36:40 +02:00
ynh_print_warn --message= "You must have a minimum of 1Gb available memory (RAM+swap) for the installation"
2018-04-30 18:53:20 +02:00
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
2020-04-27 13:41:00 +02:00
ynh_die --message= "You must have a minimum of 400Mb available memory (RAM+swap) for the upgrade"
2018-04-30 18:53:20 +02:00
fi
}
2018-04-02 16:36:02 +02:00
2024-03-19 21:33:15 +01:00
ynh_maintenance_mode_ON ( ) {
# Create an html to serve as maintenance notice
echo " <!DOCTYPE html>
<html>
<head>
<meta http-equiv= "refresh" content = "3" >
<title>Your app $app is currently under maintenance!</title>
<style>
body {
width: 70em;
margin: 0 auto;
}
</style>
</head>
<body>
<h1>Your app $app is currently under maintenance!</h1>
<p>This app has been put under maintenance by your administrator at $( date) </p>
<p>Please wait until the maintenance operation is done . This page will be reloaded as soon as your app will be back.</p>
</body>
</html>" > " /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
}
2018-04-02 16:36:02 +02:00
2020-04-27 13:41:00 +02:00
#=================================================
# EXPERIMENTAL HELPERS
#=================================================
2018-04-02 16:36:02 +02:00
2020-04-27 13:41:00 +02:00
#=================================================
# FUTURE OFFICIAL HELPERS
#=================================================
