committed by
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 514 additions and 1 deletions
-
1README.md
-
15conf/extra_php-fpm.conf
-
3conf/nginx.conf
-
26config_panel.toml
-
228scripts/_common.sh
-
128scripts/_ynh_add_fpm_config
-
97scripts/config
-
1scripts/install
-
16scripts/upgrade
@ -0,0 +1,15 @@ |
|||
|
|||
; Additional php.ini defines, specific to this pool of workers. |
|||
php_value[upload_max_filesize] = 10G |
|||
php_value[post_max_size] = 10G |
|||
php_value[default_charset] = UTF-8 |
|||
; OPcache is already activated by default |
|||
; php_value[opcache.enable]=1 |
|||
; The following parameters are nevertheless recommended for Nextcloud |
|||
; see here: https://docs.nextcloud.com/server/15/admin_manual/installation/server_tuning.html#enable-php-opcache |
|||
php_value[opcache.enable_cli]=1 |
|||
php_value[opcache.interned_strings_buffer]=8 |
|||
php_value[opcache.max_accelerated_files]=10000 |
|||
php_value[opcache.memory_consumption]=128 |
|||
php_value[opcache.save_comments]=1 |
|||
php_value[opcache.revalidate_freq]=1 |
|||
@ -0,0 +1,26 @@ |
|||
version = "0.1" |
|||
name = "Nextcloud configuration panel" |
|||
|
|||
[main] |
|||
name = "Nextcloud configuration" |
|||
|
|||
[main.php_fpm_config] |
|||
name = "PHP-FPM configuration" |
|||
|
|||
[main.php_fpm_config.footprint] |
|||
ask = "Memory footprint of the service ?" |
|||
choices = ["low", "medium", "high", "specific"] |
|||
default = "low" |
|||
help = "low <= 20Mb per pool. medium between 20Mb and 40Mb per pool. high > 40Mb per pool.<br>Use specific to set a value with the following option." |
|||
|
|||
[main.php_fpm_config.free_footprint] |
|||
ask = "Memory footprint of the service ?" |
|||
type = "number" |
|||
default = "0" |
|||
help = "Free field to specify exactly the footprint in Mb if you don't want to use one of the three previous values." |
|||
|
|||
[main.php_fpm_config.usage] |
|||
ask = "Expected usage of the service ?" |
|||
choices = ["low", "medium", "high"] |
|||
default = "low" |
|||
help = "low: Personal usage, behind the sso. No RAM footprint when not used, but the impact on the processor can be high if many users are using the service.<br>medium: Low usage, few people or/and publicly accessible. Low RAM footprint, medium processor footprint when used.<br>high: High usage, frequently visited website. High RAM footprint, but lower on processor usage and quickly responding." |
|||
@ -0,0 +1,128 @@ |
|||
#!/bin/bash |
|||
|
|||
# Create a dedicated php-fpm config |
|||
# |
|||
# usage 1: ynh_add_fpm_config [--phpversion=7.X] [--use_template] |
|||
# | arg: -v, --phpversion - Version of php to use. |
|||
# | arg: -t, --use_template - Use this helper in template mode. |
|||
# |
|||
# ----------------------------------------------------------------------------- |
|||
# |
|||
# usage 2: ynh_add_fpm_config [--phpversion=7.X] --usage=usage --footprint=footprint |
|||
# | arg: -v, --phpversion - Version of php to use.# |
|||
# | arg: -f, --footprint - Memory footprint of the service (low/medium/high). |
|||
# low - Less than 20Mb of ram by pool. |
|||
# medium - Between 20Mb and 40Mb of ram by pool. |
|||
# high - More than 40Mb of ram by pool. |
|||
# Or specify exactly the footprint, the load of the service as Mb by pool instead of having a standard value. |
|||
# To have this value, use the following command and stress the service. |
|||
# watch -n0.5 ps -o user,cmd,%cpu,rss -u APP |
|||
# |
|||
# | arg: -u, --usage - Expected usage of the service (low/medium/high). |
|||
# low - Personal usage, behind the sso. |
|||
# medium - Low usage, few people or/and publicly accessible. |
|||
# high - High usage, frequently visited website. |
|||
# |
|||
# Requires YunoHost version 2.7.2 or higher. |
|||
ynh_add_fpm_config () { |
|||
# Declare an array to define the options of this helper. |
|||
local legacy_args=vtuf |
|||
declare -Ar args_array=( [v]=phpversion= [t]=use_template [u]=usage= [f]=footprint= ) |
|||
local phpversion |
|||
local use_template |
|||
local usage |
|||
local footprint |
|||
# Manage arguments with getopts |
|||
ynh_handle_getopts_args "$@" |
|||
# The default behaviour is to use the template. |
|||
use_template="${use_template:-1}" |
|||
usage="${usage:-}" |
|||
footprint="${footprint:-}" |
|||
if [ -n "$usage" ] || [ -n "$footprint" ]; then |
|||
use_template=0 |
|||
fi |
|||
|
|||
# Configure PHP-FPM 7.0 by default |
|||
phpversion="${phpversion:-7.0}" |
|||
|
|||
local fpm_config_dir="/etc/php/$phpversion/fpm" |
|||
local fpm_service="php${phpversion}-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=$app --key=fpm_config_dir --value="$fpm_config_dir" |
|||
ynh_app_setting_set --app=$app --key=fpm_service --value="$fpm_service" |
|||
finalphpconf="$fpm_config_dir/pool.d/$app.conf" |
|||
ynh_backup_if_checksum_is_different --file="$finalphpconf" |
|||
|
|||
if [ $use_template -eq 1 ] |
|||
then |
|||
# Usage 1, use the template in ../conf/php-fpm.conf |
|||
sudo cp ../conf/php-fpm.conf "$finalphpconf" |
|||
ynh_replace_string --match_string="__NAMETOCHANGE__" --replace_string="$app" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string="__FINALPATH__" --replace_string="$final_path" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string="__USER__" --replace_string="$app" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string="__PHPVERSION__" --replace_string="$phpversion" --target_file="$finalphpconf" |
|||
|
|||
else |
|||
# Usage 2, generate a php-fpm config file with ynh_get_scalable_phpfpm |
|||
ynh_get_scalable_phpfpm --usage=$usage --footprint=$footprint |
|||
|
|||
# Copy the default file |
|||
sudo cp "$fpm_config_dir/pool.d/www.conf" "$finalphpconf" |
|||
|
|||
# Replace standard variables into the default file |
|||
ynh_replace_string --match_string="^\[www\]" --replace_string="[$app]" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string=".*listen = .*" --replace_string="listen = /var/run/php/php7.0-fpm-$app.sock" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string="^user = .*" --replace_string="user = $app" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string="^group = .*" --replace_string="group = $app" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string=".*chdir = .*" --replace_string="chdir = $final_path" --target_file="$finalphpconf" |
|||
|
|||
# Configure fpm children |
|||
ynh_replace_string --match_string=".*pm = .*" --replace_string="pm = $php_pm" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string=".*pm.max_children = .*" --replace_string="pm.max_children = $php_max_children" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string=".*pm.max_requests = .*" --replace_string="pm.max_requests = 500" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string=".*request_terminate_timeout = .*" --replace_string="request_terminate_timeout = 1d" --target_file="$finalphpconf" |
|||
if [ "$php_pm" = "dynamic" ] |
|||
then |
|||
ynh_replace_string --match_string=".*pm.start_servers = .*" --replace_string="pm.start_servers = $php_start_servers" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string=".*pm.min_spare_servers = .*" --replace_string="pm.min_spare_servers = $php_min_spare_servers" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string=".*pm.max_spare_servers = .*" --replace_string="pm.max_spare_servers = $php_max_spare_servers" --target_file="$finalphpconf" |
|||
elif [ "$php_pm" = "ondemand" ] |
|||
then |
|||
ynh_replace_string --match_string=".*pm.process_idle_timeout = .*" --replace_string="pm.process_idle_timeout = 10s" --target_file="$finalphpconf" |
|||
fi |
|||
|
|||
# Comment unused parameters |
|||
if [ "$php_pm" != "dynamic" ] |
|||
then |
|||
ynh_replace_string --match_string=".*\(pm.start_servers = .*\)" --replace_string=";\1" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string=".*\(pm.min_spare_servers = .*\)" --replace_string=";\1" --target_file="$finalphpconf" |
|||
ynh_replace_string --match_string=".*\(pm.max_spare_servers = .*\)" --replace_string=";\1" --target_file="$finalphpconf" |
|||
fi |
|||
if [ "$php_pm" != "ondemand" ] |
|||
then |
|||
ynh_replace_string --match_string=".*\(pm.process_idle_timeout = .*\)" --replace_string=";\1" --target_file="$finalphpconf" |
|||
fi |
|||
|
|||
# Concatene the extra config. |
|||
if [ -e ../conf/extra_php-fpm.conf ]; then |
|||
cat ../conf/extra_php-fpm.conf >> "$finalphpconf" |
|||
fi |
|||
fi |
|||
sudo chown root: "$finalphpconf" |
|||
ynh_store_file_checksum --file="$finalphpconf" |
|||
|
|||
if [ -e "../conf/php-fpm.ini" ] |
|||
then |
|||
echo "Packagers ! Please do not use a separate php ini file, merge your directives in the pool file instead." >&2 |
|||
finalphpini="$fpm_config_dir/conf.d/20-$app.ini" |
|||
ynh_backup_if_checksum_is_different "$finalphpini" |
|||
sudo cp ../conf/php-fpm.ini "$finalphpini" |
|||
sudo chown root: "$finalphpini" |
|||
ynh_store_file_checksum "$finalphpini" |
|||
fi |
|||
ynh_systemd_action --service_name=$fpm_service --action=reload |
|||
} |
|||
@ -0,0 +1,97 @@ |
|||
#!/bin/bash |
|||
|
|||
#================================================= |
|||
# GENERIC STARTING |
|||
#================================================= |
|||
# IMPORT GENERIC HELPERS |
|||
#================================================= |
|||
|
|||
source _common.sh |
|||
source /usr/share/yunohost/helpers |
|||
source _ynh_add_fpm_config |
|||
|
|||
#================================================= |
|||
# RETRIEVE ARGUMENTS |
|||
#================================================= |
|||
|
|||
app=${YNH_APP_INSTANCE_NAME:-$YNH_APP_ID} |
|||
|
|||
#================================================= |
|||
# LOAD VALUES |
|||
#================================================= |
|||
|
|||
# Load the real value from the app config or elsewhere. |
|||
# Then get the value from the form. |
|||
# If the form has a value for a variable, take the value from the form, |
|||
# Otherwise, keep the value from the app config. |
|||
|
|||
# Footprint for php-fpm |
|||
old_fpm_footprint="$(ynh_app_setting_get --app=$app --key=fpm_footprint)" |
|||
fpm_footprint="${YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FOOTPRINT:-$old_fpm_footprint}" |
|||
|
|||
# Free footprint value for php-fpm |
|||
# Check if fpm_footprint is an integer |
|||
if [ "$fpm_footprint" -eq "$fpm_footprint" ] 2> /dev/null |
|||
then |
|||
# If fpm_footprint is an integer, that's a numeric value for the footprint |
|||
old_free_footprint=$fpm_footprint |
|||
fpm_footprint=specific |
|||
else |
|||
old_free_footprint=0 |
|||
fi |
|||
free_footprint="${YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FREE_FOOTPRINT:-$old_free_footprint}" |
|||
|
|||
# Usage for php-fpm |
|||
old_fpm_usage="$(ynh_app_setting_get --app=$app --key=fpm_usage)" |
|||
fpm_usage="${YNH_CONFIG_MAIN_PHP_FPM_CONFIG_USAGE:-$old_fpm_usage}" |
|||
|
|||
#================================================= |
|||
# SHOW_CONFIG FUNCTION FOR 'SHOW' COMMAND |
|||
#================================================= |
|||
|
|||
show_config() { |
|||
# here you are supposed to read some config file/database/other then print the values |
|||
# ynh_return "YNH_CONFIG_${PANEL_ID}_${SECTION_ID}_${OPTION_ID}=value" |
|||
|
|||
ynh_return "YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FOOTPRINT=$fpm_footprint" |
|||
ynh_return "YNH_CONFIG_MAIN_PHP_FPM_CONFIG_FREE_FOOTPRINT=$free_footprint" |
|||
ynh_return "YNH_CONFIG_MAIN_PHP_FPM_CONFIG_USAGE=$fpm_usage" |
|||
} |
|||
|
|||
#================================================= |
|||
# MODIFY THE CONFIGURATION |
|||
#================================================= |
|||
|
|||
apply_config() { |
|||
|
|||
#================================================= |
|||
# RECONFIGURE PHP-FPM |
|||
#================================================= |
|||
|
|||
if [ "$fpm_usage" != "$old_fpm_usage" ] || [ "$fpm_footprint" != "$old_fpm_footprint" ] || [ "$free_footprint" != "$old_free_footprint" ] |
|||
then |
|||
# If fpm_footprint is set to 'specific', use $free_footprint value. |
|||
if [ "$fpm_footprint" = "specific" ] |
|||
then |
|||
fpm_footprint=$free_footprint |
|||
fi |
|||
|
|||
if [ "$fpm_footprint" != "0" ] |
|||
then |
|||
ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint |
|||
else |
|||
ynh_print_err --message="When selecting 'specific', you have to set a footprint value into the field below." |
|||
fi |
|||
fi |
|||
} |
|||
|
|||
#================================================= |
|||
# GENERIC FINALIZATION |
|||
#================================================= |
|||
# SELECT THE ACTION FOLLOWING THE GIVEN ARGUMENT |
|||
#================================================= |
|||
|
|||
case $1 in |
|||
show) show_config;; |
|||
apply) apply_config;; |
|||
esac |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue