Skip to content

Commit 93db8eb

Browse files
committed
doc: mention gromox.cfg:istore_standalone
1 parent d403c8a commit 93db8eb

File tree

3 files changed

+29
-6
lines changed

3 files changed

+29
-6
lines changed

doc/exmdb_provider.4gx

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,19 @@
44
.SH Name
55
exmdb_provider \(em Gromox Information Store
66
.SH Description
7-
exmdb_provider is a component for http(8gx). It offers a plethora of
8-
low-level functions (124 of them) for operating on mailbox stores. This
9-
functionality is also exposed by way of a Gromox-specific network protocol on
10-
port 5000. The aforementioned RPC functions transparently operate over the
11-
network and may connect to a remote exmdb instance. In other words, this component contains
12-
a process-local function API, a network client, and a network server.
7+
exmdb_provider is the mailbox engine. It offers a plethora of stateless
8+
low-level functions (124 of them) for operating on mailbox stores. The
9+
functionality of the engine is exposed by way of a Gromox-specific network
10+
protocol on port 5000.
11+
.PP
12+
exmdb_provider is built as a shared library and can run in either the http(8gx)
13+
or istore(8gx) processes, depending on the gromox.cfg:istore_standalone config
14+
directive.
15+
.PP
16+
The shared library contributes an exmdb_client API, which will transparently
17+
pick either a local or a remote procedure call depending on whether the mailbox
18+
is served by the same process or not.
19+
.PP
1320
.SH Configuration directives (gromox.cfg)
1421
The following directives are recognized when they appear in
1522
/etc/gromox/gromox.cfg.

doc/http.8gx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,14 @@ custom header to convey the actual client address, Gromox can pick this up for
7575
its own reporting, which in turn is useful for e.g. fail2ban setups.
7676
.br
7777
Default: (empty)
78+
.TP
79+
\fBistore_standalone\fP
80+
This directive serves as a mutual exclusion device between http(8gx) and
81+
istore(8gx) and controls which one of the two is in charge of running the
82+
mailbox engine. If this is set to no, http will be the one and istore(8gx) has
83+
no function.
84+
.br
85+
Default: \fIno\fP
7886
.SH Configuration directives (http.cfg)
7987
The following directives are recognized when reading from /etc/gromox/http.cfg,
8088
or when the \fB\-c\fP option is used to specify a custom file:

doc/istore.8gx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,14 @@ Maximum verbosity of logging. 1=crit, 2=error, 3=warn, 4=notice, 5=info, 6=debug
6363
.br
6464
Default: \fI4\fP (notice)
6565
.TP
66+
\fBistore_standalone\fP
67+
This directive serves as a mutual exclusion device between http(8gx) and
68+
istore(8gx) and controls which one of the two will execute the mailbox engine.
69+
If and only if this is set to yes will istore be able to startup, while http
70+
will disable the engine on its startup.
71+
.br
72+
Default: \fIno\fP
73+
.TP
6674
\fBrunning_identity\fP
6775
An unprivileged user account to switch the process to after startup.
6876
To inhibit the switch, assign the empty value.

0 commit comments

Comments
 (0)