tjh.dev
nixos/manual: regenerate chapter xml files
apparently pandoc has changed behavior over the past releases, so the
files are no longer in sync. occasionally this requires edits
to the markdown source to not remove an anchor that was there
before (albeit wth a very questionable id), or where things were simply
being misrendered due to syntax errors.
+3
-3
nixos/modules/services/monitoring/parsedmarc.xml
+3
-3
nixos/modules/services/monitoring/parsedmarc.xml
···
15
15
email address and saves them to a local Elasticsearch instance
16
16
looks like this:
17
17
</para>
18
-
<programlisting>
18
+
<programlisting language="nix">
19
19
services.parsedmarc = {
20
20
enable = true;
21
21
settings.imap = {
···
44
44
email address that should be configured in the domain’s dmarc
45
45
policy is <literal>dmarc@monitoring.example.com</literal>.
46
46
</para>
47
-
<programlisting>
47
+
<programlisting language="nix">
48
48
services.parsedmarc = {
49
49
enable = true;
50
50
provision = {
···
67
67
Elasticsearch instance is automatically added as a Grafana
68
68
datasource, and the dashboard is added to Grafana as well.
69
69
</para>
70
-
<programlisting>
70
+
<programlisting language="nix">
71
71
services.parsedmarc = {
72
72
enable = true;
73
73
provision = {
+3
-3
nixos/modules/services/networking/mosquitto.xml
+3
-3
nixos/modules/services/networking/mosquitto.xml
···
9
9
<para>
10
10
A minimal configuration for Mosquitto is
11
11
</para>
12
-
<programlisting language="bash">
12
+
<programlisting language="nix">
13
13
services.mosquitto = {
14
14
enable = true;
15
15
listeners = [ {
···
31
31
restricted write access to a user <literal>service</literal> could
32
32
look like
33
33
</para>
34
-
<programlisting language="bash">
34
+
<programlisting language="nix">
35
35
services.mosquitto = {
36
36
enable = true;
37
37
listeners = [ {
···
52
52
TLS authentication is configured by setting TLS-related options of
53
53
the listener:
54
54
</para>
55
-
<programlisting language="bash">
55
+
<programlisting language="nix">
56
56
services.mosquitto = {
57
57
enable = true;
58
58
listeners = [ {
+6
-6
nixos/modules/services/search/meilisearch.md
+6
-6
nixos/modules/services/search/meilisearch.md
···
2
2
3
3
Meilisearch is a lightweight, fast and powerful search engine. Think elastic search with a much smaller footprint.
4
4
5
-
## Quickstart
5
+
## Quickstart {#module-services-meilisearch-quickstart}
6
6
7
7
the minimum to start meilisearch is
8
8
···
14
14
15
15
test with `curl -X GET 'http://localhost:7700/health'`
16
16
17
-
## Usage
17
+
## Usage {#module-services-meilisearch-usage}
18
18
19
19
you first need to add documents to an index before you can search for documents.
20
20
21
-
### Add a documents to the `movies` index
21
+
### Add a documents to the `movies` index {#module-services-meilisearch-quickstart-add}
22
22
23
23
`curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{"id": "123", "title": "Superman"}, {"id": 234, "title": "Batman"}]'`
24
24
25
-
### Search documents in the `movies` index
25
+
### Search documents in the `movies` index {#module-services-meilisearch-quickstart-search}
26
26
27
27
`curl 'http://127.0.0.1:7700/indexes/movies/search' --data '{ "q": "botman" }'` (note the typo is intentional and there to demonstrate the typo tolerant capabilities)
28
28
29
-
## Defaults
29
+
## Defaults {#module-services-meilisearch-defaults}
30
30
31
31
- The default nixos package doesn't come with the [dashboard](https://docs.meilisearch.com/learn/getting_started/quick_start.html#search), since the dashboard features makes some assets downloads at compile time.
32
32
···
34
34
35
35
- Default deployment is development mode. It doesn't require a secret master key. All routes are not protected and accessible.
36
36
37
-
## Missing
37
+
## Missing {#module-services-meilisearch-missing}
38
38
39
39
- the snapshot feature is not yet configurable from the module, it's just a matter of adding the relevant environment variables.
+7
-7
nixos/modules/services/search/meilisearch.xml
+7
-7
nixos/modules/services/search/meilisearch.xml
···
4
4
Meilisearch is a lightweight, fast and powerful search engine. Think
5
5
elastic search with a much smaller footprint.
6
6
</para>
7
-
<section xml:id="quickstart">
7
+
<section xml:id="module-services-meilisearch-quickstart">
8
8
<title>Quickstart</title>
9
9
<para>
10
10
the minimum to start meilisearch is
11
11
</para>
12
-
<programlisting language="bash">
12
+
<programlisting language="nix">
13
13
services.meilisearch.enable = true;
14
14
</programlisting>
15
15
<para>
···
21
21
<literal>curl -X GET 'http://localhost:7700/health'</literal>
22
22
</para>
23
23
</section>
24
-
<section xml:id="usage">
24
+
<section xml:id="module-services-meilisearch-usage">
25
25
<title>Usage</title>
26
26
<para>
27
27
you first need to add documents to an index before you can search
28
28
for documents.
29
29
</para>
30
-
<section xml:id="add-a-documents-to-the-movies-index">
30
+
<section xml:id="module-services-meilisearch-quickstart-add">
31
31
<title>Add a documents to the <literal>movies</literal>
32
32
index</title>
33
33
<para>
34
34
<literal>curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{"id": "123", "title": "Superman"}, {"id": 234, "title": "Batman"}]'</literal>
35
35
</para>
36
36
</section>
37
-
<section xml:id="search-documents-in-the-movies-index">
37
+
<section xml:id="module-services-meilisearch-quickstart-search">
38
38
<title>Search documents in the <literal>movies</literal>
39
39
index</title>
40
40
<para>
···
44
44
</para>
45
45
</section>
46
46
</section>
47
-
<section xml:id="defaults">
47
+
<section xml:id="module-services-meilisearch-defaults">
48
48
<title>Defaults</title>
49
49
<itemizedlist>
50
50
<listitem>
···
70
70
</listitem>
71
71
</itemizedlist>
72
72
</section>
73
-
<section xml:id="missing">
73
+
<section xml:id="module-services-meilisearch-missing">
74
74
<title>Missing</title>
75
75
<itemizedlist spacing="compact">
76
76
<listitem>
+1
nixos/modules/services/web-apps/pict-rs.md
+1
nixos/modules/services/web-apps/pict-rs.md
+14
-27
nixos/modules/services/web-apps/pict-rs.xml
+14
-27
nixos/modules/services/web-apps/pict-rs.xml
···
8
8
<para>
9
9
the minimum to start pict-rs is
10
10
</para>
11
-
<programlisting language="bash">
11
+
<programlisting language="nix">
12
12
services.pict-rs.enable = true;
13
13
</programlisting>
14
14
<para>
···
18
18
<section xml:id="module-services-pict-rs-usage">
19
19
<title>Usage</title>
20
20
<para>
21
-
pict-rs offers the following endpoints: -
22
-
<literal>POST /image</literal> for uploading an image. Uploaded
23
-
content must be valid multipart/form-data with an image array
24
-
located within the <literal>images[]</literal> key
21
+
pict-rs offers the following endpoints:
25
22
</para>
26
-
<programlisting>
27
-
This endpoint returns the following JSON structure on success with a 201 Created status
28
-
```json
29
-
{
30
-
"files": [
31
-
{
32
-
"delete_token": "JFvFhqJA98",
33
-
"file": "lkWZDRvugm.jpg"
34
-
},
35
-
{
36
-
"delete_token": "kAYy9nk2WK",
37
-
"file": "8qFS0QooAn.jpg"
38
-
},
39
-
{
40
-
"delete_token": "OxRpM3sf0Y",
41
-
"file": "1hJaYfGE01.jpg"
42
-
}
43
-
],
44
-
"msg": "ok"
45
-
}
46
-
```
47
-
</programlisting>
48
23
<itemizedlist>
24
+
<listitem>
25
+
<para>
26
+
<literal>POST /image</literal> for uploading an image.
27
+
Uploaded content must be valid multipart/form-data with an
28
+
image array located within the <literal>images[]</literal> key
29
+
</para>
30
+
<para>
31
+
This endpoint returns the following JSON structure on success
32
+
with a 201 Created status
33
+
<literal>json { "files": [ { "delete_token": "JFvFhqJA98", "file": "lkWZDRvugm.jpg" }, { "delete_token": "kAYy9nk2WK", "file": "8qFS0QooAn.jpg" }, { "delete_token": "OxRpM3sf0Y", "file": "1hJaYfGE01.jpg" } ], "msg": "ok" }</literal>
34
+
</para>
35
+
</listitem>
49
36
<listitem>
50
37
<para>
51
38
<literal>GET /image/download?url=...</literal> Download an
+1
-1
nixos/modules/system/boot/loader/external/external.md
+1
-1
nixos/modules/system/boot/loader/external/external.md
···
20
20
}
21
21
```
22
22
23
-
## Developing Custom Bootloader Backends
23
+
## Developing Custom Bootloader Backends {#sec-bootloader-external-developing}
24
24
25
25
Bootloaders should use [RFC-0125](https://github.com/NixOS/rfcs/pull/125)'s Bootspec format and synthesis tools to identify the key properties for bootable system generations.
26
26
+1
-1
nixos/modules/system/boot/loader/external/external.xml
+1
-1
nixos/modules/system/boot/loader/external/external.xml