1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
# LXMD {#module-services-lxmd}
[LXMF](https://github.com/markqvist/lxmf) daemon (`lxmd`).
This module runs `lxmd` as a systemd service with `DynamicUser = true` and
`StateDirectory = "lxmd"` directives.
## Quickstart {#module-services-lxmd-quickstart}
A minimal setup:
```nix
{
services.lxmd.enable = true;
}
```
With custom LXMD and RNSD settings:
```nix
{
services.lxmd = {
enable = true;
identityFile = "<path-to-lxmd-identity-file>";
settings = {
propagation-node = {
autopeer = true;
};
};
rnsd = {
identityFile = "<path-to-rnsd-identity-file>";
settings = {
reticulum = {
require_shared_instance = true;
is_shared_instance = true;
enable_transport = true;
instance_name = "default";
shared_instance_type = "unix";
};
};
};
};
}
```
At startup, settings provided through
[`services.lxmd.settings`](#opt-services.lxmd.settings),
[`services.lxmd.identityFile`](#opt-services.lxmd.identityFile), and
[`services.lxmd.rnsd.settings`](#opt-services.lxmd.rnsd.settings) are copied
into the service state directory.
## Health Check {#module-services-lxmd-health-check}
You can optionally wait for `lxmd` to become responsive during startup using
`lxmd --status`:
```nix
{
services.lxmd = {
enable = true;
healthCheck = {
enable = true;
intervalSeconds = 2;
timeoutSeconds = 120;
};
};
}
```
When enabled, startup fails if `lxmd --status` does not succeed before
[`services.lxmd.healthCheck.timeoutSeconds`](#opt-services.lxmd.healthCheck.timeoutSeconds).
## Communicating With RNSD {#module-services-lxmd-communication-with-rnsd}
Even though both services are hardened (via Systemd's `DynamicUser = true` and
`StateDirectory = "lxmd"` directives), `lxmd` can still communicate with `rnsd`
in several ways.
### Option 1: Shared Instance Over Unix RPC {#module-services-lxmd-communication-rpc}
Use a shared Reticulum instance exposed through a local Unix RPC socket:
```nix
{
services.rnsd = {
enable = true;
identityFile = "<path-to-rnsd-identity-file>";
settings = {
reticulum = {
enable_transport = true;
share_instance = true;
instance_name = "default";
shared_instance_type = "unix";
};
interfaces = {
auto = {
type = "AutoInterface";
enabled = true;
};
};
};
};
services.lxmd = {
enable = true;
identityFile = "<path-to-lxmd-identity-file>";
settings = {
# LXMD settings, run `lxmd --exampleconfig` for details
};
rnsd = {
identityFile = "<path-to-rnsd-identity-file>";
settings = {
reticulum = {
require_shared_instance = true;
is_shared_instance = true;
enable_transport = true;
instance_name = "default";
shared_instance_type = "unix";
};
};
};
};
}
```
In this model, `lxmd` points to an RNS configuration that joins the shared
instance. Both RNS transport identity files in `rnsd` and `lxmd` must be the
same. If you use different transport identity files, then set the same `rpc_key`
in both `rnsd` configurations to allow them to communicate securely.
It is also possible to use a shared instance over TCP, please refer to the
[Reticulum documentation](https://reticulum.network/manual/) for details.
### Option 2: Isolated Instances Connected Through BackboneInterface {#module-services-lxmd-communication-backbone}
Reticulum applications (`rnsd`, `lxmd`, and others) can be isolated by running:
- one primary `rnsd` service instance as a non-privileged service account,
- one instance per application, each with its own user and configuration,
- a `BackboneInterface` between each isolated application instance and the
primary instance.
On the primary `rnsd` instance, the `BackboneInterface` is configured to accept
connections from the isolated instances, as such:
```nix
{
services.rnsd = {
enable = true;
identityFile = "<path-to-rnsd-identity-file>";
settings = {
reticulum = {
# RNSD settings, run `rnsd --exampleconfig` for details
};
interfaces = {
root = {
type = "BackboneInterface";
enabled = true;
mode = "gateway";
discoverable = true;
listen_ip = "127.0.0.1";
listen_port = 4242;
};
};
};
};
}
```
Then, on each isolated application instance, the `BackboneInterface` is
configured to connect to the primary instance:
```nix
{
services.lxmd = {
enable = true;
identityFile = "<path-to-lxmd-identity-file>";
settings = {
# LXMD settings, run `lxmd --exampleconfig` for details
};
rnsd = {
identityFile = "<path-to-rnsd-identity-file>";
settings = {
reticulum = {
# RNSD settings, run `rnsd --exampleconfig` for details
};
interfaces = {
local = {
type = "BackboneInterface";
enabled = true;
target_host = "127.0.0.1";
target_port = 4242;
};
};
};
};
};
}
```
The primary `rnsd` instance serves system-local `BackboneInterface` links for
applications and external interfaces for the wider network. Each isolated app
uses its own RNS configuration directory (for example with
`--rnsconfig <path>`), and that local instance connects to the root instance
through `BackboneInterface`.
Running multiple instances increases memory usage and adds one extra hop, but
the performance impact is generally negligible.
|
