summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/web-apps/plausible.xml
diff options
context:
space:
mode:
Diffstat (limited to 'nixos/modules/services/web-apps/plausible.xml')
-rw-r--r--nixos/modules/services/web-apps/plausible.xml78
1 files changed, 36 insertions, 42 deletions
diff --git a/nixos/modules/services/web-apps/plausible.xml b/nixos/modules/services/web-apps/plausible.xml
index 92a571b9fbdb..39ff004ffd95 100644
--- a/nixos/modules/services/web-apps/plausible.xml
+++ b/nixos/modules/services/web-apps/plausible.xml
@@ -1,51 +1,45 @@
-<chapter xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- version="5.0"
- 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>
+<!-- Do not edit this file directly, edit its companion .md instead
+ and regenerate this file using nixos/doc/manual/md-to-db.sh -->
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-plausible">
+ <title>Plausible</title>
<para>
- At first, a secret key is needed to be generated. This can be done with e.g.
- <screen><prompt>$ </prompt>openssl rand -base64 64</screen>
+ <link xlink:href="https://plausible.io/">Plausible</link> is a
+ privacy-friendly alternative to Google analytics.
</para>
- <para>
- After that, <package>plausible</package> can be deployed like this:
-<programlisting>{
+ <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 = {
- <link linkend="opt-services.plausible.enable">enable</link> = true;
+ enable = true;
adminUser = {
- <link linkend="opt-services.plausible.adminUser.activate">activate</link> = true; <co xml:id='ex-plausible-cfg-activate' />
- <link linkend="opt-services.plausible.adminUser.email">email</link> = "admin@localhost";
- <link linkend="opt-services.plausible.adminUser.passwordFile">passwordFile</link> = "/run/secrets/plausible-admin-pwd";
+ # 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 = {
- <link linkend="opt-services.plausible.server.baseUrl">baseUrl</link> = "http://analytics.example.org";
- <link linkend="opt-services.plausible.server.secretKeybaseFile">secretKeybaseFile</link> = "/run/secrets/plausible-secret-key-base"; <co xml:id='ex-plausible-cfg-secretbase' />
+ 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>
- <calloutlist>
- <callout arearefs='ex-plausible-cfg-activate'>
- <para>
- <varname>activate</varname> is used to skip the email verification of the admin-user that's
- automatically created by <package>plausible</package>. This is only supported if
- <package>postgresql</package> is configured by the module. This is done by default, but
- can be turned off with <xref linkend="opt-services.plausible.database.postgres.setup" />.
- </para>
- </callout>
- <callout arearefs='ex-plausible-cfg-secretbase'>
- <para>
- <varname>secretKeybaseFile</varname> is a path to the file which contains the secret generated
- with <package>openssl</package> as described above.
- </para>
- </callout>
- </calloutlist>
- </para>
- </section>
+}
+</programlisting>
+ </section>
</chapter>