···

       
15
       
 
       
      email address and saves them to a local Elasticsearch instance

     

       
16
       
 
       
      looks like this:

     

       
17
       
 
       
    </para>

     

       
18
       
-
       
    <programlisting>

     

       
19
       
 
       
services.parsedmarc = {

     

       
20
       
 
       
  enable = true;

     

       
21
       
 
       
  settings.imap = {

     
···

       
44
       
 
       
      email address that should be configured in the domain’s dmarc

     

       
45
       
 
       
      policy is <literal>dmarc@monitoring.example.com</literal>.

     

       
46
       
 
       
    </para>

     

       
47
       
-
       
    <programlisting>

     

       
48
       
 
       
services.parsedmarc = {

     

       
49
       
 
       
  enable = true;

     

       
50
       
 
       
  provision = {

     
···

       
67
       
 
       
      Elasticsearch instance is automatically added as a Grafana

     

       
68
       
 
       
      datasource, and the dashboard is added to Grafana as well.

     

       
69
       
 
       
    </para>

     

       
70
       
-
       
    <programlisting>

     

       
71
       
 
       
services.parsedmarc = {

     

       
72
       
 
       
  enable = true;

     

       
73
       
 
       
  provision = {

     

···

       
15
       
 
       
      email address and saves them to a local Elasticsearch instance

     

       
16
       
 
       
      looks like this:

     

       
17
       
 
       
    </para>

     

       
18
       
+
       
    <programlisting language="nix">

     

       
19
       
 
       
services.parsedmarc = {

     

       
20
       
 
       
  enable = true;

     

       
21
       
 
       
  settings.imap = {

     
···

       
44
       
 
       
      email address that should be configured in the domain’s dmarc

     

       
45
       
 
       
      policy is <literal>dmarc@monitoring.example.com</literal>.

     

       
46
       
 
       
    </para>

     

       
47
       
+
       
    <programlisting language="nix">

     

       
48
       
 
       
services.parsedmarc = {

     

       
49
       
 
       
  enable = true;

     

       
50
       
 
       
  provision = {

     
···

       
67
       
 
       
      Elasticsearch instance is automatically added as a Grafana

     

       
68
       
 
       
      datasource, and the dashboard is added to Grafana as well.

     

       
69
       
 
       
    </para>

     

       
70
       
+
       
    <programlisting language="nix">

     

       
71
       
 
       
services.parsedmarc = {

     

       
72
       
 
       
  enable = true;

     

       
73
       
 
       
  provision = {

     

···

       
9
       
 
       
    <para>

     

       
10
       
 
       
      A minimal configuration for Mosquitto is

     

       
11
       
 
       
    </para>

     

       
12
       
-
       
    <programlisting language="bash">

     

       
13
       
 
       
services.mosquitto = {

     

       
14
       
 
       
  enable = true;

     

       
15
       
 
       
  listeners = [ {

     
···

       
31
       
 
       
      restricted write access to a user <literal>service</literal> could

     

       
32
       
 
       
      look like

     

       
33
       
 
       
    </para>

     

       
34
       
-
       
    <programlisting language="bash">

     

       
35
       
 
       
services.mosquitto = {

     

       
36
       
 
       
  enable = true;

     

       
37
       
 
       
  listeners = [ {

     
···

       
52
       
 
       
      TLS authentication is configured by setting TLS-related options of

     

       
53
       
 
       
      the listener:

     

       
54
       
 
       
    </para>

     

       
55
       
-
       
    <programlisting language="bash">

     

       
56
       
 
       
services.mosquitto = {

     

       
57
       
 
       
  enable = true;

     

       
58
       
 
       
  listeners = [ {

     

···

       
9
       
 
       
    <para>

     

       
10
       
 
       
      A minimal configuration for Mosquitto is

     

       
11
       
 
       
    </para>

     

       
12
       
+
       
    <programlisting language="nix">

     

       
13
       
 
       
services.mosquitto = {

     

       
14
       
 
       
  enable = true;

     

       
15
       
 
       
  listeners = [ {

     
···

       
31
       
 
       
      restricted write access to a user <literal>service</literal> could

     

       
32
       
 
       
      look like

     

       
33
       
 
       
    </para>

     

       
34
       
+
       
    <programlisting language="nix">

     

       
35
       
 
       
services.mosquitto = {

     

       
36
       
 
       
  enable = true;

     

       
37
       
 
       
  listeners = [ {

     
···

       
52
       
 
       
      TLS authentication is configured by setting TLS-related options of

     

       
53
       
 
       
      the listener:

     

       
54
       
 
       
    </para>

     

       
55
       
+
       
    <programlisting language="nix">

     

       
56
       
 
       
services.mosquitto = {

     

       
57
       
 
       
  enable = true;

     

       
58
       
 
       
  listeners = [ {

     

···

       
2
       
 
       


     

       
3
       
 
       
Meilisearch is a lightweight, fast and powerful search engine. Think elastic search with a much smaller footprint.

     

       
4
       
 
       


     

       
5
       
-
       
## Quickstart

     

       
6
       
 
       


     

       
7
       
 
       
the minimum to start meilisearch is

     

       
8
       
 
       


     
···

       
14
       
 
       


     

       
15
       
 
       
test with `curl -X GET 'http://localhost:7700/health'`

     

       
16
       
 
       


     

       
17
       
-
       
## Usage

     

       
18
       
 
       


     

       
19
       
 
       
you first need to add documents to an index before you can search for documents.

     

       
20
       
 
       


     

       
21
       
-
       
### Add a documents to the `movies` index

     

       
22
       
 
       


     

       
23
       
 
       
`curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{"id": "123", "title": "Superman"}, {"id": 234, "title": "Batman"}]'`

     

       
24
       
 
       


     

       
25
       
-
       
### Search documents in the `movies` index

     

       
26
       
 
       


     

       
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
       
 
       


     

       
29
       
-
       
## Defaults

     

       
30
       
 
       


     

       
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
       
 
       


     
···

       
34
       
 
       


     

       
35
       
 
       
- Default deployment is development mode. It doesn't require a secret master key. All routes are not protected and accessible.

     

       
36
       
 
       


     

       
37
       
-
       
## Missing

     

       
38
       
 
       


     

       
39
       
 
       
- the snapshot feature is not yet configurable from the module, it's just a matter of adding the relevant environment variables.

     

···

       
2
       
 
       


     

       
3
       
 
       
Meilisearch is a lightweight, fast and powerful search engine. Think elastic search with a much smaller footprint.

     

       
4
       
 
       


     

       
5
       
+
       
## Quickstart {#module-services-meilisearch-quickstart}

     

       
6
       
 
       


     

       
7
       
 
       
the minimum to start meilisearch is

     

       
8
       
 
       


     
···

       
14
       
 
       


     

       
15
       
 
       
test with `curl -X GET 'http://localhost:7700/health'`

     

       
16
       
 
       


     

       
17
       
+
       
## Usage {#module-services-meilisearch-usage}

     

       
18
       
 
       


     

       
19
       
 
       
you first need to add documents to an index before you can search for documents.

     

       
20
       
 
       


     

       
21
       
+
       
### Add a documents to the `movies` index {#module-services-meilisearch-quickstart-add}

     

       
22
       
 
       


     

       
23
       
 
       
`curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{"id": "123", "title": "Superman"}, {"id": 234, "title": "Batman"}]'`

     

       
24
       
 
       


     

       
25
       
+
       
### Search documents in the `movies` index {#module-services-meilisearch-quickstart-search}

     

       
26
       
 
       


     

       
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
       
 
       


     

       
29
       
+
       
## Defaults {#module-services-meilisearch-defaults}

     

       
30
       
 
       


     

       
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
       
 
       


     
···

       
34
       
 
       


     

       
35
       
 
       
- Default deployment is development mode. It doesn't require a secret master key. All routes are not protected and accessible.

     

       
36
       
 
       


     

       
37
       
+
       
## Missing {#module-services-meilisearch-missing}

     

       
38
       
 
       


     

       
39
       
 
       
- the snapshot feature is not yet configurable from the module, it's just a matter of adding the relevant environment variables.

     

···

       
4
       
 
       
    Meilisearch is a lightweight, fast and powerful search engine. Think

     

       
5
       
 
       
    elastic search with a much smaller footprint.

     

       
6
       
 
       
  </para>

     

       
7
       
-
       
  <section xml:id="quickstart">

     

       
8
       
 
       
    <title>Quickstart</title>

     

       
9
       
 
       
    <para>

     

       
10
       
 
       
      the minimum to start meilisearch is

     

       
11
       
 
       
    </para>

     

       
12
       
-
       
    <programlisting language="bash">

     

       
13
       
 
       
services.meilisearch.enable = true;

     

       
14
       
 
       
</programlisting>

     

       
15
       
 
       
    <para>

     
···

       
21
       
 
       
      <literal>curl -X GET 'http://localhost:7700/health'</literal>

     

       
22
       
 
       
    </para>

     

       
23
       
 
       
  </section>

     

       
24
       
-
       
  <section xml:id="usage">

     

       
25
       
 
       
    <title>Usage</title>

     

       
26
       
 
       
    <para>

     

       
27
       
 
       
      you first need to add documents to an index before you can search

     

       
28
       
 
       
      for documents.

     

       
29
       
 
       
    </para>

     

       
30
       
-
       
    <section xml:id="add-a-documents-to-the-movies-index">

     

       
31
       
 
       
      <title>Add a documents to the <literal>movies</literal>

     

       
32
       
 
       
      index</title>

     

       
33
       
 
       
      <para>

     

       
34
       
 
       
        <literal>curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{&quot;id&quot;: &quot;123&quot;, &quot;title&quot;: &quot;Superman&quot;}, {&quot;id&quot;: 234, &quot;title&quot;: &quot;Batman&quot;}]'</literal>

     

       
35
       
 
       
      </para>

     

       
36
       
 
       
    </section>

     

       
37
       
-
       
    <section xml:id="search-documents-in-the-movies-index">

     

       
38
       
 
       
      <title>Search documents in the <literal>movies</literal>

     

       
39
       
 
       
      index</title>

     

       
40
       
 
       
      <para>

     
···

       
44
       
 
       
      </para>

     

       
45
       
 
       
    </section>

     

       
46
       
 
       
  </section>

     

       
47
       
-
       
  <section xml:id="defaults">

     

       
48
       
 
       
    <title>Defaults</title>

     

       
49
       
 
       
    <itemizedlist>

     

       
50
       
 
       
      <listitem>

     
···

       
70
       
 
       
      </listitem>

     

       
71
       
 
       
    </itemizedlist>

     

       
72
       
 
       
  </section>

     

       
73
       
-
       
  <section xml:id="missing">

     

       
74
       
 
       
    <title>Missing</title>

     

       
75
       
 
       
    <itemizedlist spacing="compact">

     

       
76
       
 
       
      <listitem>

     

···

       
4
       
 
       
    Meilisearch is a lightweight, fast and powerful search engine. Think

     

       
5
       
 
       
    elastic search with a much smaller footprint.

     

       
6
       
 
       
  </para>

     

       
7
       
+
       
  <section xml:id="module-services-meilisearch-quickstart">

     

       
8
       
 
       
    <title>Quickstart</title>

     

       
9
       
 
       
    <para>

     

       
10
       
 
       
      the minimum to start meilisearch is

     

       
11
       
 
       
    </para>

     

       
12
       
+
       
    <programlisting language="nix">

     

       
13
       
 
       
services.meilisearch.enable = true;

     

       
14
       
 
       
</programlisting>

     

       
15
       
 
       
    <para>

     
···

       
21
       
 
       
      <literal>curl -X GET 'http://localhost:7700/health'</literal>

     

       
22
       
 
       
    </para>

     

       
23
       
 
       
  </section>

     

       
24
       
+
       
  <section xml:id="module-services-meilisearch-usage">

     

       
25
       
 
       
    <title>Usage</title>

     

       
26
       
 
       
    <para>

     

       
27
       
 
       
      you first need to add documents to an index before you can search

     

       
28
       
 
       
      for documents.

     

       
29
       
 
       
    </para>

     

       
30
       
+
       
    <section xml:id="module-services-meilisearch-quickstart-add">

     

       
31
       
 
       
      <title>Add a documents to the <literal>movies</literal>

     

       
32
       
 
       
      index</title>

     

       
33
       
 
       
      <para>

     

       
34
       
 
       
        <literal>curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{&quot;id&quot;: &quot;123&quot;, &quot;title&quot;: &quot;Superman&quot;}, {&quot;id&quot;: 234, &quot;title&quot;: &quot;Batman&quot;}]'</literal>

     

       
35
       
 
       
      </para>

     

       
36
       
 
       
    </section>

     

       
37
       
+
       
    <section xml:id="module-services-meilisearch-quickstart-search">

     

       
38
       
 
       
      <title>Search documents in the <literal>movies</literal>

     

       
39
       
 
       
      index</title>

     

       
40
       
 
       
      <para>

     
···

       
44
       
 
       
      </para>

     

       
45
       
 
       
    </section>

     

       
46
       
 
       
  </section>

     

       
47
       
+
       
  <section xml:id="module-services-meilisearch-defaults">

     

       
48
       
 
       
    <title>Defaults</title>

     

       
49
       
 
       
    <itemizedlist>

     

       
50
       
 
       
      <listitem>

     
···

       
70
       
 
       
      </listitem>

     

       
71
       
 
       
    </itemizedlist>

     

       
72
       
 
       
  </section>

     

       
73
       
+
       
  <section xml:id="module-services-meilisearch-missing">

     

       
74
       
 
       
    <title>Missing</title>

     

       
75
       
 
       
    <itemizedlist spacing="compact">

     

       
76
       
 
       
      <listitem>

     

···

       
15
       
 
       
## Usage {#module-services-pict-rs-usage}

     

       
16
       
 
       


     

       
17
       
 
       
pict-rs offers the following endpoints:

     

       
0
       
 
       

     

       
18
       
 
       
- `POST /image` for uploading an image. Uploaded content must be valid multipart/form-data with an

     

       
19
       
 
       
    image array located within the `images[]` key

     

       
20
       
 
       


     

···

       
15
       
 
       
## Usage {#module-services-pict-rs-usage}

     

       
16
       
 
       


     

       
17
       
 
       
pict-rs offers the following endpoints:

     

       
18
       
+
       


     

       
19
       
 
       
- `POST /image` for uploading an image. Uploaded content must be valid multipart/form-data with an

     

       
20
       
 
       
    image array located within the `images[]` key

     

       
21
       
 
       


     

···

       
8
       
 
       
    <para>

     

       
9
       
 
       
      the minimum to start pict-rs is

     

       
10
       
 
       
    </para>

     

       
11
       
-
       
    <programlisting language="bash">

     

       
12
       
 
       
services.pict-rs.enable = true;

     

       
13
       
 
       
</programlisting>

     

       
14
       
 
       
    <para>

     
···

       
18
       
 
       
  <section xml:id="module-services-pict-rs-usage">

     

       
19
       
 
       
    <title>Usage</title>

     

       
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

     

       
25
       
 
       
    </para>

     

       
26
       
-
       
    <programlisting>

     

       
27
       
-
       
This endpoint returns the following JSON structure on success with a 201 Created status

     

       
28
       
-
       
```json

     

       
29
       
-
       
{

     

       
30
       
-
       
    &quot;files&quot;: [

     

       
31
       
-
       
        {

     

       
32
       
-
       
            &quot;delete_token&quot;: &quot;JFvFhqJA98&quot;,

     

       
33
       
-
       
            &quot;file&quot;: &quot;lkWZDRvugm.jpg&quot;

     

       
34
       
-
       
        },

     

       
35
       
-
       
        {

     

       
36
       
-
       
            &quot;delete_token&quot;: &quot;kAYy9nk2WK&quot;,

     

       
37
       
-
       
            &quot;file&quot;: &quot;8qFS0QooAn.jpg&quot;

     

       
38
       
-
       
        },

     

       
39
       
-
       
        {

     

       
40
       
-
       
            &quot;delete_token&quot;: &quot;OxRpM3sf0Y&quot;,

     

       
41
       
-
       
            &quot;file&quot;: &quot;1hJaYfGE01.jpg&quot;

     

       
42
       
-
       
        }

     

       
43
       
-
       
    ],

     

       
44
       
-
       
    &quot;msg&quot;: &quot;ok&quot;

     

       
45
       
-
       
}

     

       
46
       
-
       
```

     

       
47
       
-
       
</programlisting>

     

       
48
       
 
       
    <itemizedlist>

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
49
       
 
       
      <listitem>

     

       
50
       
 
       
        <para>

     

       
51
       
 
       
          <literal>GET /image/download?url=...</literal> Download an

     

···

       
8
       
 
       
    <para>

     

       
9
       
 
       
      the minimum to start pict-rs is

     

       
10
       
 
       
    </para>

     

       
11
       
+
       
    <programlisting language="nix">

     

       
12
       
 
       
services.pict-rs.enable = true;

     

       
13
       
 
       
</programlisting>

     

       
14
       
 
       
    <para>

     
···

       
18
       
 
       
  <section xml:id="module-services-pict-rs-usage">

     

       
19
       
 
       
    <title>Usage</title>

     

       
20
       
 
       
    <para>

     

       
21
       
+
       
      pict-rs offers the following endpoints:

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
22
       
 
       
    </para>

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
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   {       &quot;files&quot;: [           {               &quot;delete_token&quot;: &quot;JFvFhqJA98&quot;,               &quot;file&quot;: &quot;lkWZDRvugm.jpg&quot;           },           {               &quot;delete_token&quot;: &quot;kAYy9nk2WK&quot;,               &quot;file&quot;: &quot;8qFS0QooAn.jpg&quot;           },           {               &quot;delete_token&quot;: &quot;OxRpM3sf0Y&quot;,               &quot;file&quot;: &quot;1hJaYfGE01.jpg&quot;           }       ],       &quot;msg&quot;: &quot;ok&quot;   }</literal>

     

       
34
       
+
       
        </para>

     

       
35
       
+
       
      </listitem>

     

       
36
       
 
       
      <listitem>

     

       
37
       
 
       
        <para>

     

       
38
       
 
       
          <literal>GET /image/download?url=...</literal> Download an

     

···

       
20
       
 
       
}

     

       
21
       
 
       
```

     

       
22
       
 
       


     

       
23
       
-
       
## Developing Custom Bootloader Backends

     

       
24
       
 
       


     

       
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
       
 
       


     

···

       
20
       
 
       
}

     

       
21
       
 
       
```

     

       
22
       
 
       


     

       
23
       
+
       
## Developing Custom Bootloader Backends {#sec-bootloader-external-developing}

     

       
24
       
 
       


     

       
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
       
 
       


     

···

       
29
       
 
       
  };

     

       
30
       
 
       
}

     

       
31
       
 
       
</programlisting>

     

       
32
       
-
       
  <section xml:id="developing-custom-bootloader-backends">

     

       
33
       
 
       
    <title>Developing Custom Bootloader Backends</title>

     

       
34
       
 
       
    <para>

     

       
35
       
 
       
      Bootloaders should use

     

···

       
29
       
 
       
  };

     

       
30
       
 
       
}

     

       
31
       
 
       
</programlisting>

     

       
32
       
+
       
  <section xml:id="sec-bootloader-external-developing">

     

       
33
       
 
       
    <title>Developing Custom Bootloader Backends</title>

     

       
34
       
 
       
    <para>

     

       
35
       
 
       
      Bootloaders should use