From dc7788efb8bcbe68d1183cf7ee281186315802ca Mon Sep 17 00:00:00 2001 From: pennae Date: Thu, 5 Jan 2023 05:50:12 +0100 Subject: [PATCH] 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. --- .../services/monitoring/parsedmarc.xml | 6 +-- .../modules/services/networking/mosquitto.xml | 6 +-- nixos/modules/services/search/meilisearch.md | 12 +++--- nixos/modules/services/search/meilisearch.xml | 14 +++---- nixos/modules/services/web-apps/pict-rs.md | 1 + nixos/modules/services/web-apps/pict-rs.xml | 41 +++++++------------ .../system/boot/loader/external/external.md | 2 +- .../system/boot/loader/external/external.xml | 2 +- 8 files changed, 36 insertions(+), 48 deletions(-) diff --git a/nixos/modules/services/monitoring/parsedmarc.xml b/nixos/modules/services/monitoring/parsedmarc.xml index b6a4bcf8ff5a..2db5f48d1609 100644 --- a/nixos/modules/services/monitoring/parsedmarc.xml +++ b/nixos/modules/services/monitoring/parsedmarc.xml @@ -15,7 +15,7 @@ email address and saves them to a local Elasticsearch instance looks like this: - + services.parsedmarc = { enable = true; settings.imap = { @@ -44,7 +44,7 @@ services.parsedmarc = { email address that should be configured in the domain’s dmarc policy is dmarc@monitoring.example.com. - + services.parsedmarc = { enable = true; provision = { @@ -67,7 +67,7 @@ services.parsedmarc = { Elasticsearch instance is automatically added as a Grafana datasource, and the dashboard is added to Grafana as well. - + services.parsedmarc = { enable = true; provision = { diff --git a/nixos/modules/services/networking/mosquitto.xml b/nixos/modules/services/networking/mosquitto.xml index d16ab28c0269..17dc85700f81 100644 --- a/nixos/modules/services/networking/mosquitto.xml +++ b/nixos/modules/services/networking/mosquitto.xml @@ -9,7 +9,7 @@ A minimal configuration for Mosquitto is - + services.mosquitto = { enable = true; listeners = [ { @@ -31,7 +31,7 @@ services.mosquitto = { restricted write access to a user service could look like - + services.mosquitto = { enable = true; listeners = [ { @@ -52,7 +52,7 @@ services.mosquitto = { TLS authentication is configured by setting TLS-related options of the listener: - + services.mosquitto = { enable = true; listeners = [ { diff --git a/nixos/modules/services/search/meilisearch.md b/nixos/modules/services/search/meilisearch.md index 98e7c542cb9a..98af396117c8 100644 --- a/nixos/modules/services/search/meilisearch.md +++ b/nixos/modules/services/search/meilisearch.md @@ -2,7 +2,7 @@ Meilisearch is a lightweight, fast and powerful search engine. Think elastic search with a much smaller footprint. -## Quickstart +## Quickstart {#module-services-meilisearch-quickstart} the minimum to start meilisearch is @@ -14,19 +14,19 @@ this will start the http server included with meilisearch on port 7700. test with `curl -X GET 'http://localhost:7700/health'` -## Usage +## Usage {#module-services-meilisearch-usage} you first need to add documents to an index before you can search for documents. -### Add a documents to the `movies` index +### Add a documents to the `movies` index {#module-services-meilisearch-quickstart-add} `curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{"id": "123", "title": "Superman"}, {"id": 234, "title": "Batman"}]'` -### Search documents in the `movies` index +### Search documents in the `movies` index {#module-services-meilisearch-quickstart-search} `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) -## Defaults +## Defaults {#module-services-meilisearch-defaults} - 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. @@ -34,6 +34,6 @@ you first need to add documents to an index before you can search for documents. - Default deployment is development mode. It doesn't require a secret master key. All routes are not protected and accessible. -## Missing +## Missing {#module-services-meilisearch-missing} - the snapshot feature is not yet configurable from the module, it's just a matter of adding the relevant environment variables. diff --git a/nixos/modules/services/search/meilisearch.xml b/nixos/modules/services/search/meilisearch.xml index c1a73f358c28..c222c042562c 100644 --- a/nixos/modules/services/search/meilisearch.xml +++ b/nixos/modules/services/search/meilisearch.xml @@ -4,12 +4,12 @@ Meilisearch is a lightweight, fast and powerful search engine. Think elastic search with a much smaller footprint. -
+
Quickstart the minimum to start meilisearch is - + services.meilisearch.enable = true; @@ -21,20 +21,20 @@ services.meilisearch.enable = true; curl -X GET 'http://localhost:7700/health'
-
+
Usage you first need to add documents to an index before you can search for documents. -
+
Add a documents to the <literal>movies</literal> index curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{"id": "123", "title": "Superman"}, {"id": 234, "title": "Batman"}]'
-
+
Search documents in the <literal>movies</literal> index @@ -44,7 +44,7 @@ services.meilisearch.enable = true;
-
+
Defaults @@ -70,7 +70,7 @@ services.meilisearch.enable = true;
-
+
Missing diff --git a/nixos/modules/services/web-apps/pict-rs.md b/nixos/modules/services/web-apps/pict-rs.md index 4b622049909d..2fa6bb3aebce 100644 --- a/nixos/modules/services/web-apps/pict-rs.md +++ b/nixos/modules/services/web-apps/pict-rs.md @@ -15,6 +15,7 @@ this will start the http server on port 8080 by default. ## Usage {#module-services-pict-rs-usage} pict-rs offers the following endpoints: + - `POST /image` for uploading an image. Uploaded content must be valid multipart/form-data with an image array located within the `images[]` key diff --git a/nixos/modules/services/web-apps/pict-rs.xml b/nixos/modules/services/web-apps/pict-rs.xml index bf129f5cc2ac..6cae82e01eca 100644 --- a/nixos/modules/services/web-apps/pict-rs.xml +++ b/nixos/modules/services/web-apps/pict-rs.xml @@ -8,7 +8,7 @@ the minimum to start pict-rs is - + services.pict-rs.enable = true; @@ -18,34 +18,21 @@ services.pict-rs.enable = true;
Usage - pict-rs offers the following endpoints: - - POST /image for uploading an image. Uploaded - content must be valid multipart/form-data with an image array - located within the images[] key + pict-rs offers the following endpoints: - -This endpoint returns the following JSON structure on success with a 201 Created status -```json -{ - "files": [ - { - "delete_token": "JFvFhqJA98", - "file": "lkWZDRvugm.jpg" - }, - { - "delete_token": "kAYy9nk2WK", - "file": "8qFS0QooAn.jpg" - }, - { - "delete_token": "OxRpM3sf0Y", - "file": "1hJaYfGE01.jpg" - } - ], - "msg": "ok" -} -``` - + + + POST /image for uploading an image. + Uploaded content must be valid multipart/form-data with an + image array located within the images[] key + + + This endpoint returns the following JSON structure on success + with a 201 Created status + json { "files": [ { "delete_token": "JFvFhqJA98", "file": "lkWZDRvugm.jpg" }, { "delete_token": "kAYy9nk2WK", "file": "8qFS0QooAn.jpg" }, { "delete_token": "OxRpM3sf0Y", "file": "1hJaYfGE01.jpg" } ], "msg": "ok" } + + GET /image/download?url=... Download an diff --git a/nixos/modules/system/boot/loader/external/external.md b/nixos/modules/system/boot/loader/external/external.md index ba1dfd4d9b9a..4f5b559dfc40 100644 --- a/nixos/modules/system/boot/loader/external/external.md +++ b/nixos/modules/system/boot/loader/external/external.md @@ -20,7 +20,7 @@ You can enable FooBoot like this: } ``` -## Developing Custom Bootloader Backends +## Developing Custom Bootloader Backends {#sec-bootloader-external-developing} 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. diff --git a/nixos/modules/system/boot/loader/external/external.xml b/nixos/modules/system/boot/loader/external/external.xml index 39ab2156bc8c..08a0b56e5b2c 100644 --- a/nixos/modules/system/boot/loader/external/external.xml +++ b/nixos/modules/system/boot/loader/external/external.xml @@ -29,7 +29,7 @@ }; } -
+
Developing Custom Bootloader Backends Bootloaders should use