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

   1 # Plausible {#module-services-plausible}
   2
   3 [Plausible](https://plausible.io/) is a privacy-friendly alternative to
   4 Google analytics.
   5
   6 ## Basic Usage {#module-services-plausible-basic-usage}
   7
   8 At first, a secret key is needed to be generated. This can be done with e.g.
   9 ```ShellSession
  10 $ openssl rand -base64 64
  11 ```
  12
  13 After that, `plausible` can be deployed like this:
  14 ```nix
  15 {
  16   services.plausible = {
  17     enable = true;
  18     adminUser = {
  19       # activate is used to skip the email verification of the admin-user that's
  20       # automatically created by plausible. This is only supported if
  21       # postgresql is configured by the module. This is done by default, but
  22       # can be turned off with services.plausible.database.postgres.setup.
  23       activate = true;
  24       email = "admin@localhost";
  25       passwordFile = "/run/secrets/plausible-admin-pwd";
  26     };
  27     server = {
  28       baseUrl = "http://analytics.example.org";
  29       # secretKeybaseFile is a path to the file which contains the secret generated
  30       # with openssl as described above.
  31       secretKeybaseFile = "/run/secrets/plausible-secret-key-base";
  32     };
  33   };
  34 }
  35 ```