lol

nixos/manual: enable smart quotes for all MD chapters

pennae 23ea73b4 03c72f22

+162 -163
+1 -1
nixos/modules/i18n/input-method/default.nix
··· 67 67 meta = { 68 68 maintainers = with lib.maintainers; [ ericsagnes ]; 69 69 # Don't edit the docbook xml directly, edit the md and generate it: 70 - # `pandoc default.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 > default.xml` 70 + # `pandoc default.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 > default.xml` 71 71 doc = ./default.xml; 72 72 }; 73 73
+4 -4
nixos/modules/i18n/input-method/default.xml
··· 114 114 To use any input method, the package must be added in the 115 115 configuration, as shown above, and also (after running 116 116 <literal>nixos-rebuild</literal>) the input method must be added 117 - from IBus' preference dialog. 117 + from IBus’ preference dialog. 118 118 </para> 119 119 <section xml:id="module-services-input-methods-troubleshooting"> 120 120 <title>Troubleshooting</title> ··· 221 221 <section xml:id="module-services-input-methods-uim"> 222 222 <title>Uim</title> 223 223 <para> 224 - Uim (short for &quot;universal input method&quot;) is a 224 + Uim (short for <quote>universal input method</quote>) is a 225 225 multilingual input method framework. Applications can use it 226 226 through so-called bridges. 227 227 </para> ··· 244 244 Hime is an extremely easy-to-use input method framework. It is 245 245 lightweight, stable, powerful and supports many commonly used 246 246 input methods, including Cangjie, Zhuyin, Dayi, Rank, Shrimp, 247 - Greek, Korean Pinyin, Latin Alphabet, etc... 247 + Greek, Korean Pinyin, Latin Alphabet, etc… 248 248 </para> 249 249 <para> 250 250 The following snippet can be used to configure Hime: ··· 258 258 <section xml:id="module-services-input-methods-kime"> 259 259 <title>Kime</title> 260 260 <para> 261 - Kime is Korean IME. it's built with Rust language and let you get 261 + Kime is Korean IME. it’s built with Rust language and let you get 262 262 simple, safe, fast Korean typing 263 263 </para> 264 264 <para>
+1 -1
nixos/modules/programs/digitalbitbox/default.nix
··· 34 34 35 35 meta = { 36 36 # Don't edit the docbook xml directly, edit the md and generate it: 37 - # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart > doc.xml` 37 + # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > doc.xml` 38 38 doc = ./doc.xml; 39 39 maintainers = with lib.maintainers; [ vidbina ]; 40 40 };
+1 -1
nixos/modules/programs/plotinus.nix
··· 9 9 meta = { 10 10 maintainers = pkgs.plotinus.meta.maintainers; 11 11 # Don't edit the docbook xml directly, edit the md and generate it: 12 - # `pandoc plotinus.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 > plotinus.xml` 12 + # `pandoc plotinus.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 > plotinus.xml` 13 13 doc = ./plotinus.xml; 14 14 }; 15 15
+1 -1
nixos/modules/programs/zsh/oh-my-zsh.nix
··· 143 143 }; 144 144 145 145 # Don't edit the docbook xml directly, edit the md and generate it: 146 - # `pandoc oh-my-zsh.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 > oh-my-zsh.xml` 146 + # `pandoc oh-my-zsh.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 > oh-my-zsh.xml` 147 147 meta.doc = ./oh-my-zsh.xml; 148 148 }
+2 -2
nixos/modules/programs/zsh/oh-my-zsh.xml
··· 63 63 </para> 64 64 <para> 65 65 Rather than using a single mutable path for 66 - <literal>ZSH_CUSTOM</literal>, it's also possible to generate this 66 + <literal>ZSH_CUSTOM</literal>, it’s also possible to generate this 67 67 path from a list of Nix packages: 68 68 </para> 69 69 <programlisting> ··· 93 93 <section xml:id="module-programs-oh-my-zsh-packaging-customizations"> 94 94 <title>Package your own customizations</title> 95 95 <para> 96 - If third-party customizations (e.g. new themes) are supposed to be 96 + If third-party customizations (e.g. new themes) are supposed to be 97 97 added to <literal>oh-my-zsh</literal> there are several pitfalls 98 98 to keep in mind: 99 99 </para>
+1 -1
nixos/modules/security/acme/default.nix
··· 917 917 meta = { 918 918 maintainers = lib.teams.acme.members; 919 919 # Don't edit the docbook xml directly, edit the md and generate it: 920 - # `pandoc doc.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 > doc.xml` 920 + # `pandoc doc.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 > doc.xml` 921 921 doc = ./doc.xml; 922 922 }; 923 923 }
+13 -14
nixos/modules/security/acme/doc.xml
··· 3 3 <para> 4 4 NixOS supports automatic domain validation &amp; certificate 5 5 retrieval and renewal using the ACME protocol. Any provider can be 6 - used, but by default NixOS uses Let's Encrypt. The alternative ACME 6 + used, but by default NixOS uses Let’s Encrypt. The alternative ACME 7 7 client 8 8 <link xlink:href="https://go-acme.github.io/lego/">lego</link> is 9 9 used under the hood. ··· 17 17 <section xml:id="module-security-acme-prerequisites"> 18 18 <title>Prerequisites</title> 19 19 <para> 20 - To use the ACME module, you must accept the provider's terms of 20 + To use the ACME module, you must accept the provider’s terms of 21 21 service by setting 22 22 <xref linkend="opt-security.acme.acceptTerms"></xref> to 23 - <literal>true</literal>. The Let's Encrypt ToS can be found 23 + <literal>true</literal>. The Let’s Encrypt ToS can be found 24 24 <link xlink:href="https://letsencrypt.org/repository/">here</link>. 25 25 </para> 26 26 <para> 27 27 You must also set an email address to be used when creating 28 - accounts with Let's Encrypt. You can set this for all certs with 28 + accounts with Let’s Encrypt. You can set this for all certs with 29 29 <xref linkend="opt-security.acme.defaults.email"></xref> and/or on 30 30 a per-cert basis with 31 31 <xref linkend="opt-security.acme.certs._name_.email"></xref>. This ··· 93 93 <para> 94 94 Using ACME certificates with Apache virtual hosts is identical to 95 95 using them with Nginx. The attribute names are all the same, just 96 - replace &quot;nginx&quot; with &quot;httpd&quot; where 96 + replace <quote>nginx</quote> with <quote>httpd</quote> where 97 97 appropriate. 98 98 </para> 99 99 </section> ··· 257 257 }; 258 258 </programlisting> 259 259 <para> 260 - Now you're all set to generate certs! You should monitor the first 260 + Now you’re all set to generate certs! You should monitor the first 261 261 invocation by running 262 262 <literal>systemctl start acme-example.com.service &amp; journalctl -fu acme-example.com.service</literal> 263 263 and watching its log output. ··· 270 270 including those automatically configured via the Nginx/Apache 271 271 <link linkend="opt-services.nginx.virtualHosts._name_.enableACME"><literal>enableACME</literal></link> 272 272 option. This configuration pattern is fully supported and part of 273 - the module's test suite for Nginx + Apache. 273 + the module’s test suite for Nginx + Apache. 274 274 </para> 275 275 <para> 276 276 You must follow the guide above on configuring DNS-01 validation 277 277 first, however instead of setting the options for one certificate 278 - (e.g. 279 - <xref linkend="opt-security.acme.certs._name_.dnsProvider"></xref>) 280 - you will set them as defaults (e.g. 281 - <xref linkend="opt-security.acme.defaults.dnsProvider"></xref>). 278 + (e.g. <xref linkend="opt-security.acme.certs._name_.dnsProvider"></xref>) 279 + you will set them as defaults 280 + (e.g. <xref linkend="opt-security.acme.defaults.dnsProvider"></xref>). 282 281 </para> 283 282 <programlisting> 284 283 # Configure ACME appropriately ··· 304 303 } 305 304 </programlisting> 306 305 <para> 307 - And that's it! Next time your configuration is rebuilt, or when 306 + And that’s it! Next time your configuration is rebuilt, or when 308 307 you add a new virtualHost, it will be DNS-01 validated. 309 308 </para> 310 309 </section> ··· 316 315 are not owned by root. PostgreSQL and OpenSMTPD are examples of 317 316 these. There is no way to change the user the ACME module uses (it 318 317 will always be <literal>acme</literal>), however you can use 319 - systemd's <literal>LoadCredential</literal> feature to resolve 318 + systemd’s <literal>LoadCredential</literal> feature to resolve 320 319 this elegantly. Below is an example configuration for OpenSMTPD, 321 320 but this pattern can be applied to any service. 322 321 </para> ··· 360 359 <title>Regenerating certificates</title> 361 360 <para> 362 361 Should you need to regenerate a particular certificate in a hurry, 363 - such as when a vulnerability is found in Let's Encrypt, there is 362 + such as when a vulnerability is found in Let’s Encrypt, there is 364 363 now a convenient mechanism for doing so. Running 365 364 <literal>systemctl clean --what=state acme-example.com.service</literal> 366 365 will remove all certificate files and the account data for the
+1 -1
nixos/modules/services/backup/borgbackup.nix
··· 227 227 in { 228 228 meta.maintainers = with maintainers; [ dotlambda ]; 229 229 # Don't edit the docbook xml directly, edit the md and generate it: 230 - # `pandoc borgbackup.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 > borgbackup.xml` 230 + # `pandoc borgbackup.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 > borgbackup.xml` 231 231 meta.doc = ./borgbackup.xml; 232 232 233 233 ###### interface
+1 -1
nixos/modules/services/backup/borgbackup.xml
··· 200 200 protect your data from disk failure, ransomware and theft. 201 201 </para> 202 202 <para> 203 - It can be installed in NixOS e.g. by adding 203 + It can be installed in NixOS e.g. by adding 204 204 <literal>pkgs.vorta</literal> to 205 205 <xref linkend="opt-environment.systemPackages"></xref>. 206 206 </para>
+1 -1
nixos/modules/services/databases/foundationdb.nix
··· 425 425 }; 426 426 427 427 # Don't edit the docbook xml directly, edit the md and generate it: 428 - # `pandoc foundationdb.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 > foundationdb.xml` 428 + # `pandoc foundationdb.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 > foundationdb.xml` 429 429 meta.doc = ./foundationdb.xml; 430 430 meta.maintainers = with lib.maintainers; [ thoughtpolice ]; 431 431 }
+8 -8
nixos/modules/services/databases/foundationdb.xml
··· 15 15 <emphasis>Available version(s):</emphasis> 5.1.x, 5.2.x, 6.0.x 16 16 </para> 17 17 <para> 18 - FoundationDB (or &quot;FDB&quot;) is an open source, distributed, 18 + FoundationDB (or <quote>FDB</quote>) is an open source, distributed, 19 19 transactional key-value store. 20 20 </para> 21 21 <section xml:id="module-services-foundationdb-configuring"> ··· 115 115 SSD-storage based database for development and basic usage. This 116 116 storage engine is designed for SSDs and will perform poorly on 117 117 HDDs; however it can handle far more data than the alternative 118 - &quot;memory&quot; engine and is a better default choice for most 119 - deployments. (Note that you can change the storage backend 118 + <quote>memory</quote> engine and is a better default choice for 119 + most deployments. (Note that you can change the storage backend 120 120 on-the-fly for a given FoundationDB cluster using 121 121 <command>fdbcli</command>.) 122 122 </para> ··· 151 151 <para> 152 152 FoundationDB worker processes typically require 4GB of RAM 153 153 per-process at minimum for good performance, so this option is set 154 - to 1 by default since the maximum amount of RAM is unknown. You're 154 + to 1 by default since the maximum amount of RAM is unknown. You’re 155 155 advised to abide by this restriction, so pick a number of 156 156 processes so that each has 4GB or more. 157 157 </para> ··· 282 282 FoundationDB uses a pluggable design to transport security, and 283 283 out of the box it supports a LibreSSL-based plugin for TLS 284 284 support. This plugin not only does in-flight encryption, but also 285 - performs client authorization based on the given endpoint's 285 + performs client authorization based on the given endpoint’s 286 286 certificate chain. For example, a FoundationDB server may be 287 287 configured to only accept client connections over TLS, where the 288 288 client TLS certificate is from organization <emphasis>Acme ··· 303 303 </para> 304 304 <para> 305 305 After you have a key and certificate file in place, it is not 306 - enough to simply set the NixOS module options -- you must also 306 + enough to simply set the NixOS module options – you must also 307 307 configure the <command>fdb.cluster</command> file to specify that 308 308 a given set of coordinators use TLS. This is as simple as adding 309 309 the suffix <command>:tls</command> to your cluster coordinator ··· 333 333 </para> 334 334 <para> 335 335 However, a side effect of this is that the 336 - <command>fdbbackup</command> command doesn't work properly for 336 + <command>fdbbackup</command> command doesn’t work properly for 337 337 local filesystem backups: FoundationDB uses a server process 338 338 alongside the database processes to perform backups and copy the 339 339 backups to the filesystem. As a result, this process is put under ··· 403 403 <section xml:id="module-services-foundationdb-options"> 404 404 <title>Options</title> 405 405 <para> 406 - NixOS's FoundationDB module allows you to configure all of the 406 + NixOS’s FoundationDB module allows you to configure all of the 407 407 most relevant configuration options for 408 408 <command>fdbmonitor</command>, matching it quite closely. A 409 409 complete list of options for the FoundationDB module may be found
+1 -1
nixos/modules/services/databases/postgresql.nix
··· 586 586 }; 587 587 588 588 # Don't edit the docbook xml directly, edit the md and generate it: 589 - # `pandoc postgresql.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 > postgresql.xml` 589 + # `pandoc postgresql.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 > postgresql.xml` 590 590 meta.doc = ./postgresql.xml; 591 591 meta.maintainers = with lib.maintainers; [ thoughtpolice danbst ]; 592 592 }
+4 -4
nixos/modules/services/databases/postgresql.xml
··· 23 23 </programlisting> 24 24 <para> 25 25 Note that you are required to specify the desired version of 26 - PostgreSQL (e.g. <literal>pkgs.postgresql_11</literal>). Since 26 + PostgreSQL (e.g. <literal>pkgs.postgresql_11</literal>). Since 27 27 upgrading your PostgreSQL version requires a database dump and 28 28 reload (see below), NixOS cannot provide a default value for 29 29 <xref linkend="opt-services.postgresql.package"></xref> such as ··· 51 51 <para> 52 52 Major PostgreSQL upgrades require a downtime and a few imperative 53 53 steps to be called. This is the case because each major version 54 - has some internal changes in the databases' state during major 54 + has some internal changes in the databases’ state during major 55 55 releases. Because of that, NixOS places the state into 56 56 <filename>/var/lib/postgresql/&lt;version&gt;</filename> where 57 57 each <literal>version</literal> can be obtained like this: ··· 138 138 </listitem> 139 139 <listitem> 140 140 <para> 141 - After the upgrade it's advisable to analyze the new cluster. 141 + After the upgrade it’s advisable to analyze the new cluster. 142 142 </para> 143 143 <itemizedlist> 144 144 <listitem> ··· 228 228 } 229 229 </programlisting> 230 230 <para> 231 - Here's a recipe on how to override a particular plugin through an 231 + Here’s a recipe on how to override a particular plugin through an 232 232 overlay: 233 233 </para> 234 234 <programlisting>
+1 -1
nixos/modules/services/editors/emacs.nix
··· 100 100 }; 101 101 102 102 # Don't edit the docbook xml directly, edit the md and generate it: 103 - # `pandoc emacs.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 > emacs.xml` 103 + # `pandoc emacs.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 > emacs.xml` 104 104 meta.doc = ./emacs.xml; 105 105 }
+1 -1
nixos/modules/services/hardware/trezord.nix
··· 9 9 10 10 meta = { 11 11 # Don't edit the docbook xml directly, edit the md and generate it: 12 - # `pandoc trezord.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 > trezord.xml` 12 + # `pandoc trezord.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 > trezord.xml` 13 13 doc = ./trezord.xml; 14 14 }; 15 15
+1 -1
nixos/modules/services/mail/mailman.nix
··· 643 643 meta = { 644 644 maintainers = with lib.maintainers; [ lheckemann qyliss ma27 ]; 645 645 # Don't edit the docbook xml directly, edit the md and generate it: 646 - # `pandoc mailman.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 > mailman.xml` 646 + # `pandoc mailman.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 > mailman.xml` 647 647 doc = ./mailman.xml; 648 648 }; 649 649
+2 -2
nixos/modules/services/mail/mailman.xml
··· 61 61 up, the Postorius mailing list manager and the Hyperkitty archive 62 62 browser will be available at https://lists.example.org/. Note that 63 63 this setup is not sufficient to deliver emails to most email 64 - providers nor to avoid spam -- a number of additional measures for 64 + providers nor to avoid spam – a number of additional measures for 65 65 authenticating incoming and outgoing mails, such as SPF, DMARC and 66 66 DKIM are necessary, but outside the scope of the Mailman module. 67 67 </para> ··· 100 100 </programlisting> 101 101 <para> 102 102 The exim config needs some special additions to work with Mailman. 103 - Currently NixOS can't manage Exim config with such granularity. 103 + Currently NixOS can’t manage Exim config with such granularity. 104 104 Please refer to 105 105 <link xlink:href="https://mailman.readthedocs.io/en/latest/src/mailman/docs/mta.html">Mailman 106 106 documentation</link> for more info on configuring Mailman for
+1 -1
nixos/modules/services/matrix/mjolnir.nix
··· 237 237 238 238 meta = { 239 239 # Don't edit the docbook xml directly, edit the md and generate it: 240 - # `pandoc mjolnir.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 > mjolnir.xml` 240 + # `pandoc mjolnir.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 > mjolnir.xml` 241 241 doc = ./mjolnir.xml; 242 242 maintainers = with maintainers; [ jojosch ]; 243 243 };
+8 -8
nixos/modules/services/matrix/mjolnir.xml
··· 7 7 </para> 8 8 <para> 9 9 As an all-in-one moderation tool, it can protect your server from 10 - malicious invites, spam messages, and whatever else you don't want. 10 + malicious invites, spam messages, and whatever else you don’t want. 11 11 In addition to server-level protection, Mjolnir is great for 12 12 communities wanting to protect their rooms without having to use 13 13 their personal accounts for moderation. ··· 21 21 See the 22 22 <link xlink:href="https://github.com/matrix-org/mjolnir#readme">README</link> 23 23 page and the 24 - <link xlink:href="https://github.com/matrix-org/mjolnir/blob/main/docs/moderators.md">Moderator's 24 + <link xlink:href="https://github.com/matrix-org/mjolnir/blob/main/docs/moderators.md">Moderator’s 25 25 guide</link> for additional instructions on how to setup and use 26 26 Mjolnir. 27 27 </para> ··· 36 36 <para> 37 37 First create a new Room which will be used as a management room 38 38 for Mjolnir. In this room, Mjolnir will log possible errors and 39 - debugging information. You'll need to set this Room-ID in 39 + debugging information. You’ll need to set this Room-ID in 40 40 <link linkend="opt-services.mjolnir.managementRoom">services.mjolnir.managementRoom</link>. 41 41 </para> 42 42 <para> ··· 51 51 </para> 52 52 <para> 53 53 If you want Mjolnir to be able to deactivate users, move room 54 - aliases, shutdown rooms, etc. you'll need to make the Mjolnir user 54 + aliases, shutdown rooms, etc. you’ll need to make the Mjolnir user 55 55 a Matrix server admin. 56 56 </para> 57 57 <para> ··· 93 93 <title>Element Matrix Services (EMS)</title> 94 94 <para> 95 95 If you are using a managed 96 - <link xlink:href="https://ems.element.io/">&quot;Element Matrix 97 - Services (EMS)&quot;</link> server, you will need to consent to 98 - the terms and conditions. Upon startup, an error log entry with 99 - a URL to the consent page will be generated. 96 + <link xlink:href="https://ems.element.io/"><quote>Element Matrix 97 + Services (EMS)</quote></link> server, you will need to consent 98 + to the terms and conditions. Upon startup, an error log entry 99 + with a URL to the consent page will be generated. 100 100 </para> 101 101 </section> 102 102 </section>
+1 -1
nixos/modules/services/matrix/synapse.nix
··· 802 802 meta = { 803 803 buildDocsInSandbox = false; 804 804 # Don't edit the docbook xml directly, edit the md and generate it: 805 - # `pandoc synapse.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 > synapse.xml` 805 + # `pandoc synapse.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 > synapse.xml` 806 806 doc = ./synapse.xml; 807 807 maintainers = teams.matrix.members; 808 808 };
+5 -5
nixos/modules/services/matrix/synapse.xml
··· 152 152 <para> 153 153 When using 154 154 <xref linkend="opt-services.matrix-synapse.settings.registration_shared_secret"></xref>, 155 - the secret will end up in the world-readable store. Instead it's 155 + the secret will end up in the world-readable store. Instead it’s 156 156 recommended to deploy the secret in an additional file like 157 157 this: 158 158 </para> ··· 173 173 <citerefentry><refentrytitle>nixops</refentrytitle><manvolnum>1</manvolnum></citerefentry> 174 174 or 175 175 <link xlink:href="https://github.com/Mic92/sops-nix/">sops-nix</link> 176 - to e.g. 177 - <filename>/run/secrets/matrix-shared-secret</filename> and 178 - ensure that it's readable by 176 + to 177 + e.g. <filename>/run/secrets/matrix-shared-secret</filename> 178 + and ensure that it’s readable by 179 179 <literal>matrix-synapse</literal>. 180 180 </para> 181 181 </listitem> ··· 195 195 </warning> 196 196 <note> 197 197 <para> 198 - It's also possible to user alternative authentication mechanism 198 + It’s also possible to user alternative authentication mechanism 199 199 such as 200 200 <link xlink:href="https://github.com/matrix-org/matrix-synapse-ldap3">LDAP 201 201 (via <literal>matrix-synapse-ldap3</literal>)</link> or
+1 -1
nixos/modules/services/misc/gitlab.nix
··· 1503 1503 }; 1504 1504 1505 1505 # Don't edit the docbook xml directly, edit the md and generate it: 1506 - # `pandoc gitlab.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 > gitlab.xml` 1506 + # `pandoc gitlab.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 > gitlab.xml` 1507 1507 meta.doc = ./gitlab.xml; 1508 1508 1509 1509 }
+3 -3
nixos/modules/services/misc/gitlab.xml
··· 78 78 }; 79 79 </programlisting> 80 80 <para> 81 - If you're setting up a new GitLab instance, generate new secrets. 81 + If you’re setting up a new GitLab instance, generate new secrets. 82 82 You for instance use 83 83 <literal>tr -dc A-Za-z0-9 &lt; /dev/urandom | head -c 128 &gt; /var/keys/gitlab/db</literal> 84 84 to generate a new db secret. Make sure the files can be read by, 85 85 and only by, the user specified by 86 86 <link linkend="opt-services.gitlab.user">services.gitlab.user</link>. 87 - GitLab encrypts sensitive data stored in the database. If you're 87 + GitLab encrypts sensitive data stored in the database. If you’re 88 88 restoring an existing GitLab instance, you must specify the 89 89 secrets secret from <literal>config/secrets.yml</literal> located 90 90 in your GitLab state folder. ··· 125 125 <section xml:id="module-services-gitlab-maintenance-rake"> 126 126 <title>Rake tasks</title> 127 127 <para> 128 - You can run GitLab's rake tasks with 128 + You can run GitLab’s rake tasks with 129 129 <literal>gitlab-rake</literal> which will be available on the 130 130 system when GitLab is enabled. You will have to run the command 131 131 as the user that you configured to run GitLab with.
+1 -1
nixos/modules/services/misc/sourcehut/default.nix
··· 1391 1391 ]; 1392 1392 1393 1393 # Don't edit the docbook xml directly, edit the md and generate it: 1394 - # `pandoc sourcehut.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 > sourcehut.xml` 1394 + # `pandoc sourcehut.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 > sourcehut.xml` 1395 1395 meta.doc = ./sourcehut.xml; 1396 1396 meta.maintainers = with maintainers; [ tomberek ]; 1397 1397 }
+4 -4
nixos/modules/services/misc/sourcehut/sourcehut.xml
··· 97 97 </para> 98 98 </section> 99 99 <section xml:id="module-services-sourcehut-httpd"> 100 - <title>Using an alternative webserver as reverse-proxy (e.g. 101 - <literal>httpd</literal>)</title> 100 + <title>Using an alternative webserver as reverse-proxy 101 + (e.g. <literal>httpd</literal>)</title> 102 102 <para> 103 103 By default, <literal>nginx</literal> is used as reverse-proxy for 104 - <literal>sourcehut</literal>. However, it's possible to use e.g. 105 - <literal>httpd</literal> by explicitly disabling 104 + <literal>sourcehut</literal>. However, it’s possible to use 105 + e.g. <literal>httpd</literal> by explicitly disabling 106 106 <literal>nginx</literal> using 107 107 <xref linkend="opt-services.nginx.enable"></xref> and fixing the 108 108 <literal>settings</literal>.
+1 -1
nixos/modules/services/misc/taskserver/default.nix
··· 567 567 ]; 568 568 569 569 # Don't edit the docbook xml directly, edit the md and generate it: 570 - # `pandoc doc.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 > doc.xml` 570 + # `pandoc doc.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 > doc.xml` 571 571 meta.doc = ./doc.xml; 572 572 }
+4 -4
nixos/modules/services/misc/taskserver/doc.xml
··· 16 16 certificates, so you either need to roll your own CA or purchase a 17 17 certificate from a known CA, which allows creation of client 18 18 certificates. These certificates are usually advertised as 19 - &quot;server certificates&quot;. 19 + <quote>server certificates</quote>. 20 20 </para> 21 21 <para> 22 22 So in order to make it easier to handle your own CA, there is a ··· 54 54 For example if you add a new organisation using 55 55 <command>nixos-taskserver org add foo</command>, the organisation 56 56 is not modified and deleted no matter what you define in 57 - <option>services.taskserver.organisations</option>, even if you're 57 + <option>services.taskserver.organisations</option>, even if you’re 58 58 adding the same organisation in that option. 59 59 </para> 60 60 <para> ··· 80 80 client machine. 81 81 </para> 82 82 <para> 83 - For example, let's say you have the following configuration: 83 + For example, let’s say you have the following configuration: 84 84 </para> 85 85 <programlisting> 86 86 { ··· 121 121 <para> 122 122 If you set any options within 123 123 <link linkend="opt-services.taskserver.pki.manual.ca.cert">service.taskserver.pki.manual</link>.*, 124 - <command>nixos-taskserver</command> won't issue certificates, but 124 + <command>nixos-taskserver</command> won’t issue certificates, but 125 125 you can still use it for adding or removing user accounts. 126 126 </para> 127 127 </section>
+1 -1
nixos/modules/services/monitoring/prometheus/exporters.nix
··· 324 324 325 325 meta = { 326 326 # Don't edit the docbook xml directly, edit the md and generate it: 327 - # `pandoc exporters.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 > exporters.xml` 327 + # `pandoc exporters.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 > exporters.xml` 328 328 doc = ./exporters.xml; 329 329 maintainers = [ maintainers.willibutz ]; 330 330 };
+5 -5
nixos/modules/services/monitoring/prometheus/exporters.xml
··· 11 11 One of the most common exporters is the 12 12 <link xlink:href="https://github.com/prometheus/node_exporter">node 13 13 exporter</link>, it provides hardware and OS metrics from the host 14 - it's running on. The exporter could be configured as follows: 14 + it’s running on. The exporter could be configured as follows: 15 15 </para> 16 16 <programlisting> 17 17 services.prometheus.exporters.node = { ··· 34 34 <link xlink:href="https://github.com/prometheus/node_exporter#enabled-by-default">enabled 35 35 by default</link>, via http under <literal>/metrics</literal>. In 36 36 this example the firewall should just allow incoming connections 37 - to the exporter's port on the bridge interface 37 + to the exporter’s port on the bridge interface 38 38 <literal>br0</literal> (this would have to be configured 39 39 separately of course). For more information about configuration 40 40 see <literal>man configuration.nix</literal> or search through the ··· 194 194 <para> 195 195 This should already be enough for the postfix exporter. 196 196 Additionally one could now add assertions and conditional 197 - default values. This can be done in the 'meta-module' that 198 - combines all exporter definitions and generates the 199 - submodules: 197 + default values. This can be done in the 198 + <quote>meta-module</quote> that combines all exporter 199 + definitions and generates the submodules: 200 200 <literal>nixpkgs/nixos/modules/services/prometheus/exporters.nix</literal> 201 201 </para> 202 202 </listitem>
+1 -1
nixos/modules/services/network-filesystems/litestream/default.nix
··· 96 96 }; 97 97 98 98 # Don't edit the docbook xml directly, edit the md and generate it: 99 - # `pandoc litestream.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 > litestream.xml` 99 + # `pandoc litestream.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 > litestream.xml` 100 100 meta.doc = ./litestream.xml; 101 101 }
+1 -1
nixos/modules/services/network-filesystems/litestream/litestream.xml
··· 9 9 <para> 10 10 Litestream service is managed by a dedicated user named 11 11 <literal>litestream</literal> which needs permission to the 12 - database file. Here's an example config which gives required 12 + database file. Here’s an example config which gives required 13 13 permissions to access 14 14 <link linkend="opt-services.grafana.settings.database.path">grafana 15 15 database</link>:
+1 -1
nixos/modules/services/networking/pleroma.nix
··· 148 148 }; 149 149 meta.maintainers = with lib.maintainers; [ ninjatrappeur ]; 150 150 # Don't edit the docbook xml directly, edit the md and generate it: 151 - # `pandoc pleroma.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 > pleroma.xml` 151 + # `pandoc pleroma.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 > pleroma.xml` 152 152 meta.doc = ./pleroma.xml; 153 153 }
+2 -2
nixos/modules/services/networking/pleroma.xml
··· 136 136 </programlisting> 137 137 <para> 138 138 Note that the lines of the same configuration group are comma 139 - separated (i.e. all the lines end with a comma, except the last 139 + separated (i.e. all the lines end with a comma, except the last 140 140 one), so when the lines with passwords are added or removed, 141 141 commas must be adjusted accordingly. 142 142 </para> ··· 179 179 4000. Nginx can be configured as a Reverse Proxy, for forwarding 180 180 requests from public ports to the Pleroma service. This is an 181 181 example of configuration, using 182 - <link xlink:href="https://letsencrypt.org/">Let's Encrypt</link> 182 + <link xlink:href="https://letsencrypt.org/">Let’s Encrypt</link> 183 183 for the TLS certificates 184 184 </para> 185 185 <programlisting>
+1 -1
nixos/modules/services/networking/prosody.nix
··· 906 906 }; 907 907 908 908 # Don't edit the docbook xml directly, edit the md and generate it: 909 - # `pandoc prosody.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 > prosody.xml` 909 + # `pandoc prosody.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 > prosody.xml` 910 910 meta.doc = ./prosody.xml; 911 911 }
+4 -4
nixos/modules/services/networking/prosody.xml
··· 24 24 <link xlink:href="https://xmpp.org/extensions/xep-0045.html">Multi 25 25 User Chat (MUC)</link> and the 26 26 <link xlink:href="https://xmpp.org/extensions/xep-0363.html">HTTP 27 - File Upload</link> ones. You'll need to create a DNS subdomain for 27 + File Upload</link> ones. You’ll need to create a DNS subdomain for 28 28 each of those. The current convention is to name your MUC endpoint 29 29 <literal>conference.example.org</literal> and your HTTP upload 30 30 domain <literal>upload.example.org</literal>. ··· 58 58 </programlisting> 59 59 </section> 60 60 <section xml:id="module-services-prosody-letsencrypt"> 61 - <title>Let's Encrypt Configuration</title> 61 + <title>Let’s Encrypt Configuration</title> 62 62 <para> 63 63 As you can see in the code snippet from the 64 64 <link linkend="module-services-prosody-basic-usage">previous 65 - section</link>, you'll need a single TLS certificate covering your 65 + section</link>, you’ll need a single TLS certificate covering your 66 66 main endpoint, the MUC one as well as the HTTP Upload one. We can 67 67 generate such a certificate by leveraging the ACME 68 68 <link linkend="opt-security.acme.certs._name_.extraDomainNames">extraDomainNames</link> 69 69 module option. 70 70 </para> 71 71 <para> 72 - Provided the setup detailed in the previous section, you'll need 72 + Provided the setup detailed in the previous section, you’ll need 73 73 the following acme configuration to generate a TLS certificate for 74 74 the three endponits: 75 75 </para>
+1 -1
nixos/modules/services/networking/yggdrasil.nix
··· 194 194 }); 195 195 meta = { 196 196 # Don't edit the docbook xml directly, edit the md and generate it: 197 - # `pandoc yggdrasil.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 > yggdrasil.xml` 197 + # `pandoc yggdrasil.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 > yggdrasil.xml` 198 198 doc = ./yggdrasil.xml; 199 199 maintainers = with lib.maintainers; [ gazally ehmry ]; 200 200 };
+1 -1
nixos/modules/services/web-apps/discourse.nix
··· 1081 1081 }; 1082 1082 1083 1083 # Don't edit the docbook xml directly, edit the md and generate it: 1084 - # `pandoc discourse.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 > discourse.xml` 1084 + # `pandoc discourse.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 > discourse.xml` 1085 1085 meta.doc = ./discourse.xml; 1086 1086 meta.maintainers = [ lib.maintainers.talyz ]; 1087 1087 }
+13 -13
nixos/modules/services/web-apps/discourse.xml
··· 7 7 <section xml:id="module-services-discourse-basic-usage"> 8 8 <title>Basic usage</title> 9 9 <para> 10 - A minimal configuration using Let's Encrypt for TLS certificates 10 + A minimal configuration using Let’s Encrypt for TLS certificates 11 11 looks like this: 12 12 </para> 13 13 <programlisting> ··· 26 26 security.acme.acceptTerms = true; 27 27 </programlisting> 28 28 <para> 29 - Provided a proper DNS setup, you'll be able to connect to the 29 + Provided a proper DNS setup, you’ll be able to connect to the 30 30 instance at <literal>discourse.example.com</literal> and log in 31 31 using the credentials provided in 32 32 <literal>services.discourse.admin</literal>. ··· 82 82 <section xml:id="module-services-discourse-mail"> 83 83 <title>Email</title> 84 84 <para> 85 - In addition to the basic setup, you'll want to configure an SMTP 85 + In addition to the basic setup, you’ll want to configure an SMTP 86 86 server Discourse can use to send user registration and password 87 87 reset emails, among others. You can also optionally let Discourse 88 88 receive email, which enables people to reply to threads and ··· 116 116 }; 117 117 </programlisting> 118 118 <para> 119 - This assumes you have set up an MX record for the address you've 119 + This assumes you have set up an MX record for the address you’ve 120 120 set in 121 121 <link linkend="opt-services.discourse.hostname">hostname</link> 122 122 and requires proper SPF, DKIM and DMARC configuration to be done 123 - for the domain you're sending from, in order for email to be 123 + for the domain you’re sending from, in order for email to be 124 124 reliably delivered. 125 125 </para> 126 126 <para> ··· 135 135 <note> 136 136 <para> 137 137 Setup of TLS for incoming email is currently only configured 138 - automatically when a regular TLS certificate is used, i.e. when 138 + automatically when a regular TLS certificate is used, i.e. when 139 139 <xref linkend="opt-services.discourse.sslCertificate"></xref> 140 140 and 141 141 <xref linkend="opt-services.discourse.sslCertificateKey"></xref> ··· 155 155 <section xml:id="module-services-discourse-site-settings"> 156 156 <title>Site settings</title> 157 157 <para> 158 - &quot;Site settings&quot; are the settings that can be changed 159 - through the Discourse UI. Their <emphasis>default</emphasis> 160 - values can be set using 158 + <quote>Site settings</quote> are the settings that can be 159 + changed through the Discourse UI. Their 160 + <emphasis>default</emphasis> values can be set using 161 161 <xref linkend="opt-services.discourse.siteSettings"></xref>. 162 162 </para> 163 163 <para> 164 164 Settings are expressed as a Nix attribute set which matches the 165 165 structure of the configuration in 166 166 <link xlink:href="https://github.com/discourse/discourse/blob/master/config/site_settings.yml">config/site_settings.yml</link>. 167 - To find a setting's path, you only need to care about the first 168 - two levels; i.e. its category (e.g. <literal>login</literal>) 169 - and name (e.g. <literal>invite_only</literal>). 167 + To find a setting’s path, you only need to care about the first 168 + two levels; i.e. its category (e.g. <literal>login</literal>) 169 + and name (e.g. <literal>invite_only</literal>). 170 170 </para> 171 171 <para> 172 172 Settings containing secret data should be set to an attribute ··· 263 263 <link xlink:href="https://nixos.org/manual/nixpkgs/stable/#developing-with-ruby">Developing 264 264 with Ruby</link> section of the Nixpkgs manual and the appropriate 265 265 gem options set in <literal>bundlerEnvArgs</literal> (normally 266 - <literal>gemdir</literal> is sufficient). A plugin's Ruby 266 + <literal>gemdir</literal> is sufficient). A plugin’s Ruby 267 267 dependencies are listed in its <filename>plugin.rb</filename> file 268 268 as function calls to <literal>gem</literal>. To construct the 269 269 corresponding <filename>Gemfile</filename> manually, run
+1 -1
nixos/modules/services/web-apps/grocy.nix
··· 168 168 meta = { 169 169 maintainers = with maintainers; [ ma27 ]; 170 170 # Don't edit the docbook xml directly, edit the md and generate it: 171 - # `pandoc grocy.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 > grocy.xml` 171 + # `pandoc grocy.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 > grocy.xml` 172 172 doc = ./grocy.xml; 173 173 }; 174 174 }
+1 -1
nixos/modules/services/web-apps/grocy.xml
··· 29 29 credentials <literal>admin:admin</literal> can be used to login. 30 30 </para> 31 31 <para> 32 - The application's state is persisted at 32 + The application’s state is persisted at 33 33 <literal>/var/lib/grocy/grocy.db</literal> in a 34 34 <literal>sqlite3</literal> database. The migration is applied when 35 35 requesting the <literal>/</literal>-route of the application.
+1 -1
nixos/modules/services/web-apps/jitsi-meet.nix
··· 452 452 }; 453 453 454 454 # Don't edit the docbook xml directly, edit the md and generate it: 455 - # `pandoc jitsi-meet.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 > jitsi-meet.xml` 455 + # `pandoc jitsi-meet.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 > jitsi-meet.xml` 456 456 meta.doc = ./jitsi-meet.xml; 457 457 meta.maintainers = lib.teams.jitsi.members; 458 458 }
+1 -1
nixos/modules/services/web-apps/jitsi-meet.xml
··· 7 7 <section xml:id="module-services-jitsi-basic-usage"> 8 8 <title>Basic usage</title> 9 9 <para> 10 - A minimal configuration using Let's Encrypt for TLS certificates 10 + A minimal configuration using Let’s Encrypt for TLS certificates 11 11 looks like this: 12 12 </para> 13 13 <programlisting>
+1 -1
nixos/modules/services/web-apps/keycloak.nix
··· 675 675 }; 676 676 677 677 # Don't edit the docbook xml directly, edit the md and generate it: 678 - # `pandoc keycloak.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 > keycloak.xml` 678 + # `pandoc keycloak.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 > keycloak.xml` 679 679 meta.doc = ./keycloak.xml; 680 680 meta.maintainers = [ maintainers.talyz ]; 681 681 }
+3 -3
nixos/modules/services/web-apps/keycloak.xml
··· 76 76 </para> 77 77 <note> 78 78 <para> 79 - If you're migrating an old Wildfly based Keycloak instance and 80 - want to keep compatibility with your current clients, you'll 79 + If you’re migrating an old Wildfly based Keycloak instance and 80 + want to keep compatibility with your current clients, you’ll 81 81 likely want to set 82 82 <xref linkend="opt-services.keycloak.settings.http-relative-path"></xref> 83 83 to <literal>/auth</literal>. See the option description for more ··· 102 102 <section xml:id="module-services-keycloak-tls"> 103 103 <title>Setting up TLS/SSL</title> 104 104 <para> 105 - By default, Keycloak won't accept unsecured HTTP connections 105 + By default, Keycloak won’t accept unsecured HTTP connections 106 106 originating from outside its local network. 107 107 </para> 108 108 <para>
+3 -3
nixos/modules/services/web-apps/matomo-doc.xml
··· 41 41 <link xlink:href="https://mariadb.com/kb/en/mariadb/unix_socket-authentication-plugin/" role="uri">https://mariadb.com/kb/en/mariadb/unix_socket-authentication-plugin/</link>. 42 42 </para> 43 43 <para> 44 - Of course, you can use password based authentication as well, e.g. 45 - when the database is not on the same host. 44 + Of course, you can use password based authentication as well, 45 + e.g. when the database is not on the same host. 46 46 </para> 47 47 </section> 48 48 <section xml:id="module-services-matomo-archive-processing"> ··· 84 84 <listitem> 85 85 <para> 86 86 Matomo will warn you that the JavaScript tracker is not 87 - writable. This is because it's located in the read-only nix 87 + writable. This is because it’s located in the read-only nix 88 88 store. You can safely ignore this, unless you need a plugin 89 89 that needs JavaScript tracker access. 90 90 </para>
+1 -1
nixos/modules/services/web-apps/matomo.nix
··· 326 326 327 327 meta = { 328 328 # Don't edit the docbook xml directly, edit the md and generate it: 329 - # `pandoc matomo-doc.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 > matomo-doc.xml` 329 + # `pandoc matomo-doc.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 > matomo-doc.xml` 330 330 doc = ./matomo-doc.xml; 331 331 maintainers = with lib.maintainers; [ florianjacob ]; 332 332 };
+1 -1
nixos/modules/services/web-apps/nextcloud.nix
··· 1147 1147 ]); 1148 1148 1149 1149 # Don't edit the docbook xml directly, edit the md and generate it: 1150 - # `pandoc nextcloud.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 > nextcloud.xml` 1150 + # `pandoc nextcloud.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 > nextcloud.xml` 1151 1151 meta.doc = ./nextcloud.xml; 1152 1152 }
+25 -25
nixos/modules/services/web-apps/nextcloud.xml
··· 19 19 (<link linkend="opt-services.nextcloud.enable"><literal>services.nextcloud</literal></link> 20 20 optionally supports 21 21 <link linkend="opt-services.nginx.enable"><literal>services.nginx</literal></link>) 22 - and a database (it's recommended to use 22 + and a database (it’s recommended to use 23 23 <link linkend="opt-services.postgresql.enable"><literal>services.postgresql</literal></link>). 24 24 </para> 25 25 <para> ··· 67 67 and <literal>nginx</literal>. The <literal>config</literal> 68 68 attribute set is used by the imperative installer and all values 69 69 are written to an additional file to ensure that changes can be 70 - applied by changing the module's options. 70 + applied by changing the module’s options. 71 71 </para> 72 72 <para> 73 73 In case the application serves multiple domains (those are checked 74 74 with 75 75 <link xlink:href="http://php.net/manual/en/reserved.variables.server.php"><literal>$_SERVER['HTTP_HOST']</literal></link>) 76 - it's needed to add them to 76 + it’s needed to add them to 77 77 <link linkend="opt-services.nextcloud.config.extraTrustedDomains"><literal>services.nextcloud.config.extraTrustedDomains</literal></link>. 78 78 </para> 79 79 <para> ··· 101 101 which is generated by the module and linked from the store to 102 102 ensure that all values from <filename>config.php</filename> 103 103 can be modified by the module. However 104 - <filename>config.php</filename> manages the application's 105 - state and shouldn't be touched manually because of that. 104 + <filename>config.php</filename> manages the application’s 105 + state and shouldn’t be touched manually because of that. 106 106 </para> 107 107 <warning> 108 108 <para> 109 - Don't delete <filename>config.php</filename>! This file 110 - tracks the application's state and a deletion can cause 109 + Don’t delete <filename>config.php</filename>! This file 110 + tracks the application’s state and a deletion can cause 111 111 unwanted side-effects! 112 112 </para> 113 113 </warning> 114 114 <warning> 115 115 <para> 116 - Don't rerun 116 + Don’t rerun 117 117 <literal>nextcloud-occ maintenance:install</literal>! This 118 118 command tries to install the application and can cause 119 119 unwanted side-effects! ··· 123 123 <listitem> 124 124 <para> 125 125 <emphasis role="strong">Multiple version upgrades.</emphasis> 126 - Nextcloud doesn't allow to move more than one major-version 127 - forward. E.g., if you're on <literal>v16</literal>, you cannot 126 + Nextcloud doesn’t allow to move more than one major-version 127 + forward. E.g., if you’re on <literal>v16</literal>, you cannot 128 128 upgrade to <literal>v18</literal>, you need to upgrade to 129 129 <literal>v17</literal> first. This is ensured automatically as 130 130 long as the ··· 159 159 this is most likely because the maintenance mode is 160 160 active. It can be deactivated by running 161 161 <command>nextcloud-occ maintenance:mode --off</command>. 162 - It's advisable though to check the logs first on why the 162 + It’s advisable though to check the logs first on why the 163 163 maintenance mode was activated. 164 164 </para> 165 165 </listitem> ··· 175 175 <emphasis>deleting</emphasis> 176 176 <filename>/var/lib/nextcloud/config/config.php</filename>. 177 177 This is the only time advisable because the fresh install 178 - doesn't have any state that can be lost. In case that 179 - doesn't help, an entire re-creation can be forced via 178 + doesn’t have any state that can be lost. In case that 179 + doesn’t help, an entire re-creation can be forced via 180 180 <command>rm -rf ~nextcloud/</command>. 181 181 </para> 182 182 </listitem> ··· 189 189 <link xlink:href="https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/encryption_configuration.html">server-side 190 190 encryption (SSE)</link>. This is not an end-to-end encryption, 191 191 but can be used to encrypt files that will be persisted to 192 - external storage such as S3. Please note that this won't work 193 - anymore when using OpenSSL 3 for PHP's openssl extension 192 + external storage such as S3. Please note that this won’t work 193 + anymore when using OpenSSL 3 for PHP’s openssl extension 194 194 because this is implemented using the legacy cipher RC4. If 195 195 <xref linkend="opt-system.stateVersion"></xref> is 196 196 <emphasis>above</emphasis> <literal>22.05</literal>, this is ··· 202 202 </itemizedlist> 203 203 </section> 204 204 <section xml:id="module-services-nextcloud-httpd"> 205 - <title>Using an alternative webserver as reverse-proxy (e.g. 206 - <literal>httpd</literal>)</title> 205 + <title>Using an alternative webserver as reverse-proxy 206 + (e.g. <literal>httpd</literal>)</title> 207 207 <para> 208 208 By default, <literal>nginx</literal> is used as reverse-proxy for 209 - <literal>nextcloud</literal>. However, it's possible to use e.g. 210 - <literal>httpd</literal> by explicitly disabling 209 + <literal>nextcloud</literal>. However, it’s possible to use 210 + e.g. <literal>httpd</literal> by explicitly disabling 211 211 <literal>nginx</literal> using 212 212 <xref linkend="opt-services.nginx.enable"></xref> and fixing the 213 213 settings <literal>listen.owner</literal> &amp; ··· 292 292 While minor and patch-level updates are no problem and can be done 293 293 directly in the package-expression (and should be backported to 294 294 supported stable branches after that), major-releases should be 295 - added in a new attribute (e.g. Nextcloud 295 + added in a new attribute (e.g. Nextcloud 296 296 <literal>v19.0.0</literal> should be available in 297 297 <literal>nixpkgs</literal> as 298 298 <literal>pkgs.nextcloud19</literal>). To provide simple upgrade 299 - paths it's generally useful to backport those as well to stable 300 - branches. As long as the package-default isn't altered, this won't 299 + paths it’s generally useful to backport those as well to stable 300 + branches. As long as the package-default isn’t altered, this won’t 301 301 break existing setups. After that, the versioning-warning in the 302 302 <literal>nextcloud</literal>-module should be updated to make sure 303 303 that the ··· 322 322 } 323 323 </programlisting> 324 324 <para> 325 - Ideally we should make sure that it's possible to jump two NixOS 326 - versions forward: i.e. the warnings and the logic in the module 327 - should guard a user to upgrade from a Nextcloud on e.g. 19.09 to a 325 + Ideally we should make sure that it’s possible to jump two NixOS 326 + versions forward: i.e. the warnings and the logic in the module 327 + should guard a user to upgrade from a Nextcloud on e.g. 19.09 to a 328 328 Nextcloud on 20.09. 329 329 </para> 330 330 </section>
+1 -1
nixos/modules/services/web-apps/plausible.nix
··· 293 293 294 294 meta.maintainers = with maintainers; [ ma27 ]; 295 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` 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` 297 297 meta.doc = ./plausible.xml; 298 298 }
+10 -10
nixos/modules/services/web-servers/garage-doc.xml
··· 36 36 <para> 37 37 Until 1.0 is released, patch-level upgrades are considered as 38 38 minor version upgrades. Minor version upgrades are considered as 39 - major version upgrades. i.e. 0.6 to 0.7 is a major version 39 + major version upgrades. i.e. 0.6 to 0.7 is a major version 40 40 upgrade. 41 41 </para> 42 42 </warning> ··· 45 45 <para> 46 46 <emphasis role="strong">Straightforward upgrades (patch-level 47 47 upgrades).</emphasis> Upgrades must be performed one by one, 48 - i.e. for each node, stop it, upgrade it : change 48 + i.e. for each node, stop it, upgrade it : change 49 49 <link linkend="opt-system.stateVersion">stateVersion</link> or 50 50 <link linkend="opt-services.garage.package">services.garage.package</link>, 51 51 restart it if it was not already by switching. ··· 55 55 <para> 56 56 <emphasis role="strong">Multiple version upgrades.</emphasis> 57 57 Garage do not provide any guarantee on moving more than one 58 - major-version forward. E.g., if you're on 58 + major-version forward. E.g., if you’re on 59 59 <literal>0.7</literal>, you cannot upgrade to 60 60 <literal>0.9</literal>. You need to upgrade to 61 61 <literal>0.8</literal> first. As long as ··· 110 110 </listitem> 111 111 <listitem> 112 112 <para> 113 - Backup the metadata folder of ALL your nodes, e.g. for a 113 + Backup the metadata folder of ALL your nodes, e.g. for a 114 114 metadata directory (the default one) in 115 115 <literal>/var/lib/garage/meta</literal>, you can run 116 116 <literal>pushd /var/lib/garage; tar -acf meta-v0.7.tar.zst meta/; popd</literal>. ··· 166 166 While patch-level updates are no problem and can be done directly 167 167 in the package-expression (and should be backported to supported 168 168 stable branches after that), major-releases should be added in a 169 - new attribute (e.g. Garage <literal>v0.8.0</literal> should be 169 + new attribute (e.g. Garage <literal>v0.8.0</literal> should be 170 170 available in <literal>nixpkgs</literal> as 171 171 <literal>pkgs.garage_0_8_0</literal>). To provide simple upgrade 172 - paths it's generally useful to backport those as well to stable 173 - branches. As long as the package-default isn't altered, this won't 172 + paths it’s generally useful to backport those as well to stable 173 + branches. As long as the package-default isn’t altered, this won’t 174 174 break existing setups. After that, the versioning-warning in the 175 175 <literal>garage</literal>-module should be updated to make sure 176 176 that the ··· 195 195 } 196 196 </programlisting> 197 197 <para> 198 - Ideally we should make sure that it's possible to jump two NixOS 199 - versions forward: i.e. the warnings and the logic in the module 200 - should guard a user to upgrade from a Garage on e.g. 22.11 to a 198 + Ideally we should make sure that it’s possible to jump two NixOS 199 + versions forward: i.e. the warnings and the logic in the module 200 + should guard a user to upgrade from a Garage on e.g. 22.11 to a 201 201 Garage on 23.11. 202 202 </para> 203 203 </section>
+1 -1
nixos/modules/services/web-servers/garage.nix
··· 10 10 { 11 11 meta = { 12 12 # Don't edit the docbook xml directly, edit the md and generate it: 13 - # `pandoc garage-doc.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 > garage-doc.xml` 13 + # `pandoc garage-doc.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 > garage-doc.xml` 14 14 doc = ./garage-doc.xml; 15 15 maintainers = with pkgs.lib.maintainers; [ raitobezarius ]; 16 16 };
+1 -1
nixos/modules/services/x11/desktop-managers/gnome.nix
··· 67 67 68 68 meta = { 69 69 # Don't edit the docbook xml directly, edit the md and generate it: 70 - # `pandoc gnome.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 > gnome.xml` 70 + # `pandoc gnome.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 > gnome.xml` 71 71 doc = ./gnome.xml; 72 72 maintainers = teams.gnome.members; 73 73 };
+1 -1
nixos/modules/services/x11/desktop-managers/pantheon.nix
··· 18 18 19 19 meta = { 20 20 # Don't edit the docbook xml directly, edit the md and generate it: 21 - # `pandoc pantheon.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 > pantheon.xml` 21 + # `pandoc pantheon.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 > pantheon.xml` 22 22 doc = ./pantheon.xml; 23 23 maintainers = teams.pantheon.members; 24 24 };
+5 -5
nixos/modules/services/x11/desktop-managers/pantheon.xml
··· 17 17 services.xserver.desktopManager.pantheon.enable = true; 18 18 </programlisting> 19 19 <para> 20 - This automatically enables LightDM and Pantheon's LightDM greeter. 21 - If you'd like to disable this, set 20 + This automatically enables LightDM and Pantheon’s LightDM greeter. 21 + If you’d like to disable this, set 22 22 </para> 23 23 <programlisting> 24 24 services.xserver.displayManager.lightdm.greeters.pantheon.enable = false; ··· 27 27 <para> 28 28 but please be aware using Pantheon without LightDM as a display 29 29 manager will break screenlocking from the UI. The NixOS module for 30 - Pantheon installs all of Pantheon's default applications. If you'd 31 - like to not install Pantheon's apps, set 30 + Pantheon installs all of Pantheon’s default applications. If you’d 31 + like to not install Pantheon’s apps, set 32 32 </para> 33 33 <programlisting> 34 34 services.pantheon.apps.enable = false; ··· 86 86 <para> 87 87 please note that, like how the NixOS options describe these as 88 88 extra plugins, this would only add to the default plugins included 89 - with the programs. If for some reason you'd like to configure 89 + with the programs. If for some reason you’d like to configure 90 90 which plugins to use exactly, both packages have an argument for 91 91 this: 92 92 </para>