nixos/modules/services/search/meilisearch.xml

   1 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-meilisearch">
   2   <title>Meilisearch</title>
   3   <para>
   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>
  16       this will start the http server included with meilisearch on port
  17       7700.
  18     </para>
  19     <para>
  20       test with
  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>
  41         <literal>curl 'http://127.0.0.1:7700/indexes/movies/search' --data '{ &quot;q&quot;: &quot;botman&quot; }'</literal>
  42         (note the typo is intentional and there to demonstrate the typo
  43         tolerant capabilities)
  44       </para>
  45     </section>
  46   </section>
  47   <section xml:id="defaults">
  48     <title>Defaults</title>
  49     <itemizedlist>
  50       <listitem>
  51         <para>
  52           The default nixos package doesn’t come with the
  53           <link xlink:href="https://docs.meilisearch.com/learn/getting_started/quick_start.html#search">dashboard</link>,
  54           since the dashboard features makes some assets downloads at
  55           compile time.
  56         </para>
  57       </listitem>
  58       <listitem>
  59         <para>
  60           Anonimized Analytics sent to meilisearch are disabled by
  61           default.
  62         </para>
  63       </listitem>
  64       <listitem>
  65         <para>
  66           Default deployment is development mode. It doesn’t require a
  67           secret master key. All routes are not protected and
  68           accessible.
  69         </para>
  70       </listitem>
  71     </itemizedlist>
  72   </section>
  73   <section xml:id="missing">
  74     <title>Missing</title>
  75     <itemizedlist spacing="compact">
  76       <listitem>
  77         <para>
  78           the snapshot feature is not yet configurable from the module,
  79           it’s just a matter of adding the relevant environment
  80           variables.
  81         </para>
  82       </listitem>
  83     </itemizedlist>
  84   </section>
  85 </chapter>