istore(8gx)

📦 version 3.6, in alpine 3.24

NAME

Okay bestie, this is istore(8gx) 💅 — the Gromox Information Store launcher, straight from the Gromox admin reference. She is literally the main character who launches the Information Store, and we love her for it. ✨

SYNOPSIS

/usr/libexec/gromox/istore [-c config]

DESCRIPTION

So here’s the tea ☕: the Gromox Information Store, exmdb_provider(4gx), is built as a shared object. That means it can either be loaded by gromox-http(8) or run in a separate process — and that separate process is gromox-istore. The benefit of the separate process is improved debuggability. No cap, that’s the whole point. 🔥

OPTIONS 💅

-c config — Read configuration directives from the given file. If this option is not specified, /etc/gromox/gromox.cfg will be read if it exists. So yeah, she checks for that file automatically when you don’t point her somewhere else. Lowkey convenient, periodt. 🫶

🎀 CONFIGURATION DIRECTIVES (gromox.cfg) 🎀

The following directives are recognized when reading from /etc/gromox/gromox.cfg, or when the -c option is used to specify a custom file:

config_file_path — Colon-separated list of directories which will be scanned when locating further configuration files, especially those used by subcomponent instances. For example, mysql_adaptor(4gx) would be directed to look at /etc/gromox/istore/mysql_adaptor.cfg before /etc/gromox/mysql_adaptor.cfg. Default: /etc/gromox/istore:/etc/gromox.
daemons_fd_limit — In gromox-istore, this is treated as an alias for istore_fd_limit. Slay, same energy, different name. 💅
data_file_path — Colon-separated list of directories which will be scanned when locating data files. Default: /usr/share/gromox/istore:/usr/share/gromox.
host_id — A unique identifier for this system. It is used for the Server HTTP responses header, for components like exmdb_provider(4gx), which makes use of it for SMTP HELO lines, for DSN report texts, for MIDB database/EML cache. The identifier should only use characters allowed for hostnames. Default: (system hostname).
istore_fd_limit — Request that the file descriptor table be at least this large. The magic value 0 indicates that the system default hard limit (rlim_max, cf. setrlimit(2)) should be used. Default: 0.
istore_log_file — Target for log messages here. Special values: "-" (stderr/syslog depending on parent PID) or "syslog" are recognized. Default: - (auto).
istore_log_level — Maximum verbosity of logging. 1=crit, 2=error, 3=warn, 4=notice, 5=info, 6=debug. Default: 4 (notice).
istore_standalone — This directive serves as a mutual exclusion device between http(8gx) and istore(8gx) and controls which one of the two will execute the mailbox engine. If and only if this is set to yes will istore be able to startup, while http will disable the engine on its startup. Default: no.

Bestie, the if and only if in istore_standalone is doing serious heavy lifting — do not sleep on it. 👑

running_identity — An unprivileged user account to switch the process to after startup. To inhibit the switch, assign the empty value. Default: gromox.

SIGNALS 🦋

Upon receipt of SIGHUP, configuration files are re-read, but only a few select directives can be changed this way, as many parts do not implement reload. So like, don’t expect every directive to glow up on reload — some are just not built for that. 😭