nixos/modules/services/search/meilisearch.md

   1 # Meilisearch {#module-services-meilisearch}
   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
   9 ```nix
  10 {
  11   services.meilisearch.enable = true;
  12 }
  13 ```
  14
  15 this will start the http server included with meilisearch on port 7700.
  16
  17 test with `curl -X GET 'http://localhost:7700/health'`
  18
  19 ## Usage {#module-services-meilisearch-usage}
  20
  21 you first need to add documents to an index before you can search for documents.
  22
  23 ### Add a documents to the `movies` index {#module-services-meilisearch-quickstart-add}
  24
  25 `curl -X POST 'http://127.0.0.1:7700/indexes/movies/documents' --data '[{"id": "123", "title": "Superman"}, {"id": 234, "title": "Batman"}]'`
  26
  27 ### Search documents in the `movies` index {#module-services-meilisearch-quickstart-search}
  28
  29 `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)
  30
  31 ## Defaults {#module-services-meilisearch-defaults}
  32
  33 - 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
  35 - Anonymized Analytics sent to meilisearch are disabled by default.
  36
  37 - Default deployment is development mode. It doesn't require a secret master key. All routes are not protected and accessible.
  38
  39 ## Missing {#module-services-meilisearch-missing}
  40
  41 - the snapshot feature is not yet configurable from the module, it's just a matter of adding the relevant environment variables.