http://hg.omfa.de/prosody-hg/ en-us util/startup.lua revision history http://hg.omfa.de/prosody-hg/log/2b13c24ba2d6/util/startup.lua Matthew Wild <mwild1@gmail.com> Thu, 28 May 2026 17:26:08 +0100 http://hg.omfa.de/prosody-hg/log/a874c3f4570a/util/startup.lua
Commit c673ff1075bd removed mod_posix, and moved functionality into
util.startup, including applying a secure umask at runtime. However, the
new function was not called from the startup sequence, leading Prosody to run
with whatever umask it inherited from the environment.

Prosody Debian packages ship with a secure umask 027 in the systemd unit file
for the prosody service, so Debian systems using systemd are not affected.

prosodyctl calls the switch_user() function during startup, which would set
the umask, so prosodyctl commands which created files were unaffected.

This change makes both prosody and prosodyctl unconditionally set a secure
umask during the startup process.]]> Matthew Wild <mwild1@gmail.com> Thu, 28 May 2026 17:25:46 +0100 http://hg.omfa.de/prosody-hg/log/c1469296190d/util/startup.lua Matthew Wild <mwild1@gmail.com> Fri, 17 Apr 2026 14:35:32 +0100 http://hg.omfa.de/prosody-hg/log/a957cd3ea4eb/util/startup.lua
The current error text always implied that the file is missing, but it could
also be a permissions issue, or something else.

Now it will handle those two cases, and show the error from the system
otherwise.]]> Matthew Wild <mwild1@gmail.com> Thu, 16 Apr 2026 18:50:23 +0100 http://hg.omfa.de/prosody-hg/log/a8aa17293d22/util/startup.lua
Observed larger numbers than expected in the 4..Inf range, want more
details.]]> Kim Alvefur <zash@zash.se> Tue, 28 Oct 2025 19:15:51 +0100 http://hg.omfa.de/prosody-hg/log/260a6feebe5f/util/startup.lua
Otherwise hard to tell the difference between 0 and 1 :)]]> Kim Alvefur <zash@zash.se> Sat, 18 Oct 2025 00:53:43 +0200 http://hg.omfa.de/prosody-hg/log/ccbc4a46f42d/util/startup.lua
> attempt to call a nil value (method 'add')]]> Kim Alvefur <zash@zash.se> Thu, 09 Oct 2025 13:45:52 +0200 http://hg.omfa.de/prosody-hg/log/350e16e5f9aa/util/startup.lua
In order to gather stats on how wide-spread various record types are,
and how many records per rrset are common.]]> Kim Alvefur <zash@zash.se> Tue, 07 Oct 2025 23:50:12 +0200 http://hg.omfa.de/prosody-hg/log/d8c001271669/util/startup.lua Kim Alvefur <zash@zash.se> Tue, 07 Oct 2025 19:09:25 +0200 http://hg.omfa.de/prosody-hg/log/2041c347c178/util/startup.lua
Ref https://www.freedesktop.org/software/systemd/man/249/sd_notify.html
> Note that a service that sends this notification must also send a
> "READY=1" notification when it completed reloading its configuration.

However no word on how to handle errors while doing that, such as
configuration syntax errors, but communicating this via STATUS= makes
some sense.

Fixes #1970]]> Kim Alvefur <zash@zash.se> Mon, 06 Oct 2025 01:22:40 +0200 http://hg.omfa.de/prosody-hg/log/203a0b5ade55/util/startup.lua
~$ lua5.5
Lua 5.5.0 Copyright (C) 1994-2025 Lua.org, PUC-Rio
> collectgarbage("param", "minormul")
20
> collectgarbage("param", "majorminor")
50
> collectgarbage("param", "minormajor")
68]]> Kim Alvefur <zash@zash.se> Wed, 06 Aug 2025 16:48:35 +0200 http://hg.omfa.de/prosody-hg/log/0c7e11c11968/util/startup.lua
Minimizing dependencies on global state is nice, as it makes using
configmanager outside of Prosody easier.]]> Kim Alvefur <zash@zash.se> Sat, 22 Feb 2025 00:00:41 +0100 http://hg.omfa.de/prosody-hg/log/5abdcad8c2e0/util/startup.lua
Nice to have this in OpenMetricts instead of debug logs]]> Kim Alvefur <zash@zash.se> Fri, 07 Feb 2025 09:22:52 +0100 http://hg.omfa.de/prosody-hg/log/94f77a1994dc/util/startup.lua
This does not have to be specific to systemd]]> Kim Alvefur <zash@zash.se> Sat, 01 Feb 2025 20:42:59 +0100 http://hg.omfa.de/prosody-hg/log/8228f5094f7a/util/startup.lua Kim Alvefur <zash@zash.se> Sat, 18 Jan 2025 13:29:59 +0100 http://hg.omfa.de/prosody-hg/log/2db7b3b65363/util/startup.lua
Idea is to enable easily retrieving of secret values from files outside
of the config, e.g. via the method used by systemd credentials.

CREDENTIALS_DIRECTORY is expected to be set by the process manager
invoking Prosody, so being unset and unavailable from prosodyctl is
going to be normal and a warning is reported in that case. Care will
have to be taken to make it clear that prosodyctl check will not work
with such values. An error is thrown if the directory is unavailable
when running under Prosody.]]> Kim Alvefur <zash@zash.se> Thu, 16 Jan 2025 15:21:34 +0100 http://hg.omfa.de/prosody-hg/log/a350f6332bd8/util/startup.lua
Otherwise Prosody refuses to start.]]> Kim Alvefur <zash@zash.se> Sat, 16 Nov 2024 14:35:11 +0100 http://hg.omfa.de/prosody-hg/log/e8ac3ce3238e/util/startup.lua
Does this event name seem backwards to anyone else?]]> Kim Alvefur <zash@zash.se> Mon, 08 Apr 2024 09:29:58 +0200 http://hg.omfa.de/prosody-hg/log/afad3b2725bf/util/startup.lua
This lets Prosody report its lifecycle status to systemd, so it knows
when Prosody has completed its startup, when it's reloading and shutting
down.

Both Type=notify and Type=notify-reload is supported

Example systemd .service configuration snippet:

[Service]
Type=notify]]> Kim Alvefur <zash@zash.se> Thu, 04 Apr 2024 19:00:27 +0200 http://hg.omfa.de/prosody-hg/log/c2a476f4712a/util/startup.lua
prosody.shutdown() relies on prosody.main_thread, which has not been set
yet at this point.

Doing a clean shutdown might actually be harmful in case it tears down
things set up by the conflicting Prosody, such as the very pidfile we
were looking at.

Thanks again SigmaTel71 for noticing]]> Kim Alvefur <zash@zash.se> Wed, 27 Mar 2024 19:33:11 +0100 http://hg.omfa.de/prosody-hg/log/2dbc169aae6a/util/startup.lua
Prevents creation of log files owned by the root user which could be
inaccessible once started correctly.]]> Kim Alvefur <zash@zash.se> Sun, 24 Mar 2024 21:32:00 +0100 http://hg.omfa.de/prosody-hg/log/3ce550ce44ce/util/startup.lua Kim Alvefur <zash@zash.se> Sun, 24 Mar 2024 21:31:47 +0100 http://hg.omfa.de/prosody-hg/log/720aed1f5cf2/util/startup.lua
Ensures that startup.detect_platform() runs so know whether to use the
POSIX method of checking the current user or something else. Also after
reading the config so we know whether the root override setting is set.]]> Kim Alvefur <zash@zash.se> Sun, 24 Mar 2024 20:39:42 +0100 http://hg.omfa.de/prosody-hg/log/c673ff1075bd/util/startup.lua
This allows greater control over the order of events.

Notably, the internal ordering between daemonization, initialization of
libunbound and setup of signal handling is sensitive.

libunbound starts a separate thread for processing DNS requests.
If this thread is started before signal handling has been set up, it
will not inherit the signal handlers and instead behave as it would have
before signal handlers were set up, i.e. cause the whole process to
immediately exit.

libunbound is usually initialized on the first DNS request, usually
triggered by an outgoing s2s connection attempt.

If daemonization happens before signals have been set up, signals may
not be processed at all.]]> Kim Alvefur <zash@zash.se> Sat, 23 Mar 2024 20:48:19 +0100 http://hg.omfa.de/prosody-hg/log/790f60c0843b/util/startup.lua
Broke signal handling again, such that an early s2s connection results
in libunbound catching signals and getting Prosody killed on e.g. SIGHUP

This returns to the situation where prosody --daemonize does not respond
to signals.]]> Kim Alvefur <zash@zash.se> Sun, 10 Mar 2024 15:56:01 +0100 http://hg.omfa.de/prosody-hg/log/598df17b8ebb/util/startup.lua
signalfds stop working with epoll after forking

hooking signals later should not affect anything]]> Kim Alvefur <zash@zash.se> Wed, 06 Mar 2024 20:43:25 +0100 http://hg.omfa.de/prosody-hg/log/b0c27628f588/util/startup.lua Kim Alvefur <zash@zash.se> Sat, 02 Mar 2024 14:08:47 +0100 http://hg.omfa.de/prosody-hg/log/69faf3552d52/util/startup.lua
When libunbound is initialized, it spawns a thread to work in.
In case a module initializes libunbound, e.g. by triggering a s2s
connection, Prosody would not handle signals, instead immediately quit
on e.g. the reload (SIGHUP) signal. Likely because the libunbound thread
would not have inherited the signal mask from the main Prosody thread.

Thanks Menel, riau and franck-x for reporting and help narrowing down]]> Kim Alvefur <zash@zash.se> Sat, 02 Mar 2024 13:23:24 +0100 http://hg.omfa.de/prosody-hg/log/0efb53a0852e/util/startup.lua
for convenience.]]> Matthew Wild <mwild1@gmail.com> Thu, 22 Feb 2024 09:53:02 +0000 http://hg.omfa.de/prosody-hg/log/d0a9b631a937/util/startup.lua
Maybe we need some sort of lint for this?]]> Kim Alvefur <zash@zash.se> Fri, 24 Nov 2023 13:41:21 +0100 http://hg.omfa.de/prosody-hg/log/ab36edc7c217/util/startup.lua Matthew Wild <mwild1@gmail.com> Tue, 07 Nov 2023 12:12:18 +0000 http://hg.omfa.de/prosody-hg/log/9c13c11b199d/util/startup.lua Kim Alvefur <zash@zash.se> Sun, 18 Jun 2023 16:48:56 +0200 http://hg.omfa.de/prosody-hg/log/be4058bb5a7e/util/startup.lua
Useful to have this info available when juggling metrics, e.g. to
see if things changed between versions.]]> Kim Alvefur <zash@zash.se> Wed, 31 May 2023 01:14:59 +0200 http://hg.omfa.de/prosody-hg/log/df57c62165fc/util/startup.lua
Module was removed in 0.8.0 in c52b06de9b27]]> Kim Alvefur <zash@zash.se> Wed, 31 May 2023 01:07:27 +0200 http://hg.omfa.de/prosody-hg/log/06453c564141/util/startup.lua
To avoid a race where server-started fires before the promise function body is
run (on next tick), I moved server-started to fire on the next tick, which
seems sensible anyway.

Errors are logged, I'm not sure if we ought to be doing something more here.
I'm sure we'll find out.]]> Matthew Wild <mwild1@gmail.com> Sat, 01 Apr 2023 11:56:38 +0100 http://hg.omfa.de/prosody-hg/log/fc0109c59807/util/startup.lua
Mostly in order to avoid triggering the XML syntax highlighting in the
console logger.]]> Kim Alvefur <zash@zash.se> Sun, 26 Mar 2023 00:11:42 +0100 http://hg.omfa.de/prosody-hg/log/d10957394a3c/util/startup.lua Kim Alvefur <zash@zash.se> Fri, 17 Mar 2023 16:23:16 +0100 http://hg.omfa.de/prosody-hg/log/9f9633364044/util/startup.lua Kim Alvefur <zash@zash.se> Sun, 22 Jan 2023 15:43:44 +0100 http://hg.omfa.de/prosody-hg/log/891edd1ebde6/util/startup.lua
Ensures a last round of garbage collection and that finalizers are
called. Fixes things like proper closing of SQLite3 state.

There are more calls to os.exit() but most of them exit with an error or
in a case where a final GC sweep might not matter as much.

It would be nice if this was the default.

Calling util.statup.exit() everywhere may be sensible, but would be more
involved, requiring imports everywhere.]]> Kim Alvefur <zash@zash.se> Sun, 22 Jan 2023 14:45:47 +0100 http://hg.omfa.de/prosody-hg/log/8815d3090928/util/startup.lua
Mostly to ensure it is available during tests, as util.startup is not
invoked there]]> Kim Alvefur <zash@zash.se> Thu, 20 Oct 2022 16:50:12 +0200 http://hg.omfa.de/prosody-hg/log/22066b02887f/util/startup.lua
Code deduplication]]> Kim Alvefur <zash@zash.se> Wed, 19 Oct 2022 16:25:05 +0200 http://hg.omfa.de/prosody-hg/log/f0474d40364c/util/startup.lua
Fixes error in mod_authz_internal due to import() being unavailable as
it was only loaded in Prosody proper]]> Kim Alvefur <zash@zash.se> Thu, 20 Oct 2022 16:31:18 +0200 http://hg.omfa.de/prosody-hg/log/cc0ec0277813/util/startup.lua
Observed problem: When shutting down prosody would immediately exit
after waiting for s2s connections to close, skipping the last cleanup
events and reporting the exit reason and code.

This happens because prosody.main_thread is in a waiting state and
queuing startup.shutdown is dispatched trough the main loop via
nexttick, but since the main loop was no longer running at that point it
proceeded to the end of the prosody script and exited there.]]> Kim Alvefur <zash@zash.se> Tue, 14 Jun 2022 16:28:49 +0200 http://hg.omfa.de/prosody-hg/log/3ae9299d61d7/util/startup.lua Matthew Wild <mwild1@gmail.com> Mon, 21 Mar 2022 10:06:48 +0000 http://hg.omfa.de/prosody-hg/log/81f147ddc4ab/util/startup.lua Kim Alvefur <zash@zash.se> Tue, 01 Jan 2019 16:42:52 +0100 http://hg.omfa.de/prosody-hg/log/10447f940fec/util/startup.lua Kim Alvefur <zash@zash.se> Sat, 05 Feb 2022 01:36:10 +0100 http://hg.omfa.de/prosody-hg/log/858d40d675ee/util/startup.lua Kim Alvefur <zash@zash.se> Sun, 28 Nov 2021 23:07:51 +0100 http://hg.omfa.de/prosody-hg/log/73ecfe811526/util/startup.lua
Original motivation was tiresome warnings about Lua 5.4 not being
supported yet.

Can still be handy to tweak log level, e.g. to prevent logging to
interfere with command output.]]> Kim Alvefur <zash@zash.se> Sun, 28 Nov 2021 23:07:35 +0100 http://hg.omfa.de/prosody-hg/log/ac654fb19203/util/startup.lua
The 'prosody' global is not global this early so there was no way to
override the process type field or argument parsing settings from
outside, e.g. from the migrator.]]> Kim Alvefur <zash@zash.se> Sun, 09 Jan 2022 15:16:09 +0100 http://hg.omfa.de/prosody-hg/log/f5c6be4a3ecc/util/startup.lua Matthew Wild <mwild1@gmail.com> Mon, 29 Nov 2021 14:16:20 +0000 http://hg.omfa.de/prosody-hg/log/dca75cc6fc5a/util/startup.lua Kim Alvefur <zash@zash.se> Sat, 05 Jan 2019 07:15:33 +0100 http://hg.omfa.de/prosody-hg/log/1d1ed2be3491/util/startup.lua
prosodyctl -h showing an error was not very helpful, especially since
prosodyctl shows its help for any unknown (or none) command.]]> Kim Alvefur <zash@zash.se> Mon, 25 Oct 2021 15:47:18 +0200 http://hg.omfa.de/prosody-hg/log/d52a73425eba/util/startup.lua
Seems more suitable than asking if prosodyctl was meant to be used, or
going ahead and starting.]]> Kim Alvefur <zash@zash.se> Mon, 25 Oct 2021 15:46:01 +0200 http://hg.omfa.de/prosody-hg/log/515a89dee6ae/util/startup.lua
This field is empty for reasons when invoked by prosody-migrator, which
threw an error:
> bad argument #1 to 'open' (string expected, got nil)]]> Kim Alvefur <zash@zash.se> Sat, 23 Oct 2021 22:24:59 +0200 http://hg.omfa.de/prosody-hg/log/2b3ce80ffece/util/startup.lua Kim Alvefur <zash@zash.se> Tue, 12 Oct 2021 15:00:15 +0200 http://hg.omfa.de/prosody-hg/log/6425dfa3de45/util/startup.lua Kim Alvefur <zash@zash.se> Tue, 12 Oct 2021 14:59:18 +0200 http://hg.omfa.de/prosody-hg/log/0f786c4a2cb2/util/startup.lua Kim Alvefur <zash@zash.se> Tue, 12 Oct 2021 14:53:45 +0200 http://hg.omfa.de/prosody-hg/log/4fad0ca42f66/util/startup.lua
Makes it clearer that prosody does not take -v atm, as well as how
prosodyctl does not take the demonization flags.]]> Kim Alvefur <zash@zash.se> Thu, 30 Sep 2021 17:47:00 +0200 http://hg.omfa.de/prosody-hg/log/024ac556e907/util/startup.lua
More convenient than the environment variable.]]> Kim Alvefur <zash@zash.se> Thu, 30 Sep 2021 17:45:43 +0200 http://hg.omfa.de/prosody-hg/log/3bbb1af92514/util/startup.lua Matthew Wild <mwild1@gmail.com> Thu, 13 May 2021 11:17:13 +0100