pyrox.dev
lol
nixos/plausible: convert manual chapter to MD
+60
-23
+35
nixos/modules/services/web-apps/plausible.md
+35
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
+
```
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
+
```
+2
nixos/modules/services/web-apps/plausible.nix
+2
nixos/modules/services/web-apps/plausible.nix
···
292
292
};
293
293
294
294
meta.maintainers = with maintainers; [ ma27 ];
295
+
# Don't edit the docbook xml directly, edit the md and generate it:
296
+
# `pandoc plausible.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > plausible.xml`
295
297
meta.doc = ./plausible.xml;
296
298
}
+23
-23
nixos/modules/services/web-apps/plausible.xml
+23
-23
nixos/modules/services/web-apps/plausible.xml
···
1
-
<chapter xmlns="http://docbook.org/ns/docbook"
2
-
xmlns:xlink="http://www.w3.org/1999/xlink"
3
-
xmlns:xi="http://www.w3.org/2001/XInclude"
4
-
version="5.0"
5
-
xml:id="module-services-plausible">
6
-
<title>Plausible</title>
7
-
<para>
8
-
<link xlink:href="https://plausible.io/">Plausible</link> is a privacy-friendly alternative to
9
-
Google analytics.
10
-
</para>
11
-
<section xml:id="module-services-plausible-basic-usage">
12
-
<title>Basic Usage</title>
1
+
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-plausible">
2
+
<title>Plausible</title>
13
3
<para>
14
-
At first, a secret key is needed to be generated. This can be done with e.g.
15
-
<screen><prompt>$ </prompt>openssl rand -base64 64</screen>
4
+
<link xlink:href="https://plausible.io/">Plausible</link> is a
5
+
privacy-friendly alternative to Google analytics.
16
6
</para>
17
-
<para>
18
-
After that, <literal>plausible</literal> can be deployed like this:
19
-
<programlisting>
7
+
<section xml:id="module-services-plausible-basic-usage">
8
+
<title>Basic Usage</title>
9
+
<para>
10
+
At first, a secret key is needed to be generated. This can be done
11
+
with e.g.
12
+
</para>
13
+
<programlisting>
14
+
$ openssl rand -base64 64
15
+
</programlisting>
16
+
<para>
17
+
After that, <literal>plausible</literal> can be deployed like
18
+
this:
19
+
</para>
20
+
<programlisting>
20
21
{
21
22
services.plausible = {
22
23
enable = true;
···
26
27
# postgresql is configured by the module. This is done by default, but
27
28
# can be turned off with services.plausible.database.postgres.setup.
28
29
activate = true;
29
-
email = "admin@localhost";
30
-
passwordFile = "/run/secrets/plausible-admin-pwd";
30
+
email = "admin@localhost";
31
+
passwordFile = "/run/secrets/plausible-admin-pwd";
31
32
};
32
33
server = {
33
-
baseUrl = "http://analytics.example.org";
34
+
baseUrl = "http://analytics.example.org";
34
35
# secretKeybaseFile is a path to the file which contains the secret generated
35
36
# with openssl as described above.
36
-
secretKeybaseFile = "/run/secrets/plausible-secret-key-base";
37
+
secretKeybaseFile = "/run/secrets/plausible-secret-key-base";
37
38
};
38
39
};
39
40
}
40
41
</programlisting>
41
-
</para>
42
-
</section>
42
+
</section>
43
43
</chapter>