mirror of
https://github.com/YunoHost/yunohost.git
synced 2024-09-03 20:06:10 +02:00
41c1a9ce13
Have a look to https://github.com/YunoHost-Apps/nextcloud_ynh/issues/138 for more information.
244 lines
8.2 KiB
Text
244 lines
8.2 KiB
Text
# Use logrotate to manage the logfile
|
|
#
|
|
# usage: ynh_use_logrotate [logfile] [--non-append|--append] [specific_user/specific_group]
|
|
# | arg: logfile - absolute path of logfile
|
|
# | arg: --non-append - (Option) Replace the config file instead of appending this new config.
|
|
# | arg: specific_user : run logrotate as the specified user and group. If not specified logrotate is runned as root.
|
|
#
|
|
# If no argument provided, a standard directory will be use. /var/log/${app}
|
|
# You can provide a path with the directory only or with the logfile.
|
|
# /parentdir/logdir
|
|
# /parentdir/logdir/logfile.log
|
|
#
|
|
# It's possible to use this helper several times, each config will be added to the same logrotate config file.
|
|
# Unless you use the option --non-append
|
|
ynh_use_logrotate () {
|
|
local customtee="tee -a"
|
|
local user_group="${3:-}"
|
|
if [ $# -gt 0 ] && [ "$1" == "--non-append" ]; then
|
|
customtee="tee"
|
|
# Destroy this argument for the next command.
|
|
shift
|
|
elif [ $# -gt 1 ] && [ "$2" == "--non-append" ]; then
|
|
customtee="tee"
|
|
fi
|
|
if [ $# -gt 0 ]; then
|
|
if [ "$(echo ${1##*.})" == "log" ]; then # Keep only the extension to check if it's a logfile
|
|
local logfile=$1 # In this case, focus logrotate on the logfile
|
|
else
|
|
local logfile=$1/*.log # Else, uses the directory and all logfile into it.
|
|
fi
|
|
else
|
|
local logfile="/var/log/${app}/*.log" # Without argument, use a defaut directory in /var/log
|
|
fi
|
|
local su_directive=""
|
|
if [[ -n $user_group ]]; then
|
|
su_directive=" # Run logorotate as specific user - group
|
|
su ${user_group%/*} ${user_group#*/}"
|
|
fi
|
|
|
|
cat > ./${app}-logrotate << EOF # Build a config file for logrotate
|
|
$logfile {
|
|
# Rotate if the logfile exceeds 100Mo
|
|
size 100M
|
|
# Keep 12 old log maximum
|
|
rotate 12
|
|
# Compress the logs with gzip
|
|
compress
|
|
# Compress the log at the next cycle. So keep always 2 non compressed logs
|
|
delaycompress
|
|
# Copy and truncate the log to allow to continue write on it. Instead of move the log.
|
|
copytruncate
|
|
# Do not do an error if the log is missing
|
|
missingok
|
|
# Not rotate if the log is empty
|
|
notifempty
|
|
# Keep old logs in the same dir
|
|
noolddir
|
|
$su_directive
|
|
}
|
|
EOF
|
|
sudo mkdir -p $(dirname "$logfile") # Create the log directory, if not exist
|
|
cat ${app}-logrotate | sudo $customtee /etc/logrotate.d/$app > /dev/null # Append this config to the existing config file, or replace the whole config file (depending on $customtee)
|
|
}
|
|
|
|
# Remove the app's logrotate config.
|
|
#
|
|
# usage: ynh_remove_logrotate
|
|
ynh_remove_logrotate () {
|
|
if [ -e "/etc/logrotate.d/$app" ]; then
|
|
sudo rm "/etc/logrotate.d/$app"
|
|
fi
|
|
}
|
|
|
|
# Create a dedicated systemd config
|
|
#
|
|
# usage: ynh_add_systemd_config [service] [template]
|
|
# | arg: service - Service name (optionnal, $app by default)
|
|
# | arg: template - Name of template file (optionnal, this is 'systemd' by default, meaning ./conf/systemd.service will be used as template)
|
|
#
|
|
# This will use the template ../conf/<templatename>.service
|
|
# to generate a systemd config, by replacing the following keywords
|
|
# with global variables that should be defined before calling
|
|
# this helper :
|
|
#
|
|
# __APP__ by $app
|
|
# __FINALPATH__ by $final_path
|
|
#
|
|
ynh_add_systemd_config () {
|
|
local service_name="${1:-$app}"
|
|
|
|
finalsystemdconf="/etc/systemd/system/$service_name.service"
|
|
ynh_backup_if_checksum_is_different "$finalsystemdconf"
|
|
sudo cp ../conf/${2:-systemd.service} "$finalsystemdconf"
|
|
|
|
# To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
|
|
# Substitute in a nginx config file only if the variable is not empty
|
|
if test -n "${final_path:-}"; then
|
|
ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf"
|
|
fi
|
|
if test -n "${app:-}"; then
|
|
ynh_replace_string "__APP__" "$app" "$finalsystemdconf"
|
|
fi
|
|
ynh_store_file_checksum "$finalsystemdconf"
|
|
|
|
sudo chown root: "$finalsystemdconf"
|
|
sudo systemctl enable $service_name
|
|
sudo systemctl daemon-reload
|
|
}
|
|
|
|
# Remove the dedicated systemd config
|
|
#
|
|
# usage: ynh_remove_systemd_config [service]
|
|
# | arg: service - Service name (optionnal, $app by default)
|
|
#
|
|
ynh_remove_systemd_config () {
|
|
local service_name="${1:-$app}"
|
|
|
|
local finalsystemdconf="/etc/systemd/system/$service_name.service"
|
|
if [ -e "$finalsystemdconf" ]; then
|
|
sudo systemctl stop $service_name
|
|
sudo systemctl disable $service_name
|
|
ynh_secure_remove "$finalsystemdconf"
|
|
sudo systemctl daemon-reload
|
|
fi
|
|
}
|
|
|
|
# Create a dedicated nginx config
|
|
#
|
|
# usage: ynh_add_nginx_config "list of others variables to replace"
|
|
#
|
|
# | arg: list of others variables to replace separeted by a space
|
|
# | for example : 'path_2 port_2 ...'
|
|
#
|
|
# This will use a template in ../conf/nginx.conf
|
|
# __PATH__ by $path_url
|
|
# __DOMAIN__ by $domain
|
|
# __PORT__ by $port
|
|
# __NAME__ by $app
|
|
# __FINALPATH__ by $final_path
|
|
#
|
|
# And dynamic variables (from the last example) :
|
|
# __PATH_2__ by $path_2
|
|
# __PORT_2__ by $port_2
|
|
#
|
|
ynh_add_nginx_config () {
|
|
finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf"
|
|
local others_var=${1:-}
|
|
ynh_backup_if_checksum_is_different "$finalnginxconf"
|
|
sudo cp ../conf/nginx.conf "$finalnginxconf"
|
|
|
|
# To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
|
|
# Substitute in a nginx config file only if the variable is not empty
|
|
if test -n "${path_url:-}"; then
|
|
# path_url_slash_less is path_url, or a blank value if path_url is only '/'
|
|
local path_url_slash_less=${path_url%/}
|
|
ynh_replace_string "__PATH__/" "$path_url_slash_less/" "$finalnginxconf"
|
|
ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf"
|
|
fi
|
|
if test -n "${domain:-}"; then
|
|
ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf"
|
|
fi
|
|
if test -n "${port:-}"; then
|
|
ynh_replace_string "__PORT__" "$port" "$finalnginxconf"
|
|
fi
|
|
if test -n "${app:-}"; then
|
|
ynh_replace_string "__NAME__" "$app" "$finalnginxconf"
|
|
fi
|
|
if test -n "${final_path:-}"; then
|
|
ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf"
|
|
fi
|
|
|
|
# Replace all other variable given as arguments
|
|
for var_to_replace in $others_var
|
|
do
|
|
# ${var_to_replace^^} make the content of the variable on upper-cases
|
|
# ${!var_to_replace} get the content of the variable named $var_to_replace
|
|
ynh_replace_string "__${var_to_replace^^}__" "${!var_to_replace}" "$finalnginxconf"
|
|
done
|
|
|
|
if [ "${path_url:-}" != "/" ]
|
|
then
|
|
ynh_replace_string "^#sub_path_only" "" "$finalnginxconf"
|
|
else
|
|
ynh_replace_string "^#root_path_only" "" "$finalnginxconf"
|
|
fi
|
|
|
|
ynh_store_file_checksum "$finalnginxconf"
|
|
|
|
sudo systemctl reload nginx
|
|
}
|
|
|
|
# Remove the dedicated nginx config
|
|
#
|
|
# usage: ynh_remove_nginx_config
|
|
ynh_remove_nginx_config () {
|
|
ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf"
|
|
sudo systemctl reload nginx
|
|
}
|
|
|
|
# Create a dedicated php-fpm config
|
|
#
|
|
# usage: ynh_add_fpm_config
|
|
ynh_add_fpm_config () {
|
|
# Configure PHP-FPM 7.0 by default
|
|
local fpm_config_dir="/etc/php/7.0/fpm"
|
|
local fpm_service="php7.0-fpm"
|
|
# Configure PHP-FPM 5 on Debian Jessie
|
|
if [ "$(ynh_get_debian_release)" == "jessie" ]; then
|
|
fpm_config_dir="/etc/php5/fpm"
|
|
fpm_service="php5-fpm"
|
|
fi
|
|
ynh_app_setting_set $app fpm_config_dir "$fpm_config_dir"
|
|
ynh_app_setting_set $app fpm_service "$fpm_service"
|
|
finalphpconf="$fpm_config_dir/pool.d/$app.conf"
|
|
ynh_backup_if_checksum_is_different "$finalphpconf"
|
|
sudo cp ../conf/php-fpm.conf "$finalphpconf"
|
|
ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf"
|
|
ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf"
|
|
ynh_replace_string "__USER__" "$app" "$finalphpconf"
|
|
sudo chown root: "$finalphpconf"
|
|
ynh_store_file_checksum "$finalphpconf"
|
|
|
|
if [ -e "../conf/php-fpm.ini" ]
|
|
then
|
|
echo "Please do not use a separate ini file, merge you directives in the pool file instead." &>2
|
|
fi
|
|
sudo systemctl reload $fpm_service
|
|
}
|
|
|
|
# Remove the dedicated php-fpm config
|
|
#
|
|
# usage: ynh_remove_fpm_config
|
|
ynh_remove_fpm_config () {
|
|
local fpm_config_dir=$(ynh_app_setting_get $app fpm_config_dir)
|
|
local fpm_service=$(ynh_app_setting_get $app fpm_service)
|
|
# Assume php version 7 if not set
|
|
if [ -z "$fpm_config_dir" ]; then
|
|
fpm_config_dir="/etc/php/7.0/fpm"
|
|
fpm_service="php7.0-fpm"
|
|
fi
|
|
ynh_secure_remove "$fpm_config_dir/pool.d/$app.conf"
|
|
ynh_secure_remove "$fpm_config_dir/conf.d/20-$app.ini" 2>&1
|
|
sudo systemctl reload $fpm_service
|
|
}
|