nixos/modules/services/web-apps/plausible.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-plausible">
  <title>Plausible</title>
  <para>
    <link xlink:href="https://plausible.io/">Plausible</link> is a
    privacy-friendly alternative to Google analytics.
  </para>
  <section xml:id="module-services-plausible-basic-usage">
    <title>Basic Usage</title>
    <para>
      At first, a secret key is needed to be generated. This can be done
      with e.g.
    </para>
    <programlisting>
$ openssl rand -base64 64
</programlisting>
    <para>
      After that, <literal>plausible</literal> can be deployed like
      this:
    </para>
    <programlisting>
{
  services.plausible = {
    enable = true;
    adminUser = {
      # activate is used to skip the email verification of the admin-user that's
      # automatically created by plausible. This is only supported if
      # postgresql is configured by the module. This is done by default, but
      # can be turned off with services.plausible.database.postgres.setup.
      activate = true;
      email = &quot;admin@localhost&quot;;
      passwordFile = &quot;/run/secrets/plausible-admin-pwd&quot;;
    };
    server = {
      baseUrl = &quot;http://analytics.example.org&quot;;
      # secretKeybaseFile is a path to the file which contains the secret generated
      # with openssl as described above.
      secretKeybaseFile = &quot;/run/secrets/plausible-secret-key-base&quot;;
    };
  };
}
</programlisting>
  </section>
</chapter>