From 5e98382e309e8dbee533b17d3a1c154b12b753ea Mon Sep 17 00:00:00 2001 From: Jerry Vonau Date: Mon, 9 Aug 2021 14:09:45 -0500 Subject: [PATCH 01/13] fpm file for asterisk --- roles/pbx/templates/asterisk.conf | 445 ++++++++++++++++++++++ roles/pbx/templates/freepbx-nginx.conf.j2 | 2 +- 2 files changed, 446 insertions(+), 1 deletion(-) create mode 100644 roles/pbx/templates/asterisk.conf diff --git a/roles/pbx/templates/asterisk.conf b/roles/pbx/templates/asterisk.conf new file mode 100644 index 000000000..af00d97ad --- /dev/null +++ b/roles/pbx/templates/asterisk.conf @@ -0,0 +1,445 @@ +; Start a new pool named 'www'. +; the variable $pool can be used in any directive and will be replaced by the +; pool name ('www' here) +[asterisk] + +; Per pool prefix +; It only applies on the following directives: +; - 'access.log' +; - 'slowlog' +; - 'listen' (unixsocket) +; - 'chroot' +; - 'chdir' +; - 'php_values' +; - 'php_admin_values' +; When not set, the global prefix (or /usr) applies instead. +; Note: This directive can also be relative to the global prefix. +; Default Value: none +;prefix = /path/to/pools/$pool + +; Unix user/group of processes +; Note: The user is mandatory. If the group is not set, the default user's group +; will be used. +user = asterisk +group = www-data + +; The address on which to accept FastCGI requests. +; Valid syntaxes are: +; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on +; a specific port; +; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on +; a specific port; +; 'port' - to listen on a TCP socket to all addresses +; (IPv6 and IPv4-mapped) on a specific port; +; '/path/to/unix/socket' - to listen on a unix socket. +; Note: This value is mandatory. +listen = /run/php/php7.4-asterisk.sock + +; Set listen(2) backlog. +; Default Value: 511 (-1 on FreeBSD and OpenBSD) +;listen.backlog = 511 + +; Set permissions for unix socket, if one is used. In Linux, read/write +; permissions must be set in order to allow connections from a web server. Many +; BSD-derived systems allow connections regardless of permissions. The owner +; and group can be specified either by name or by their numeric IDs. +; Default Values: user and group are set as the running user +; mode is set to 0660 +listen.owner = asterisk +listen.group = www-data +;listen.mode = 0660 +; When POSIX Access Control Lists are supported you can set them using +; these options, value is a comma separated list of user/group names. +; When set, listen.owner and listen.group are ignored +;listen.acl_users = +;listen.acl_groups = + +; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect. +; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original +; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address +; must be separated by a comma. If this value is left blank, connections will be +; accepted from any ip address. +; Default Value: any +;listen.allowed_clients = 127.0.0.1 + +; Specify the nice(2) priority to apply to the pool processes (only if set) +; The value can vary from -19 (highest priority) to 20 (lower priority) +; Note: - It will only work if the FPM master process is launched as root +; - The pool processes will inherit the master process priority +; unless it specified otherwise +; Default Value: no set +; process.priority = -19 + +; Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user +; or group is differrent than the master process user. It allows to create process +; core dump and ptrace the process for the pool user. +; Default Value: no +; process.dumpable = yes + +; Choose how the process manager will control the number of child processes. +; Possible Values: +; static - a fixed number (pm.max_children) of child processes; +; dynamic - the number of child processes are set dynamically based on the +; following directives. With this process management, there will be +; always at least 1 children. +; pm.max_children - the maximum number of children that can +; be alive at the same time. +; pm.start_servers - the number of children created on startup. +; pm.min_spare_servers - the minimum number of children in 'idle' +; state (waiting to process). If the number +; of 'idle' processes is less than this +; number then some children will be created. +; pm.max_spare_servers - the maximum number of children in 'idle' +; state (waiting to process). If the number +; of 'idle' processes is greater than this +; number then some children will be killed. +; ondemand - no children are created at startup. Children will be forked when +; new requests will connect. The following parameter are used: +; pm.max_children - the maximum number of children that +; can be alive at the same time. +; pm.process_idle_timeout - The number of seconds after which +; an idle process will be killed. +; Note: This value is mandatory. +pm = dynamic + +; The number of child processes to be created when pm is set to 'static' and the +; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'. +; This value sets the limit on the number of simultaneous requests that will be +; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. +; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP +; CGI. The below defaults are based on a server without much resources. Don't +; forget to tweak pm.* to fit your needs. +; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' +; Note: This value is mandatory. +;pm.max_children = 5 +pm.max_children=120 + +; The number of child processes created on startup. +; Note: Used only when pm is set to 'dynamic' +; Default Value: (min_spare_servers + max_spare_servers) / 2 +;pm.start_servers = 2 +pm.start_servers=12 + +; The desired minimum number of idle server processes. +; Note: Used only when pm is set to 'dynamic' +; Note: Mandatory when pm is set to 'dynamic' +;pm.min_spare_servers = 1 +pm.min_spare_servers=6 + +; The desired maximum number of idle server processes. +; Note: Used only when pm is set to 'dynamic' +; Note: Mandatory when pm is set to 'dynamic' +;pm.max_spare_servers = 3 +pm.max_spare_servers=18 + +; The number of seconds after which an idle process will be killed. +; Note: Used only when pm is set to 'ondemand' +; Default Value: 10s +;pm.process_idle_timeout = 10s; + +; The number of requests each child process should execute before respawning. +; This can be useful to work around memory leaks in 3rd party libraries. For +; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS. +; Default Value: 0 +;pm.max_requests = 500 + +; The URI to view the FPM status page. If this value is not set, no URI will be +; recognized as a status page. It shows the following informations: +; pool - the name of the pool; +; process manager - static, dynamic or ondemand; +; start time - the date and time FPM has started; +; start since - number of seconds since FPM has started; +; accepted conn - the number of request accepted by the pool; +; listen queue - the number of request in the queue of pending +; connections (see backlog in listen(2)); +; max listen queue - the maximum number of requests in the queue +; of pending connections since FPM has started; +; listen queue len - the size of the socket queue of pending connections; +; idle processes - the number of idle processes; +; active processes - the number of active processes; +; total processes - the number of idle + active processes; +; max active processes - the maximum number of active processes since FPM +; has started; +; max children reached - number of times, the process limit has been reached, +; when pm tries to start more children (works only for +; pm 'dynamic' and 'ondemand'); +; Value are updated in real time. +; Example output: +; pool: www +; process manager: static +; start time: 01/Jul/2011:17:53:49 +0200 +; start since: 62636 +; accepted conn: 190460 +; listen queue: 0 +; max listen queue: 1 +; listen queue len: 42 +; idle processes: 4 +; active processes: 11 +; total processes: 15 +; max active processes: 12 +; max children reached: 0 +; +; By default the status page output is formatted as text/plain. Passing either +; 'html', 'xml' or 'json' in the query string will return the corresponding +; output syntax. Example: +; http://www.foo.bar/status +; http://www.foo.bar/status?json +; http://www.foo.bar/status?html +; http://www.foo.bar/status?xml +; +; By default the status page only outputs short status. Passing 'full' in the +; query string will also return status for each pool process. +; Example: +; http://www.foo.bar/status?full +; http://www.foo.bar/status?json&full +; http://www.foo.bar/status?html&full +; http://www.foo.bar/status?xml&full +; The Full status returns for each process: +; pid - the PID of the process; +; state - the state of the process (Idle, Running, ...); +; start time - the date and time the process has started; +; start since - the number of seconds since the process has started; +; requests - the number of requests the process has served; +; request duration - the duration in µs of the requests; +; request method - the request method (GET, POST, ...); +; request URI - the request URI with the query string; +; content length - the content length of the request (only with POST); +; user - the user (PHP_AUTH_USER) (or '-' if not set); +; script - the main script called (or '-' if not set); +; last request cpu - the %cpu the last request consumed +; it's always 0 if the process is not in Idle state +; because CPU calculation is done when the request +; processing has terminated; +; last request memory - the max amount of memory the last request consumed +; it's always 0 if the process is not in Idle state +; because memory calculation is done when the request +; processing has terminated; +; If the process is in Idle state, then informations are related to the +; last request the process has served. Otherwise informations are related to +; the current request being served. +; Example output: +; ************************ +; pid: 31330 +; state: Running +; start time: 01/Jul/2011:17:53:49 +0200 +; start since: 63087 +; requests: 12808 +; request duration: 1250261 +; request method: GET +; request URI: /test_mem.php?N=10000 +; content length: 0 +; user: - +; script: /home/fat/web/docs/php/test_mem.php +; last request cpu: 0.00 +; last request memory: 0 +; +; Note: There is a real-time FPM status monitoring sample web page available +; It's available in: /usr/share/php/7.4/fpm/status.html +; +; Note: The value must start with a leading slash (/). The value can be +; anything, but it may not be a good idea to use the .php extension or it +; may conflict with a real PHP file. +; Default Value: not set +;pm.status_path = /status + +; The ping URI to call the monitoring page of FPM. If this value is not set, no +; URI will be recognized as a ping page. This could be used to test from outside +; that FPM is alive and responding, or to +; - create a graph of FPM availability (rrd or such); +; - remove a server from a group if it is not responding (load balancing); +; - trigger alerts for the operating team (24/7). +; Note: The value must start with a leading slash (/). The value can be +; anything, but it may not be a good idea to use the .php extension or it +; may conflict with a real PHP file. +; Default Value: not set +;ping.path = /ping + +; This directive may be used to customize the response of a ping request. The +; response is formatted as text/plain with a 200 response code. +; Default Value: pong +;ping.response = pong + +; The access log file +; Default: not set +;access.log = log/$pool.access.log + +; The access log format. +; The following syntax is allowed +; %%: the '%' character +; %C: %CPU used by the request +; it can accept the following format: +; - %{user}C for user CPU only +; - %{system}C for system CPU only +; - %{total}C for user + system CPU (default) +; %d: time taken to serve the request +; it can accept the following format: +; - %{seconds}d (default) +; - %{miliseconds}d +; - %{mili}d +; - %{microseconds}d +; - %{micro}d +; %e: an environment variable (same as $_ENV or $_SERVER) +; it must be associated with embraces to specify the name of the env +; variable. Some exemples: +; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e +; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e +; %f: script filename +; %l: content-length of the request (for POST request only) +; %m: request method +; %M: peak of memory allocated by PHP +; it can accept the following format: +; - %{bytes}M (default) +; - %{kilobytes}M +; - %{kilo}M +; - %{megabytes}M +; - %{mega}M +; %n: pool name +; %o: output header +; it must be associated with embraces to specify the name of the header: +; - %{Content-Type}o +; - %{X-Powered-By}o +; - %{Transfert-Encoding}o +; - .... +; %p: PID of the child that serviced the request +; %P: PID of the parent of the child that serviced the request +; %q: the query string +; %Q: the '?' character if query string exists +; %r: the request URI (without the query string, see %q and %Q) +; %R: remote IP address +; %s: status (response code) +; %t: server time the request was received +; it can accept a strftime(3) format: +; %d/%b/%Y:%H:%M:%S %z (default) +; The strftime(3) format must be encapsuled in a %{}t tag +; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t +; %T: time the log has been written (the request has finished) +; it can accept a strftime(3) format: +; %d/%b/%Y:%H:%M:%S %z (default) +; The strftime(3) format must be encapsuled in a %{}t tag +; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t +; %u: remote user +; +; Default: "%R - %u %t \"%m %r\" %s" +;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%" + +; The log file for slow requests +; Default Value: not set +; Note: slowlog is mandatory if request_slowlog_timeout is set +;slowlog = log/$pool.log.slow + +; The timeout for serving a single request after which a PHP backtrace will be +; dumped to the 'slowlog' file. A value of '0s' means 'off'. +; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) +; Default Value: 0 +;request_slowlog_timeout = 0 + +; Depth of slow log stack trace. +; Default Value: 20 +;request_slowlog_trace_depth = 20 + +; The timeout for serving a single request after which the worker process will +; be killed. This option should be used when the 'max_execution_time' ini option +; does not stop script execution for some reason. A value of '0' means 'off'. +; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) +; Default Value: 0 +;request_terminate_timeout = 0 + +; The timeout set by 'request_terminate_timeout' ini option is not engaged after +; application calls 'fastcgi_finish_request' or when application has finished and +; shutdown functions are being called (registered via register_shutdown_function). +; This option will enable timeout limit to be applied unconditionally +; even in such cases. +; Default Value: no +;request_terminate_timeout_track_finished = no + +; Set open file descriptor rlimit. +; Default Value: system defined value +;rlimit_files = 1024 + +; Set max core size rlimit. +; Possible Values: 'unlimited' or an integer greater or equal to 0 +; Default Value: system defined value +;rlimit_core = 0 + +; Chroot to this directory at the start. This value must be defined as an +; absolute path. When this value is not set, chroot is not used. +; Note: you can prefix with '$prefix' to chroot to the pool prefix or one +; of its subdirectories. If the pool prefix is not set, the global prefix +; will be used instead. +; Note: chrooting is a great security feature and should be used whenever +; possible. However, all PHP paths will be relative to the chroot +; (error_log, sessions.save_path, ...). +; Default Value: not set +;chroot = + +; Chdir to this directory at the start. +; Note: relative path can be used. +; Default Value: current directory or / when chroot +;chdir = /var/www + +; Redirect worker stdout and stderr into main error log. If not set, stdout and +; stderr will be redirected to /dev/null according to FastCGI specs. +; Note: on highloaded environement, this can cause some delay in the page +; process time (several ms). +; Default Value: no +;catch_workers_output = yes + +; Decorate worker output with prefix and suffix containing information about +; the child that writes to the log and if stdout or stderr is used as well as +; log level and time. This options is used only if catch_workers_output is yes. +; Settings to "no" will output data as written to the stdout or stderr. +; Default value: yes +;decorate_workers_output = no + +; Clear environment in FPM workers +; Prevents arbitrary environment variables from reaching FPM worker processes +; by clearing the environment in workers before env vars specified in this +; pool configuration are added. +; Setting to "no" will make all environment variables available to PHP code +; via getenv(), $_ENV and $_SERVER. +; Default Value: yes +;clear_env = no +clear_env = no + +; Limits the extensions of the main script FPM will allow to parse. This can +; prevent configuration mistakes on the web server side. You should only limit +; FPM to .php extensions to prevent malicious users to use other extensions to +; execute php code. +; Note: set an empty value to allow all extensions. +; Default Value: .php +;security.limit_extensions = .php .php3 .php4 .php5 .php7 + +; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from +; the current environment. +; Default Value: clean env +;env[HOSTNAME] = $HOSTNAME +;env[PATH] = /usr/local/bin:/usr/bin:/bin +env[PATH]=/usr/local/bin:/usr/bin:/bin +;env[TMP] = /tmp +;env[TMPDIR] = /tmp +;env[TEMP] = /tmp + +; Additional php.ini defines, specific to this pool of workers. These settings +; overwrite the values previously defined in the php.ini. The directives are the +; same as the PHP SAPI: +; php_value/php_flag - you can set classic ini defines which can +; be overwritten from PHP call 'ini_set'. +; php_admin_value/php_admin_flag - these directives won't be overwritten by +; PHP call 'ini_set' +; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. + +; Defining 'extension' will load the corresponding shared extension from +; extension_dir. Defining 'disable_functions' or 'disable_classes' will not +; overwrite previously defined php.ini values, but will append the new value +; instead. + +; Note: path INI options can be relative and will be expanded with the prefix +; (pool, global or /usr) + +; Default Value: nothing is defined by default except the values in php.ini and +; specified at startup with the -d argument +;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com +;php_flag[display_errors] = off +;php_admin_value[error_log] = /var/log/fpm-php.www.log +;php_admin_flag[log_errors] = on +;php_admin_value[memory_limit] = 32M diff --git a/roles/pbx/templates/freepbx-nginx.conf.j2 b/roles/pbx/templates/freepbx-nginx.conf.j2 index 44ae755b9..c7f008237 100644 --- a/roles/pbx/templates/freepbx-nginx.conf.j2 +++ b/roles/pbx/templates/freepbx-nginx.conf.j2 @@ -12,7 +12,7 @@ location ~ ^/freepbx(|/.*)$ { # '~' -> '~*' for case-insensitive regex alias {{ freepbx_install_dir }}$1.php$2; fastcgi_split_path_info ^(.+\.php)(/.+)$; fastcgi_index index.php; - fastcgi_pass php; + fastcgi_pass /run/php/php7.4-asterisk.sock; include fastcgi_params; fastcgi_param PATH_INFO $fastcgi_path_info; From b8fb6fd60dad2c7d5723b63f0189f2413d4e3f75 Mon Sep 17 00:00:00 2001 From: Jerry Vonau Date: Mon, 9 Aug 2021 14:26:36 -0500 Subject: [PATCH 02/13] use php7.4-fpm with new config file --- roles/pbx/tasks/enable-or-disable.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/roles/pbx/tasks/enable-or-disable.yml b/roles/pbx/tasks/enable-or-disable.yml index ba88e76b1..96b3ce191 100644 --- a/roles/pbx/tasks/enable-or-disable.yml +++ b/roles/pbx/tasks/enable-or-disable.yml @@ -35,6 +35,23 @@ - block: + - name: Supply asterisk.conf to /etc/php/{{ php_version }}/fpm/pool.d/ with asterisk as the user + template: + src: asterisk.conf + dest: /etc/php/{{ php_version }}/fpm/pool.d/ + when: pbx_enabled + + - name: Remove /etc/php/{{ php_version }}/fpm/pool.d/asterisk.conf when disabled + file: + path: /etc/php/{{ php_version }}/fpm/pool.d/asterisk.conf + state: absent + when: not pbx_enabled + + - name: Restart 'php7.4-fpm' systemd service + systemd: + name: php7.4-fpm + state: restarted + - name: Enable http://box/freepbx via NGINX, by installing {{ nginx_conf_dir }}/freepbx-nginx.conf from template template: src: freepbx-nginx.conf.j2 From ad1fab91efe8e53b37ad6a58a0e9ca3b7163df88 Mon Sep 17 00:00:00 2001 From: Jerry Vonau Date: Mon, 9 Aug 2021 14:45:56 -0500 Subject: [PATCH 03/13] needs unix: --- roles/pbx/templates/freepbx-nginx.conf.j2 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/pbx/templates/freepbx-nginx.conf.j2 b/roles/pbx/templates/freepbx-nginx.conf.j2 index c7f008237..a1dda4cc3 100644 --- a/roles/pbx/templates/freepbx-nginx.conf.j2 +++ b/roles/pbx/templates/freepbx-nginx.conf.j2 @@ -12,7 +12,7 @@ location ~ ^/freepbx(|/.*)$ { # '~' -> '~*' for case-insensitive regex alias {{ freepbx_install_dir }}$1.php$2; fastcgi_split_path_info ^(.+\.php)(/.+)$; fastcgi_index index.php; - fastcgi_pass /run/php/php7.4-asterisk.sock; + fastcgi_pass unix:/run/php/php7.4-asterisk.sock; include fastcgi_params; fastcgi_param PATH_INFO $fastcgi_path_info; From 842808e70fd5ebceb051e857ca7dc09bfc6c7a54 Mon Sep 17 00:00:00 2001 From: Jerry Vonau Date: Mon, 9 Aug 2021 17:03:05 -0500 Subject: [PATCH 04/13] weird template error use copy instead --- roles/pbx/tasks/enable-or-disable.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/roles/pbx/tasks/enable-or-disable.yml b/roles/pbx/tasks/enable-or-disable.yml index 96b3ce191..4333bef8a 100644 --- a/roles/pbx/tasks/enable-or-disable.yml +++ b/roles/pbx/tasks/enable-or-disable.yml @@ -36,9 +36,9 @@ - block: - name: Supply asterisk.conf to /etc/php/{{ php_version }}/fpm/pool.d/ with asterisk as the user - template: - src: asterisk.conf - dest: /etc/php/{{ php_version }}/fpm/pool.d/ + copy: + src: roles/pbx/templates/asterisk.conf + dest: /etc/php/{{ php_version }}/fpm/pool.d/asterisk.conf when: pbx_enabled - name: Remove /etc/php/{{ php_version }}/fpm/pool.d/asterisk.conf when disabled From 538a908b90c2d28320e99a1d6ad163d59c7b1c7b Mon Sep 17 00:00:00 2001 From: Jerry Vonau Date: Mon, 9 Aug 2021 17:05:30 -0500 Subject: [PATCH 05/13] just play safe --- roles/pbx/tasks/enable-or-disable.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/roles/pbx/tasks/enable-or-disable.yml b/roles/pbx/tasks/enable-or-disable.yml index 4333bef8a..0137ac09f 100644 --- a/roles/pbx/tasks/enable-or-disable.yml +++ b/roles/pbx/tasks/enable-or-disable.yml @@ -51,6 +51,7 @@ systemd: name: php7.4-fpm state: restarted + enabled: yes - name: Enable http://box/freepbx via NGINX, by installing {{ nginx_conf_dir }}/freepbx-nginx.conf from template template: From 31992e77c4268b182c409cf4ebe4369bff1262fb Mon Sep 17 00:00:00 2001 From: Jerry Vonau Date: Mon, 9 Aug 2021 17:13:29 -0500 Subject: [PATCH 06/13] softcode php{{ php_version }}-fpm --- roles/pbx/tasks/enable-or-disable.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/roles/pbx/tasks/enable-or-disable.yml b/roles/pbx/tasks/enable-or-disable.yml index 0137ac09f..66cbc32fc 100644 --- a/roles/pbx/tasks/enable-or-disable.yml +++ b/roles/pbx/tasks/enable-or-disable.yml @@ -47,9 +47,9 @@ state: absent when: not pbx_enabled - - name: Restart 'php7.4-fpm' systemd service + - name: Restart 'php{{ php_version }}-fpm' systemd service systemd: - name: php7.4-fpm + name: php{{ php_version }}-fpm state: restarted enabled: yes From c0f13ddf7dccf76934e1b2e817609e8f834d9628 Mon Sep 17 00:00:00 2001 From: Jerry Vonau Date: Mon, 9 Aug 2021 17:24:27 -0500 Subject: [PATCH 07/13] fwconsole doesn't clean up well --- roles/pbx/templates/freepbx.service | 1 + 1 file changed, 1 insertion(+) diff --git a/roles/pbx/templates/freepbx.service b/roles/pbx/templates/freepbx.service index 42b46abf0..45b12d0cb 100644 --- a/roles/pbx/templates/freepbx.service +++ b/roles/pbx/templates/freepbx.service @@ -7,6 +7,7 @@ Type=oneshot RemainAfterExit=yes ExecStart=/usr/sbin/fwconsole start ExecStop=/usr/sbin/fwconsole stop +ExecStopPost=killall -9 "PM2 v4.5.0: God" # 2021-08-04: Asterisk doesn't (re)start reliably, as FreePBX install completes, # especially on Debian 11? https://github.com/iiab/iiab/pull/2908 / PR #2910 From 4666c3744d07bd2fdda3baf6797aa24c48b8e541 Mon Sep 17 00:00:00 2001 From: Jerry Vonau Date: Mon, 9 Aug 2021 18:01:32 -0500 Subject: [PATCH 08/13] fwconsole doesn't clean up well-2 --- roles/pbx/tasks/freepbx.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/roles/pbx/tasks/freepbx.yml b/roles/pbx/tasks/freepbx.yml index e29906e21..4b2b4ea07 100644 --- a/roles/pbx/tasks/freepbx.yml +++ b/roles/pbx/tasks/freepbx.yml @@ -138,6 +138,7 @@ command: "{{ item }}" with_items: - fwconsole stop + - killall -9 "PM2 v4.5.0: God" # 2021-08-09 might be missed by fwconsole - killall -9 safe_asterisk # 2021-08-08: Stronger medicine needed for 64-bit Ubuntu Server 21.04 on RPi 4. Originally from @jvonau's PR #2912. # - killall -9 asterisk # 2021-08-05: Also from @jvonau's PR #2912, to brute force this. In the end, above 'fwconsole stop' works more gracefully. # - ./start_asterisk stop # Buggy! From 81bef92988930f64deae7cdca1984b95f4d7546a Mon Sep 17 00:00:00 2001 From: Jerry Vonau Date: Mon, 9 Aug 2021 18:41:46 -0500 Subject: [PATCH 09/13] don't use version in socket name. --- roles/pbx/templates/asterisk.conf | 2 +- roles/pbx/templates/freepbx-nginx.conf.j2 | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/roles/pbx/templates/asterisk.conf b/roles/pbx/templates/asterisk.conf index af00d97ad..35c8bd0d5 100644 --- a/roles/pbx/templates/asterisk.conf +++ b/roles/pbx/templates/asterisk.conf @@ -33,7 +33,7 @@ group = www-data ; (IPv6 and IPv4-mapped) on a specific port; ; '/path/to/unix/socket' - to listen on a unix socket. ; Note: This value is mandatory. -listen = /run/php/php7.4-asterisk.sock +listen = /run/php/php-asterisk.sock ; Set listen(2) backlog. ; Default Value: 511 (-1 on FreeBSD and OpenBSD) diff --git a/roles/pbx/templates/freepbx-nginx.conf.j2 b/roles/pbx/templates/freepbx-nginx.conf.j2 index a1dda4cc3..1399a11a4 100644 --- a/roles/pbx/templates/freepbx-nginx.conf.j2 +++ b/roles/pbx/templates/freepbx-nginx.conf.j2 @@ -12,7 +12,7 @@ location ~ ^/freepbx(|/.*)$ { # '~' -> '~*' for case-insensitive regex alias {{ freepbx_install_dir }}$1.php$2; fastcgi_split_path_info ^(.+\.php)(/.+)$; fastcgi_index index.php; - fastcgi_pass unix:/run/php/php7.4-asterisk.sock; + fastcgi_pass unix:/run/php/php-asterisk.sock; include fastcgi_params; fastcgi_param PATH_INFO $fastcgi_path_info; From 4caebbda901d81253a316917cac66851ce836dd0 Mon Sep 17 00:00:00 2001 From: root Date: Tue, 10 Aug 2021 08:11:09 -0400 Subject: [PATCH 10/13] Contextualize @jvonau's fpm-asterisk PR #2930, for FreePBX on NGINX --- roles/pbx/tasks/enable-or-disable.yml | 10 +-- roles/pbx/tasks/freepbx.yml | 4 +- roles/pbx/templates/asterisk.conf | 22 +++++++ roles/pbx/templates/asterisk.conf.diff | 40 ++++++++++++ roles/pbx/templates/asterisk.conf.patch | 85 +++++++++++++++++++++++++ roles/pbx/templates/freepbx.service | 6 +- 6 files changed, 158 insertions(+), 9 deletions(-) create mode 100644 roles/pbx/templates/asterisk.conf.diff create mode 100644 roles/pbx/templates/asterisk.conf.patch diff --git a/roles/pbx/tasks/enable-or-disable.yml b/roles/pbx/tasks/enable-or-disable.yml index 66cbc32fc..4090d8757 100644 --- a/roles/pbx/tasks/enable-or-disable.yml +++ b/roles/pbx/tasks/enable-or-disable.yml @@ -35,31 +35,31 @@ - block: - - name: Supply asterisk.conf to /etc/php/{{ php_version }}/fpm/pool.d/ with asterisk as the user + - name: Install /etc/php/{{ php_version }}/fpm/pool.d/asterisk.conf converted from www.conf for user 'asterisk', if pbx_enabled copy: src: roles/pbx/templates/asterisk.conf dest: /etc/php/{{ php_version }}/fpm/pool.d/asterisk.conf when: pbx_enabled - - name: Remove /etc/php/{{ php_version }}/fpm/pool.d/asterisk.conf when disabled + - name: Remove /etc/php/{{ php_version }}/fpm/pool.d/asterisk.conf, if not pbx_enabled file: path: /etc/php/{{ php_version }}/fpm/pool.d/asterisk.conf state: absent when: not pbx_enabled - - name: Restart 'php{{ php_version }}-fpm' systemd service + - name: Enable & Restart 'php{{ php_version }}-fpm' systemd service systemd: name: php{{ php_version }}-fpm state: restarted enabled: yes - - name: Enable http://box/freepbx via NGINX, by installing {{ nginx_conf_dir }}/freepbx-nginx.conf from template + - name: Enable http://box/freepbx via NGINX, by installing {{ nginx_conf_dir }}/freepbx-nginx.conf from template, if pbx_enabled template: src: freepbx-nginx.conf.j2 dest: "{{ nginx_conf_dir }}/freepbx-nginx.conf" # /etc/nginx/conf.d when: pbx_enabled - - name: Disable http://box/freepbx via NGINX, by removing {{ nginx_conf_dir }}/freepbx-nginx.conf + - name: Disable http://box/freepbx via NGINX, by removing {{ nginx_conf_dir }}/freepbx-nginx.conf, if not pbx_enabled file: path: "{{ nginx_conf_dir }}/freepbx-nginx.conf" state: absent diff --git a/roles/pbx/tasks/freepbx.yml b/roles/pbx/tasks/freepbx.yml index 304bdc4f8..84aa8892e 100644 --- a/roles/pbx/tasks/freepbx.yml +++ b/roles/pbx/tasks/freepbx.yml @@ -180,8 +180,8 @@ command: "{{ item }}" with_items: - fwconsole stop - - killall -9 "PM2 v4.5.0: God" # 2021-08-09 might be missed by fwconsole - - killall -9 safe_asterisk # 2021-08-08: Stronger medicine needed for 64-bit Ubuntu Server 21.04 on RPi 4. Originally from @jvonau's PR #2912. + - killall -9 safe_asterisk # 2021-08-08: Stronger medicine needed for 64-bit Ubuntu Server 21.04 on RPi 4. Originally from @jvonau's PR #2912. + - killall -9 "PM2 v4.5.0: God" # 2021-08-09: Missed by fwconsole (does this matter?) # - killall -9 asterisk # 2021-08-05: Also from @jvonau's PR #2912, to brute force this. In the end, above 'fwconsole stop' works more gracefully. # - ./start_asterisk stop # Buggy! # - /usr/sbin/asterisk -rx "core stop gracefully" diff --git a/roles/pbx/templates/asterisk.conf b/roles/pbx/templates/asterisk.conf index 35c8bd0d5..6d8e12d74 100644 --- a/roles/pbx/templates/asterisk.conf +++ b/roles/pbx/templates/asterisk.conf @@ -1,3 +1,25 @@ +; 2021-08-10: @jvonau derived this from /etc/php/7.4/fpm/pool.d/www.conf (apt +; package php7.4-fpm) with 4 core changes: (github.com/iiab/iiab/pull/2930) +; +; 1. [www] -> [asterisk] +; 2. user = www-data -> user = asterisk +; 3. listen = /run/php/php7.4-fpm.sock -> listen = /run/php/php-asterisk.sock +; 4. listen.owner = www-data -> listen.owner = asterisk +; +; See also asterisk.conf.patch and asterisk.conf.diff here: +; https://github.com/iiab/iiab/tree/master/roles/pbx/templates +; +; "One set of workers is running as www-data and the other set of workers is +; running as asterisk but on different sockets." +; +; This should resolve both iiab/iiab#2914 -> iiab/iiab#2916 "NGINX" issues: +; (1) As you tried to register at http://box/freepbx, cron setup failed with +; exception "Trying to edit user asterisk, when I'm running as www-data" +; https://github.com/iiab/iiab/pull/2916#issuecomment-894585322 +; (2) When you clicked Settings >> Advanced Settings >> Submit >> Apply Config, +; it failed with "Unknown Error. Please Run: fwconsole reload --verbose" +; https://github.com/iiab/iiab/pull/2916#issuecomment-894604982 + ; Start a new pool named 'www'. ; the variable $pool can be used in any directive and will be replaced by the ; pool name ('www' here) diff --git a/roles/pbx/templates/asterisk.conf.diff b/roles/pbx/templates/asterisk.conf.diff new file mode 100644 index 000000000..d1d90aa30 --- /dev/null +++ b/roles/pbx/templates/asterisk.conf.diff @@ -0,0 +1,40 @@ +4c4 +< [www] +--- +> [asterisk] +23c23 +< user = www-data +--- +> user = asterisk +36c36 +< listen = /run/php/php7.4-fpm.sock +--- +> listen = /run/php/php-asterisk.sock +48c48 +< listen.owner = www-data +--- +> listen.owner = asterisk +114c114,115 +< pm.max_children = 5 +--- +> ;pm.max_children = 5 +> pm.max_children=120 +119c120,121 +< pm.start_servers = 2 +--- +> ;pm.start_servers = 2 +> pm.start_servers=12 +124c126,127 +< pm.min_spare_servers = 1 +--- +> ;pm.min_spare_servers = 1 +> pm.min_spare_servers=6 +129c132,133 +< pm.max_spare_servers = 3 +--- +> ;pm.max_spare_servers = 3 +> pm.max_spare_servers=18 +397a402 +> clear_env = no +411a417 +> env[PATH]=/usr/local/bin:/usr/bin:/bin diff --git a/roles/pbx/templates/asterisk.conf.patch b/roles/pbx/templates/asterisk.conf.patch new file mode 100644 index 000000000..bc4932d0a --- /dev/null +++ b/roles/pbx/templates/asterisk.conf.patch @@ -0,0 +1,85 @@ +--- /etc/php/7.4/fpm/pool.d/www.conf 2021-07-01 23:59:48.000000000 -0400 ++++ /etc/php/7.4/fpm/pool.d/asterisk.conf 2021-08-10 05:25:09.808067373 -0400 +@@ -1,7 +1,7 @@ + ; Start a new pool named 'www'. + ; the variable $pool can be used in any directive and will be replaced by the + ; pool name ('www' here) +-[www] ++[asterisk] + + ; Per pool prefix + ; It only applies on the following directives: +@@ -20,7 +20,7 @@ + ; Unix user/group of processes + ; Note: The user is mandatory. If the group is not set, the default user's group + ; will be used. +-user = www-data ++user = asterisk + group = www-data + + ; The address on which to accept FastCGI requests. +@@ -33,7 +33,7 @@ + ; (IPv6 and IPv4-mapped) on a specific port; + ; '/path/to/unix/socket' - to listen on a unix socket. + ; Note: This value is mandatory. +-listen = /run/php/php7.4-fpm.sock ++listen = /run/php/php-asterisk.sock + + ; Set listen(2) backlog. + ; Default Value: 511 (-1 on FreeBSD and OpenBSD) +@@ -45,7 +45,7 @@ + ; and group can be specified either by name or by their numeric IDs. + ; Default Values: user and group are set as the running user + ; mode is set to 0660 +-listen.owner = www-data ++listen.owner = asterisk + listen.group = www-data + ;listen.mode = 0660 + ; When POSIX Access Control Lists are supported you can set them using +@@ -111,22 +111,26 @@ + ; forget to tweak pm.* to fit your needs. + ; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' + ; Note: This value is mandatory. +-pm.max_children = 5 ++;pm.max_children = 5 ++pm.max_children=120 + + ; The number of child processes created on startup. + ; Note: Used only when pm is set to 'dynamic' + ; Default Value: (min_spare_servers + max_spare_servers) / 2 +-pm.start_servers = 2 ++;pm.start_servers = 2 ++pm.start_servers=12 + + ; The desired minimum number of idle server processes. + ; Note: Used only when pm is set to 'dynamic' + ; Note: Mandatory when pm is set to 'dynamic' +-pm.min_spare_servers = 1 ++;pm.min_spare_servers = 1 ++pm.min_spare_servers=6 + + ; The desired maximum number of idle server processes. + ; Note: Used only when pm is set to 'dynamic' + ; Note: Mandatory when pm is set to 'dynamic' +-pm.max_spare_servers = 3 ++;pm.max_spare_servers = 3 ++pm.max_spare_servers=18 + + ; The number of seconds after which an idle process will be killed. + ; Note: Used only when pm is set to 'ondemand' +@@ -395,6 +399,7 @@ + ; via getenv(), $_ENV and $_SERVER. + ; Default Value: yes + ;clear_env = no ++clear_env = no + + ; Limits the extensions of the main script FPM will allow to parse. This can + ; prevent configuration mistakes on the web server side. You should only limit +@@ -409,6 +414,7 @@ + ; Default Value: clean env + ;env[HOSTNAME] = $HOSTNAME + ;env[PATH] = /usr/local/bin:/usr/bin:/bin ++env[PATH]=/usr/local/bin:/usr/bin:/bin + ;env[TMP] = /tmp + ;env[TMPDIR] = /tmp + ;env[TEMP] = /tmp diff --git a/roles/pbx/templates/freepbx.service b/roles/pbx/templates/freepbx.service index 45b12d0cb..289b1ec9d 100644 --- a/roles/pbx/templates/freepbx.service +++ b/roles/pbx/templates/freepbx.service @@ -8,8 +8,10 @@ RemainAfterExit=yes ExecStart=/usr/sbin/fwconsole start ExecStop=/usr/sbin/fwconsole stop ExecStopPost=killall -9 "PM2 v4.5.0: God" -# 2021-08-04: Asterisk doesn't (re)start reliably, as FreePBX install completes, -# especially on Debian 11? https://github.com/iiab/iiab/pull/2908 / PR #2910 +# 2021-08-10: Asterisk stuff doesn't stop reliably, right after freepbx.yml +# 'install -n' completes -- hence "Unable to run Pre-Asterisk hooks, because +# Asterisk is already running" issue when freepbx.service next tries to start +# it. See pbx/tasks/freepbx.yml workarounds e.g. github.com/iiab/iiab/pull/2915 [Install] WantedBy=multi-user.target From ccff5b30e1c8a601c857bc83820d6f614601bed5 Mon Sep 17 00:00:00 2001 From: root Date: Tue, 10 Aug 2021 14:02:26 -0400 Subject: [PATCH 11/13] /etc/nginx/server.conf: Dynamically set 'server_name ;' (e.g. box.lan) for HTTP_REFERER --- roles/nginx/templates/server.conf.j2 | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/roles/nginx/templates/server.conf.j2 b/roles/nginx/templates/server.conf.j2 index 37aeca372..ece424ec7 100644 --- a/roles/nginx/templates/server.conf.j2 +++ b/roles/nginx/templates/server.conf.j2 @@ -1,6 +1,8 @@ server { root {{ doc_root }}; - server_name {{ iiab_hostname }}; + server_name $hostname; # e.g. box.lan, set dynamically when NGINX starts + #server_name {{ iiab_hostname }}.{{ iiab_domain }}; + #server_name {{ iiab_hostname }} listen 80; index index.php index.html index.htm; From 39950cc471551b99e4ffd44837eb8044b9069914 Mon Sep 17 00:00:00 2001 From: root Date: Tue, 10 Aug 2021 19:20:37 -0400 Subject: [PATCH 12/13] freepbx.yml: Set CHECKREFERER to false in /etc/freepbx.conf for NGINX #2931 --- roles/pbx/tasks/freepbx.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/roles/pbx/tasks/freepbx.yml b/roles/pbx/tasks/freepbx.yml index bc2669350..b9ab4d0c7 100644 --- a/roles/pbx/tasks/freepbx.yml +++ b/roles/pbx/tasks/freepbx.yml @@ -215,6 +215,13 @@ dest: /etc/systemd/system/ +- name: Add "$amp_conf['CHECKREFERER'] = false;" to /etc/freepbx.conf #2931 - if pbx_try_nginx" + lineinfile: + path: /etc/freepbx.conf + insertbefore: '^\?>$' # Match exact line '?>' -- BOTTOM OF FILE NEC! + line: "$amp_conf['CHECKREFERER'] = false;" + when: pbx_try_nginx + # - name: 'FreePBX - fix file permissions for NGINX: /etc/freepbx.conf (0644), /var/log/asterisk/freepbx.log (0666)' # file: # #state: file From 4543e3161923c18e1151c9157b43aae62000579c Mon Sep 17 00:00:00 2001 From: A Holt Date: Tue, 10 Aug 2021 20:42:13 -0400 Subject: [PATCH 13/13] roles/nginx/templates/server.conf.j2: Typo in commen --- roles/nginx/templates/server.conf.j2 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/nginx/templates/server.conf.j2 b/roles/nginx/templates/server.conf.j2 index ece424ec7..6e996c4bb 100644 --- a/roles/nginx/templates/server.conf.j2 +++ b/roles/nginx/templates/server.conf.j2 @@ -2,7 +2,7 @@ server { root {{ doc_root }}; server_name $hostname; # e.g. box.lan, set dynamically when NGINX starts #server_name {{ iiab_hostname }}.{{ iiab_domain }}; - #server_name {{ iiab_hostname }} + #server_name {{ iiab_hostname }}; listen 80; index index.php index.html index.htm;