YunoHost-Apps / synapse_ynh

Matrix server (synapse) package for YunoHost
https://matrix.org/
GNU General Public License v3.0
79 stars 42 forks source link

synapse creates a php7.4-fpm service error due to php.conf no uid for user synapse #427

Closed jorge-vitrubio closed 1 year ago

jorge-vitrubio commented 1 year ago

After upgrade to matrix/synapse version 1.94 every restart has a php7.4-fpm error related to synapse user.

Matrix/synapse works on my end with clients f-droid SchildiChat and debian Revolt and debian Matrix. I don't use it with web front end.

This is the ssh analisys.

# systemctl --failed
  UNIT               LOAD   ACTIVE SUB    DESCRIPTION
● php7.4-fpm.service loaded failed failed The PHP 7.4 FastCGI Process Manager

LOAD   = Reflects whether the unit definition was properly loaded.
ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
SUB    = The low-level unit activation state, values depend on unit type.
1 loaded units listed.

checking the service status

# systemctl status php7.4-fpm.service
● php7.4-fpm.service - The PHP 7.4 FastCGI Process Manager
     Loaded: loaded (/lib/systemd/system/php7.4-fpm.service; enabled; vendor preset: enabled)
     Active: failed (Result: exit-code) since Wed 2023-11-15 11:12:29 CET; 29min ago
       Docs: man:php-fpm7.4(8)
   Main PID: 744 (code=exited, status=78)

Nov 15 11:12:28 domain.tdl systemd[1]: Starting The PHP 7.4 FastCGI Process Manager...
Nov 15 11:12:29 domain.tdl php-fpm7.4[744]: [15-Nov-2023 11:12:29] ERROR: [pool synapse] cannot get uid for user 'synapse'
Nov 15 11:12:29 domain.tdl php-fpm7.4[744]: [15-Nov-2023 11:12:29] ERROR: FPM initialization failed
Nov 15 11:12:29 domain.tdl systemd[1]: php7.4-fpm.service: Main process exited, code=exited, status=78/CONFIG
Nov 15 11:12:29 domain.tdl systemd[1]: php7.4-fpm.service: Failed with result 'exit-code'.
Nov 15 11:12:29 domain.tdl systemd[1]: Failed to start The PHP 7.4 FastCGI Process Manager.

cheking users

# cat /etc/passwd |grep synapse
matrix-synapse:x:999:999::/opt/yunohost/matrix-synapse:/usr/sbin/nologin

cheking synapse UID

# id -u synapse
56281

checking the php7.4

# cat /lib/systemd/system/php7.4-fpm.service 
[Unit]
Description=The PHP 7.4 FastCGI Process Manager
Documentation=man:php-fpm7.4(8)
After=network.target

[Service]
Type=notify
ExecStart=/usr/sbin/php-fpm7.4 --nodaemonize --fpm-config /etc/php/7.4/fpm/php-fpm.conf
ExecStartPost=-/usr/lib/php/php-fpm-socket-helper install /run/php/php-fpm.sock /etc/php/7.4/fpm/pool.d/www.conf 74
ExecStopPost=-/usr/lib/php/php-fpm-socket-helper remove /run/php/php-fpm.sock /etc/php/7.4/fpm/pool.d/www.conf 74
ExecReload=/bin/kill -USR2 $MAINPID

[Install]
WantedBy=multi-user.target

the php7.4 conf files calls the fpm/pool.d, checking synapse.conf a call to user = synapse the one generating the systemctl error.

# cat /etc/php/7.4/fpm/pool.d/synapse.conf 

[synapse]

user = synapse
group = synapse

chdir = /opt/yunohost/matrix-synapse

listen = /var/run/php/php7.4-fpm-synapse.sock
listen.owner = www-data
listen.group = www-data

pm = ondemand
pm.max_children = 4
pm.max_requests = 500
request_terminate_timeout = 1d

pm.process_idle_timeout = 10s

; Additional php.ini defines, specific to this pool of workers.

php_admin_value[upload_max_filesize] = 100M
php_admin_value[post_max_size] = 100M

then looking for php-fpm config files related to synapse

# find /etc/php/ |grep synapse.conf
/etc/php/7.4/fpm/pool.d/synapse.conf
/etc/php/7.3/fpm/pool.d/synapse.conf

in the previous php7.3 version calls the user = matrix-synapse not just synapse

# cat /etc/php/7.3/fpm/pool.d/synapse.conf 
; Start a new pool named 'www'.
; the variable $pool can we used in any directive and will be replaced by the
; pool name ('www' here)
[synapse]

; Per pool prefix
; It only applies on the following directives:
; - '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 = matrix-synapse
group = matrix-synapse

; 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 address on
;                            a specific port;
;   'port'                 - to listen on a TCP socket to all addresses on a
;                            specific port;
;   '/path/to/unix/socket' - to listen on a unix socket.
; Note: This value is mandatory.
listen = /run/php7.3-fpm-synapse.sock

; Set listen(2) backlog. A value of '-1' means unlimited.
; Default Value: 128 (-1 on FreeBSD and OpenBSD)
;listen.backlog = 128

; 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. 
; Default Values: user and group are set as the running user
;                 mode is set to 0660
listen.owner = www-data
listen.group = www-data
;listen.mode = 0660

; List of ipv4 addresses 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
; priority = -19

; 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

; 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 - min_spare_servers) / 2
pm.start_servers = 1

; 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

; 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 = 2

; 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: ${prefix}/share/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: ouput 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)
;  %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)
;  %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 = /var/log/nginx/synapse.slow.log

; 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 = 5s

; 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 = 1d

; 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/synapse

; 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

; 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
; exectute php code.
; Note: set an empty value to allow all extensions.
; Default Value: .php
;security.limit_extensions = .php .php3 .php4 .php7.3

; 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[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

Context

Logs

# tail -100 /var/log/php7.4-fpm.log
[12-Nov-2023 04:12:11] ERROR: [pool synapse] cannot get uid for user 'synapse'
[12-Nov-2023 04:12:11] ERROR: FPM initialization failed
[12-Nov-2023 07:06:15] NOTICE: configuration file /etc/php/7.4/fpm/php-fpm.conf test is successful
[12-Nov-2023 19:16:53] NOTICE: configuration file /etc/php/7.4/fpm/php-fpm.conf test is successful
[13-Nov-2023 04:08:00] ERROR: [pool synapse] cannot get uid for user 'synapse'
[13-Nov-2023 04:08:00] ERROR: FPM initialization failed
[13-Nov-2023 07:20:10] NOTICE: configuration file /etc/php/7.4/fpm/php-fpm.conf test is successful
[13-Nov-2023 19:06:34] NOTICE: configuration file /etc/php/7.4/fpm/php-fpm.conf test is successful
[14-Nov-2023 04:04:26] ERROR: [pool synapse] cannot get uid for user 'synapse'
[14-Nov-2023 04:04:26] ERROR: FPM initialization failed
[14-Nov-2023 07:07:12] NOTICE: configuration file /etc/php/7.4/fpm/php-fpm.conf test is successful
[14-Nov-2023 19:09:58] NOTICE: configuration file /etc/php/7.4/fpm/php-fpm.conf test is successful
[15-Nov-2023 04:18:50] ERROR: [pool synapse] cannot get uid for user 'synapse'
[15-Nov-2023 04:18:50] ERROR: FPM initialization failed
[15-Nov-2023 07:02:20] NOTICE: configuration file /etc/php/7.4/fpm/php-fpm.conf test is successful
[15-Nov-2023 11:08:25] NOTICE: fpm is running, pid 11593
[15-Nov-2023 11:08:25] NOTICE: ready to handle connections
[15-Nov-2023 11:08:25] NOTICE: systemd monitor interval set to 10000ms
[15-Nov-2023 11:11:41] NOTICE: Terminating ...
[15-Nov-2023 11:11:41] NOTICE: exiting, bye-bye!
[15-Nov-2023 11:12:29] ERROR: [pool synapse] cannot get uid for user 'synapse'
[15-Nov-2023 11:12:29] ERROR: FPM initialization failed

Question

can I solve it by just changing manually the user = synapse to user = matrix-synapse or this could be a problem when upgrading?

greenmmq commented 1 year ago

FWIW - I tried this and it was a successful fix that allowed me to reinitialize my php7.4-fpm service.

That said, in my situation I also have a slew of other issues, and this php-7.4-fpm issue appears to have been just one symptom of a larger, as of yet unknown, bug/malconfiguration that has been affecting my system...

Josue-T commented 1 year ago

Hello,

On the current version of the package you should have a yunohost user synapse and a system user matrix-synapse. Can you check that it's the case on your side ?

jorge-vitrubio commented 1 year ago

hello, yes, i can confirm I have both users:

# getent passwd | grep synapse
matrix-synapse:x:<edited>:<edited>::/opt/yunohost/matrix-synapse:/usr/sbin/nologin
synapse:*:<edited>:<edited>:Synapse Application:/home/synapse:/bin/bash
Josue-T commented 1 year ago

And what return this command id synapse ?

jorge-vitrubio commented 1 year ago

And what return this command id synapse ?

# id synapse 
uid=56281(synapse)
gid=56281(synapse)
groups=56281(synapse),4002(all_users),5001(mail.main),5002(xmpp.main),72965(nextcloud.api),21672(nextcloud.main),83211(my_webapp__6.main),61926(pleroma.main),44718(synapse.main),95071(my_webapp.main)

and matrix-synapse

# id matrix-synapse
uid=999(matrix-synapse)
gid=999(matrix-synapse)
groups=999(matrix-synapse),115(ssl-cert)

What I don't get is why I have a user synapse ... I can't remember if I did created it along time ago, but in my notes (as I tend to forget sysadmin things) it is not documented that I have created any.

Josue-T commented 1 year ago

Should be fixed by #428

jorge-vitrubio commented 1 year ago

Should be fixed by #428

Thankyou, it is fixed!!!

# systemctl --failed 
  UNIT LOAD ACTIVE SUB DESCRIPTION
0 loaded units listed.
# yunohost app info synapse
description: Instant messaging server which uses Matrix
domain_path: matrix.vitrubio.net/_matrix
name: synapse/matrix
version: 1.96.1~ynh1