diff --git a/nixos/doc/manual/md-to-db.sh b/nixos/doc/manual/md-to-db.sh index 4698e94f508b..abf9417c50a2 100755 --- a/nixos/doc/manual/md-to-db.sh +++ b/nixos/doc/manual/md-to-db.sh @@ -50,3 +50,18 @@ for mf in ${MD_FILES[*]}; do done popd + +# now handle module chapters. we'll need extra checks to ensure that we don't process +# markdown files we're not interested in, so we'll require an x.nix file for ever x.md +# that we'll convert to xml. +pushd "$DIR/../../modules" + +mapfile -t MD_FILES < <(find . -type f -regex '.*\.md$') + +for mf in ${MD_FILES[*]}; do + [ -f "${mf%.md}.nix" ] || continue + + pandoc --top-level-division=chapter "$mf" "${pandoc_flags[@]}" -o "${mf%.md}.xml" +done + +popd diff --git a/nixos/modules/i18n/input-method/default.nix b/nixos/modules/i18n/input-method/default.nix index 3fa1f4c643d5..452b0d7b264e 100644 --- a/nixos/modules/i18n/input-method/default.nix +++ b/nixos/modules/i18n/input-method/default.nix @@ -66,8 +66,7 @@ in meta = { maintainers = with lib.maintainers; [ ericsagnes ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./default.xml; }; diff --git a/nixos/modules/i18n/input-method/default.xml b/nixos/modules/i18n/input-method/default.xml index 232952119805..b3706086befd 100644 --- a/nixos/modules/i18n/input-method/default.xml +++ b/nixos/modules/i18n/input-method/default.xml @@ -234,7 +234,7 @@ i18n.inputMethod = { }; - Note: The + Note: The option can be used to choose uim toolbar. diff --git a/nixos/modules/programs/digitalbitbox/doc.md b/nixos/modules/programs/digitalbitbox/default.md similarity index 100% rename from nixos/modules/programs/digitalbitbox/doc.md rename to nixos/modules/programs/digitalbitbox/default.md diff --git a/nixos/modules/programs/digitalbitbox/default.nix b/nixos/modules/programs/digitalbitbox/default.nix index 2aaa307782de..fb18c52187b6 100644 --- a/nixos/modules/programs/digitalbitbox/default.nix +++ b/nixos/modules/programs/digitalbitbox/default.nix @@ -33,9 +33,8 @@ in }; meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc doc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > doc.xml` - doc = ./doc.xml; + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh + doc = ./default.xml; maintainers = with lib.maintainers; [ vidbina ]; }; } diff --git a/nixos/modules/programs/digitalbitbox/doc.xml b/nixos/modules/programs/digitalbitbox/default.xml similarity index 82% rename from nixos/modules/programs/digitalbitbox/doc.xml rename to nixos/modules/programs/digitalbitbox/default.xml index 301506405047..d5e1110bafb2 100644 --- a/nixos/modules/programs/digitalbitbox/doc.xml +++ b/nixos/modules/programs/digitalbitbox/default.xml @@ -13,11 +13,11 @@ programs.digitalbitbox.enable = true; and bundles the digitalbitbox package (see - ), which contains - the dbb-app and dbb-cli - binaries, along with the hardware module (see - ) which - sets up the necessary udev rules to access the device. + ), which contains the + dbb-app and dbb-cli binaries, + along with the hardware module (see + ) which sets up + the necessary udev rules to access the device. Enabling the digitalbitbox module is pretty much the easiest way to @@ -25,7 +25,7 @@ programs.digitalbitbox.enable = true; For more information, see - https://digitalbitbox.com/start_linux. + https://digitalbitbox.com/start_linux.
Package diff --git a/nixos/modules/programs/plotinus.nix b/nixos/modules/programs/plotinus.nix index 3f7bbba42b9f..cc73df2f791f 100644 --- a/nixos/modules/programs/plotinus.nix +++ b/nixos/modules/programs/plotinus.nix @@ -8,8 +8,7 @@ in { meta = { maintainers = pkgs.plotinus.meta.maintainers; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./plotinus.xml; }; diff --git a/nixos/modules/programs/plotinus.xml b/nixos/modules/programs/plotinus.xml index 6d5147eaa7ed..eb8c65f94bc9 100644 --- a/nixos/modules/programs/plotinus.xml +++ b/nixos/modules/programs/plotinus.xml @@ -6,7 +6,7 @@ Upstream documentation: - https://github.com/p-e-w/plotinus + https://github.com/p-e-w/plotinus Plotinus is a searchable command palette in every modern GTK diff --git a/nixos/modules/programs/zsh/oh-my-zsh.nix b/nixos/modules/programs/zsh/oh-my-zsh.nix index 7a8fd88414a6..a2d6eb14bdfd 100644 --- a/nixos/modules/programs/zsh/oh-my-zsh.nix +++ b/nixos/modules/programs/zsh/oh-my-zsh.nix @@ -142,7 +142,6 @@ in }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./oh-my-zsh.xml; } diff --git a/nixos/modules/programs/zsh/oh-my-zsh.xml b/nixos/modules/programs/zsh/oh-my-zsh.xml index 6125ba1488ab..be868326c25b 100644 --- a/nixos/modules/programs/zsh/oh-my-zsh.xml +++ b/nixos/modules/programs/zsh/oh-my-zsh.xml @@ -93,7 +93,7 @@
Package your own customizations - If third-party customizations (e.g. new themes) are supposed to be + If third-party customizations (e.g. new themes) are supposed to be added to oh-my-zsh there are several pitfalls to keep in mind: diff --git a/nixos/modules/security/acme/doc.md b/nixos/modules/security/acme/default.md similarity index 100% rename from nixos/modules/security/acme/doc.md rename to nixos/modules/security/acme/default.md diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix index dfa3742daccc..baa7a516ce34 100644 --- a/nixos/modules/security/acme/default.nix +++ b/nixos/modules/security/acme/default.nix @@ -916,8 +916,7 @@ in { meta = { maintainers = lib.teams.acme.members; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` - doc = ./doc.xml; + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh + doc = ./default.xml; }; } diff --git a/nixos/modules/security/acme/doc.xml b/nixos/modules/security/acme/default.xml similarity index 95% rename from nixos/modules/security/acme/doc.xml rename to nixos/modules/security/acme/default.xml index 42c73300d8b9..766421c62373 100644 --- a/nixos/modules/security/acme/doc.xml +++ b/nixos/modules/security/acme/default.xml @@ -19,25 +19,24 @@ To use the ACME module, you must accept the provider’s terms of service by setting - to + to true. The Let’s Encrypt ToS can be found here. You must also set an email address to be used when creating accounts with Let’s Encrypt. You can set this for all certs with - and/or on - a per-cert basis with - . This + and/or on a + per-cert basis with + . This address is only used for registration and renewal reminders, and cannot be used to administer the certificates in any way. Alternatively, you can use a different ACME server by changing the - option - to a provider of your choosing, or just change the server for one - cert with - . + option to a + provider of your choosing, or just change the server for one cert + with . You will need an HTTP server or DNS server for verification. For @@ -173,7 +172,7 @@ security.acme.certs."foo.example.com" = { /var/lib/acme/foo.example.com. - Refer to for all available + Refer to for all available configuration options for the security.acme module. @@ -275,9 +274,10 @@ systemd.services.dns-rfc2136-conf = { You must follow the guide above on configuring DNS-01 validation first, however instead of setting the options for one certificate - (e.g. ) - you will set them as defaults - (e.g. ). + (e.g. + ) you + will set them as defaults (e.g. + ). # Configure ACME appropriately diff --git a/nixos/modules/services/backup/borgbackup.nix b/nixos/modules/services/backup/borgbackup.nix index bb037fc13ee6..5489aac0111f 100644 --- a/nixos/modules/services/backup/borgbackup.nix +++ b/nixos/modules/services/backup/borgbackup.nix @@ -226,8 +226,7 @@ let in { meta.maintainers = with maintainers; [ dotlambda ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./borgbackup.xml; ###### interface diff --git a/nixos/modules/services/backup/borgbackup.xml b/nixos/modules/services/backup/borgbackup.xml index 1c1233b11241..1b864d6cdd56 100644 --- a/nixos/modules/services/backup/borgbackup.xml +++ b/nixos/modules/services/backup/borgbackup.xml @@ -6,7 +6,7 @@ Upstream documentation: - https://borgbackup.readthedocs.io/ + https://borgbackup.readthedocs.io/ BorgBackup @@ -200,9 +200,9 @@ sudo borg init --encryption=repokey-blake2 \ protect your data from disk failure, ransomware and theft. - It can be installed in NixOS e.g. by adding + It can be installed in NixOS e.g. by adding pkgs.vorta to - . + . Details about using Vorta can be found under diff --git a/nixos/modules/services/databases/foundationdb.nix b/nixos/modules/services/databases/foundationdb.nix index 0cdb832e4bc9..3d72d8ec6d27 100644 --- a/nixos/modules/services/databases/foundationdb.nix +++ b/nixos/modules/services/databases/foundationdb.nix @@ -424,8 +424,7 @@ in }; }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./foundationdb.xml; meta.maintainers = with lib.maintainers; [ thoughtpolice ]; } diff --git a/nixos/modules/services/databases/foundationdb.xml b/nixos/modules/services/databases/foundationdb.xml index e65458779d1b..e4a012604215 100644 --- a/nixos/modules/services/databases/foundationdb.xml +++ b/nixos/modules/services/databases/foundationdb.xml @@ -6,7 +6,7 @@ Upstream documentation: - https://apple.github.io/foundationdb/ + https://apple.github.io/foundationdb/ Maintainer: Austin Seipp @@ -417,7 +417,7 @@ $ sudo -u foundationdb fdbbackup status -t default FoundationDB is a complex piece of software, and requires careful administration to properly use. Full documentation for administration can be found here: - https://apple.github.io/foundationdb/. + https://apple.github.io/foundationdb/.
diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index 9a9a083b7c3a..40a1acb39a3d 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -585,8 +585,7 @@ in }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./postgresql.xml; meta.maintainers = with lib.maintainers; [ thoughtpolice danbst ]; } diff --git a/nixos/modules/services/databases/postgresql.xml b/nixos/modules/services/databases/postgresql.xml index 7ca03264e366..6aa2a3812ffa 100644 --- a/nixos/modules/services/databases/postgresql.xml +++ b/nixos/modules/services/databases/postgresql.xml @@ -6,10 +6,10 @@ Upstream documentation: - http://www.postgresql.org/docs/ + http://www.postgresql.org/docs/ - PostgreSQL is an advanced, free relational database. + PostgreSQL is an advanced, free relational database.
Configuring @@ -23,17 +23,17 @@ services.postgresql.package = pkgs.postgresql_11; Note that you are required to specify the desired version of - PostgreSQL (e.g. pkgs.postgresql_11). Since + PostgreSQL (e.g. pkgs.postgresql_11). Since upgrading your PostgreSQL version requires a database dump and reload (see below), NixOS cannot provide a default value for - such as - the most recent release of PostgreSQL. + such as the + most recent release of PostgreSQL. By default, PostgreSQL stores its databases in /var/lib/postgresql/$psqlSchema. You can override this using - , e.g. + , e.g. services.postgresql.dataDir = "/data/postgresql"; @@ -122,7 +122,7 @@ $ nix-instantiate --eval -A postgresql_13.psqlSchema the new one. You may supply arguments like --jobs 4 and --link to speedup migration process. See - https://www.postgresql.org/docs/current/pgupgrade.html + https://www.postgresql.org/docs/current/pgupgrade.html for details. @@ -130,10 +130,9 @@ $ nix-instantiate --eval -A postgresql_13.psqlSchema Change postgresql package in NixOS configuration to the one you were upgrading to via - . - Rebuild NixOS. This should start new postgres using upgraded - data directory and all services you stopped during the - upgrade. + . Rebuild + NixOS. This should start new postgres using upgraded data + directory and all services you stopped during the upgrade. @@ -151,9 +150,8 @@ $ nix-instantiate --eval -A postgresql_13.psqlSchema For PostgreSQL < 14, run (as su -l postgres in the - , - in this example - /var/lib/postgresql/13): + , in + this example /var/lib/postgresql/13): $ ./analyze_new_cluster.sh diff --git a/nixos/modules/services/desktops/flatpak.nix b/nixos/modules/services/desktops/flatpak.nix index 367d367d0bce..b08d7db226da 100644 --- a/nixos/modules/services/desktops/flatpak.nix +++ b/nixos/modules/services/desktops/flatpak.nix @@ -7,8 +7,7 @@ let cfg = config.services.flatpak; in { meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc flatpak.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 > flatpak.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./flatpak.xml; maintainers = pkgs.flatpak.meta.maintainers; }; diff --git a/nixos/modules/services/desktops/flatpak.xml b/nixos/modules/services/desktops/flatpak.xml index 3a4cfc5ea403..6230a7b1fa04 100644 --- a/nixos/modules/services/desktops/flatpak.xml +++ b/nixos/modules/services/desktops/flatpak.xml @@ -6,7 +6,7 @@ Upstream documentation: - https://github.com/flatpak/flatpak/wiki + https://github.com/flatpak/flatpak/wiki Flatpak is a system for building, distributing, and running diff --git a/nixos/modules/services/development/blackfire.nix b/nixos/modules/services/development/blackfire.nix index 7d3365efa84d..58ef75d23da8 100644 --- a/nixos/modules/services/development/blackfire.nix +++ b/nixos/modules/services/development/blackfire.nix @@ -11,8 +11,7 @@ let in { meta = { maintainers = pkgs.blackfire.meta.maintainers; - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc blackfire.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 > blackfire.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./blackfire.xml; }; diff --git a/nixos/modules/services/development/blackfire.xml b/nixos/modules/services/development/blackfire.xml index f5e622186329..99afaa11e047 100644 --- a/nixos/modules/services/development/blackfire.xml +++ b/nixos/modules/services/development/blackfire.xml @@ -6,7 +6,7 @@ Upstream documentation: - https://blackfire.io/docs/introduction + https://blackfire.io/docs/introduction Blackfire is a diff --git a/nixos/modules/services/editors/emacs.nix b/nixos/modules/services/editors/emacs.nix index d30fd07577c3..2aa382987169 100644 --- a/nixos/modules/services/editors/emacs.nix +++ b/nixos/modules/services/editors/emacs.nix @@ -99,7 +99,6 @@ in environment.variables.EDITOR = mkIf cfg.defaultEditor (mkOverride 900 "${editorScript}/bin/emacseditor"); }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./emacs.xml; } diff --git a/nixos/modules/services/editors/emacs.xml b/nixos/modules/services/editors/emacs.xml index 5e4f3e67427c..d510556c29c3 100644 --- a/nixos/modules/services/editors/emacs.xml +++ b/nixos/modules/services/editors/emacs.xml @@ -10,11 +10,11 @@ Emacs runs within a graphical desktop environment using the X Window System, but works equally well on a text terminal. Under macOS, a - "Mac port" edition is available, which uses Apple's native - GUI frameworks. + Mac port edition is available, which uses Apple’s + native GUI frameworks. - Nixpkgs provides a superior environment for running Emacs. It's + Nixpkgs provides a superior environment for running Emacs. It’s simple to create custom builds by overriding the default packages. Chaotic collections of Emacs Lisp code and extensions can be brought under control using declarative package management. NixOS even @@ -25,8 +25,8 @@ Installing Emacs Emacs can be installed in the normal way for Nix (see - ). In addition, a - NixOS service can be enabled. + ). In addition, a NixOS + service can be enabled.
The Different Releases of Emacs @@ -63,14 +63,14 @@ - Emacs with the "Mac port" patches, providing a - more native look and feel under macOS. + Emacs with the Mac port patches, providing + a more native look and feel under macOS. - If those aren't suitable, then the following imitation Emacs + If those aren’t suitable, then the following imitation Emacs editors are also available in Nixpkgs: Zile, mg, @@ -207,9 +207,9 @@ nix-env -f "<nixpkgs>" -qaP -A emacs.pkgs.orgPackages If you are on NixOS, you can install this particular Emacs for all users by adding it to the list of system packages (see - ). Simply - modify your file configuration.nix to make - it contain: + ). Simply modify + your file configuration.nix to make it + contain: @@ -224,7 +224,7 @@ nix-env -f "<nixpkgs>" -qaP -A emacs.pkgs.orgPackages In this case, the next nixos-rebuild switch will take care of adding your emacs to the PATH environment variable (see - ). + ). If you are not on NixOS or want to install this particular Emacs @@ -292,7 +292,7 @@ in [...] NixOS provides an optional systemd service which launches Emacs - daemon with the user's login session. + daemon with the user’s login session. Source: @@ -315,7 +315,7 @@ services.emacs.package = import /home/cassou/.emacs.d { pkgs = pkgs; }; emacsWithPackages. - Ensure that the Emacs server is enabled for your user's Emacs + Ensure that the Emacs server is enabled for your user’s Emacs configuration, either by customizing the server-mode variable, or by adding (server-start) to @@ -353,7 +353,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
Configuring the <varname>EDITOR</varname> variable - If is + If is true, the EDITOR variable will be set to a wrapper script which launches emacsclient. @@ -452,7 +452,7 @@ systemctl --user enable emacs To install the DocBook 5.0 schemas, either add pkgs.docbook5 to - + (NixOS), or run nix-env -f '<nixpkgs>' -iA docbook5 (Nix). diff --git a/nixos/modules/services/hardware/trezord.nix b/nixos/modules/services/hardware/trezord.nix index 708f02fafc2a..ae19b7f3e5b4 100644 --- a/nixos/modules/services/hardware/trezord.nix +++ b/nixos/modules/services/hardware/trezord.nix @@ -8,8 +8,7 @@ in { ### docs meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./trezord.xml; }; diff --git a/nixos/modules/services/hardware/trezord.xml b/nixos/modules/services/hardware/trezord.xml index bf9409c7d634..6cdff8219801 100644 --- a/nixos/modules/services/hardware/trezord.xml +++ b/nixos/modules/services/hardware/trezord.xml @@ -12,7 +12,7 @@ GPG and a password manager. For more information, guides and documentation, see - https://wiki.trezor.io. + https://wiki.trezor.io. To enable Trezor support, add the following to your diff --git a/nixos/modules/services/mail/mailman.nix b/nixos/modules/services/mail/mailman.nix index 622efd87e7b7..89c11a5d2f73 100644 --- a/nixos/modules/services/mail/mailman.nix +++ b/nixos/modules/services/mail/mailman.nix @@ -642,8 +642,7 @@ in { meta = { maintainers = with lib.maintainers; [ lheckemann qyliss ma27 ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./mailman.xml; }; diff --git a/nixos/modules/services/matrix/mjolnir.nix b/nixos/modules/services/matrix/mjolnir.nix index 372b8ced1c21..d568beb2e7aa 100644 --- a/nixos/modules/services/matrix/mjolnir.nix +++ b/nixos/modules/services/matrix/mjolnir.nix @@ -236,8 +236,7 @@ in }; meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./mjolnir.xml; maintainers = with maintainers; [ jojosch ]; }; diff --git a/nixos/modules/services/matrix/synapse.nix b/nixos/modules/services/matrix/synapse.nix index 4f87744f8cc6..fff2e31abe6e 100644 --- a/nixos/modules/services/matrix/synapse.nix +++ b/nixos/modules/services/matrix/synapse.nix @@ -801,8 +801,7 @@ in { meta = { buildDocsInSandbox = false; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./synapse.xml; maintainers = teams.matrix.members; }; diff --git a/nixos/modules/services/matrix/synapse.xml b/nixos/modules/services/matrix/synapse.xml index 822f2c324ad9..62c3c62d3d19 100644 --- a/nixos/modules/services/matrix/synapse.xml +++ b/nixos/modules/services/matrix/synapse.xml @@ -131,7 +131,7 @@ in { services.matrix-synapse.settings.enable_registration = true;. Otherwise, or you can generate a registration secret with pwgen -s 64 1 and set it with - . + . To create a new user or admin, run the following after you have set the secret and have rebuilt NixOS: @@ -151,7 +151,7 @@ Success! When using - , + , the secret will end up in the world-readable store. Instead it’s recommended to deploy the secret in an additional file like this: @@ -173,9 +173,9 @@ registration_shared_secret: your-very-secret-secret nixops1 or sops-nix - to - e.g. /run/secrets/matrix-shared-secret - and ensure that it’s readable by + to e.g. + /run/secrets/matrix-shared-secret and + ensure that it’s readable by matrix-synapse. @@ -217,7 +217,7 @@ registration_shared_secret: your-very-secret-secret https://element.myhostname.example.org and https://element.example.org. Alternatively, you can use the hosted copy at - https://app.element.io/, + https://app.element.io/, or use other web clients or native client applications. Due to the /.well-known urls set up done above, many clients should fill in the required connection details diff --git a/nixos/modules/services/misc/gitlab.nix b/nixos/modules/services/misc/gitlab.nix index c5eed5960e54..892e5307fefc 100644 --- a/nixos/modules/services/misc/gitlab.nix +++ b/nixos/modules/services/misc/gitlab.nix @@ -1502,8 +1502,7 @@ in { }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./gitlab.xml; } diff --git a/nixos/modules/services/misc/gitlab.xml b/nixos/modules/services/misc/gitlab.xml index c2c4dc895e9c..69c5cd16e01c 100644 --- a/nixos/modules/services/misc/gitlab.xml +++ b/nixos/modules/services/misc/gitlab.xml @@ -97,7 +97,7 @@ services.gitlab = { enabled for fetching incoming mail. - Refer to for all available + Refer to for all available configuration options for the services.gitlab module. diff --git a/nixos/modules/services/misc/sourcehut/sourcehut.md b/nixos/modules/services/misc/sourcehut/default.md similarity index 100% rename from nixos/modules/services/misc/sourcehut/sourcehut.md rename to nixos/modules/services/misc/sourcehut/default.md diff --git a/nixos/modules/services/misc/sourcehut/default.nix b/nixos/modules/services/misc/sourcehut/default.nix index c95761bbe97e..38531b96961a 100644 --- a/nixos/modules/services/misc/sourcehut/default.nix +++ b/nixos/modules/services/misc/sourcehut/default.nix @@ -1390,8 +1390,7 @@ in '') ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` - meta.doc = ./sourcehut.xml; + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh + meta.doc = ./default.xml; meta.maintainers = with maintainers; [ tomberek ]; } diff --git a/nixos/modules/services/misc/sourcehut/sourcehut.xml b/nixos/modules/services/misc/sourcehut/default.xml similarity index 94% rename from nixos/modules/services/misc/sourcehut/sourcehut.xml rename to nixos/modules/services/misc/sourcehut/default.xml index d54a9c744173..cc309903889a 100644 --- a/nixos/modules/services/misc/sourcehut/sourcehut.xml +++ b/nixos/modules/services/misc/sourcehut/default.xml @@ -97,14 +97,14 @@ in {
- Using an alternative webserver as reverse-proxy - (e.g. <literal>httpd</literal>) + Using an alternative webserver as reverse-proxy (e.g. + <literal>httpd</literal>) By default, nginx is used as reverse-proxy for - sourcehut. However, it’s possible to use - e.g. httpd by explicitly disabling + sourcehut. However, it’s possible to use e.g. + httpd by explicitly disabling nginx using - and fixing the + and fixing the settings.
diff --git a/nixos/modules/services/misc/taskserver/doc.md b/nixos/modules/services/misc/taskserver/default.md similarity index 100% rename from nixos/modules/services/misc/taskserver/doc.md rename to nixos/modules/services/misc/taskserver/default.md diff --git a/nixos/modules/services/misc/taskserver/default.nix b/nixos/modules/services/misc/taskserver/default.nix index 9a97d236452e..dbb3ede4010d 100644 --- a/nixos/modules/services/misc/taskserver/default.nix +++ b/nixos/modules/services/misc/taskserver/default.nix @@ -566,7 +566,6 @@ in { }) ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` - meta.doc = ./doc.xml; + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh + meta.doc = ./default.xml; } diff --git a/nixos/modules/services/misc/taskserver/doc.xml b/nixos/modules/services/misc/taskserver/default.xml similarity index 95% rename from nixos/modules/services/misc/taskserver/doc.xml rename to nixos/modules/services/misc/taskserver/default.xml index 06ec397661a0..a46687314915 100644 --- a/nixos/modules/services/misc/taskserver/doc.xml +++ b/nixos/modules/services/misc/taskserver/default.xml @@ -7,7 +7,7 @@ Upstream documentation: - https://taskwarrior.org/docs/#taskd + https://taskwarrior.org/docs/#taskd
Configuration @@ -43,8 +43,8 @@ imperatively, the nixos-taskserver tool is used for addition and deletion of organisations along with users and groups defined by - and - as well for imperative set up. + and as + well for imperative set up. The tool is designed to not interfere if the command is used to diff --git a/nixos/modules/services/misc/weechat.nix b/nixos/modules/services/misc/weechat.nix index 3fa408d9c88f..cb119f7c3fc1 100644 --- a/nixos/modules/services/misc/weechat.nix +++ b/nixos/modules/services/misc/weechat.nix @@ -59,7 +59,6 @@ in }; }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc weechat.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 > weechat.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./weechat.xml; } diff --git a/nixos/modules/services/monitoring/parsedmarc.md b/nixos/modules/services/monitoring/parsedmarc.md index 5a17f79da5d4..eac07e0cc9fe 100644 --- a/nixos/modules/services/monitoring/parsedmarc.md +++ b/nixos/modules/services/monitoring/parsedmarc.md @@ -25,7 +25,7 @@ services.parsedmarc = { Note that GeoIP provisioning is disabled in the example for simplicity, but should be turned on for fully functional reports. -## Local mail +## Local mail {#module-services-parsedmarc-local-mail} Instead of watching an external inbox, a local inbox can be automatically provisioned. The recipient's name is by default set to `dmarc`, but can be configured in @@ -49,7 +49,7 @@ services.parsedmarc = { }; ``` -## Grafana and GeoIP +## Grafana and GeoIP {#module-services-parsedmarc-grafana-geoip} The reports can be visualized and summarized with parsedmarc's official Grafana dashboard. For all views to work, and for the data to be complete, GeoIP databases are also required. The following example diff --git a/nixos/modules/services/monitoring/parsedmarc.nix b/nixos/modules/services/monitoring/parsedmarc.nix index 40c76b804559..e663e46cf005 100644 --- a/nixos/modules/services/monitoring/parsedmarc.nix +++ b/nixos/modules/services/monitoring/parsedmarc.nix @@ -539,8 +539,7 @@ in }; }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc parsedmarc.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > parsedmarc.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./parsedmarc.xml; meta.maintainers = [ lib.maintainers.talyz ]; } diff --git a/nixos/modules/services/monitoring/parsedmarc.xml b/nixos/modules/services/monitoring/parsedmarc.xml index 2db5f48d1609..f34d47429d8e 100644 --- a/nixos/modules/services/monitoring/parsedmarc.xml +++ b/nixos/modules/services/monitoring/parsedmarc.xml @@ -31,7 +31,7 @@ services.parsedmarc = { simplicity, but should be turned on for fully functional reports.
-
+
Local mail Instead of watching an external inbox, a local inbox can be @@ -57,7 +57,7 @@ services.parsedmarc = { };
-
+
Grafana and GeoIP The reports can be visualized and summarized with parsedmarc’s diff --git a/nixos/modules/services/monitoring/prometheus/exporters.nix b/nixos/modules/services/monitoring/prometheus/exporters.nix index e9401334352c..33df9e37fb97 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters.nix @@ -323,8 +323,7 @@ in ); meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./exporters.xml; maintainers = [ maintainers.willibutz ]; }; diff --git a/nixos/modules/services/network-filesystems/litestream/litestream.md b/nixos/modules/services/network-filesystems/litestream/default.md similarity index 100% rename from nixos/modules/services/network-filesystems/litestream/litestream.md rename to nixos/modules/services/network-filesystems/litestream/default.md diff --git a/nixos/modules/services/network-filesystems/litestream/default.nix b/nixos/modules/services/network-filesystems/litestream/default.nix index 73ef81a0f56e..5559198d5801 100644 --- a/nixos/modules/services/network-filesystems/litestream/default.nix +++ b/nixos/modules/services/network-filesystems/litestream/default.nix @@ -95,7 +95,6 @@ in users.groups.litestream = {}; }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` - meta.doc = ./litestream.xml; + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh + meta.doc = ./default.xml; } diff --git a/nixos/modules/services/network-filesystems/litestream/litestream.xml b/nixos/modules/services/network-filesystems/litestream/default.xml similarity index 100% rename from nixos/modules/services/network-filesystems/litestream/litestream.xml rename to nixos/modules/services/network-filesystems/litestream/default.xml diff --git a/nixos/modules/services/networking/firefox-syncserver.nix b/nixos/modules/services/networking/firefox-syncserver.nix index 9733fb16d903..663010999ff8 100644 --- a/nixos/modules/services/networking/firefox-syncserver.nix +++ b/nixos/modules/services/networking/firefox-syncserver.nix @@ -311,8 +311,7 @@ in meta = { maintainers = with lib.maintainers; [ pennae ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc firefox-syncserver.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > firefox-syncserver.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./firefox-syncserver.xml; }; } diff --git a/nixos/modules/services/networking/mosquitto.nix b/nixos/modules/services/networking/mosquitto.nix index 270450cb0c62..6c7e1ed720e0 100644 --- a/nixos/modules/services/networking/mosquitto.nix +++ b/nixos/modules/services/networking/mosquitto.nix @@ -671,8 +671,7 @@ in meta = { maintainers = with lib.maintainers; [ pennae ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc mosquitto.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > mosquitto.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./mosquitto.xml; }; } diff --git a/nixos/modules/services/networking/pleroma.nix b/nixos/modules/services/networking/pleroma.nix index 287e189e2fe0..bbd521767670 100644 --- a/nixos/modules/services/networking/pleroma.nix +++ b/nixos/modules/services/networking/pleroma.nix @@ -147,7 +147,6 @@ in { }; meta.maintainers = with lib.maintainers; [ ninjatrappeur ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./pleroma.xml; } diff --git a/nixos/modules/services/networking/pleroma.xml b/nixos/modules/services/networking/pleroma.xml index 9a29512d363a..2a81e166d102 100644 --- a/nixos/modules/services/networking/pleroma.xml +++ b/nixos/modules/services/networking/pleroma.xml @@ -60,9 +60,8 @@ $ sudo -u postgres psql -f setup.psql This is an example of configuration, where - option - contains the content of the file config.exs, - generated + option contains + the content of the file config.exs, generated in the first section, but with the secrets (database password, endpoint secret key, salts, etc.) removed. Removing secrets is @@ -109,9 +108,9 @@ services.pleroma = { Secrets must be moved into a file pointed by - , in - our case /var/lib/pleroma/secrets.exs. This - file can be created copying the previously generated + , in our + case /var/lib/pleroma/secrets.exs. This file + can be created copying the previously generated config.exs file and then removing all the settings, except the secrets. This is an example @@ -136,7 +135,7 @@ config :web_push_encryption, :vapid_details, Note that the lines of the same configuration group are comma - separated (i.e. all the lines end with a comma, except the last + separated (i.e. all the lines end with a comma, except the last one), so when the lines with passwords are added or removed, commas must be adjusted accordingly. @@ -156,7 +155,7 @@ $ ssh -L 4000:localhost:4000 myuser@example.net and then accessing - http://localhost:4000 + http://localhost:4000 from a web browser.
diff --git a/nixos/modules/services/networking/prosody.nix b/nixos/modules/services/networking/prosody.nix index 3c685e30b032..5ef472bf9c29 100644 --- a/nixos/modules/services/networking/prosody.nix +++ b/nixos/modules/services/networking/prosody.nix @@ -905,7 +905,6 @@ in }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./prosody.xml; } diff --git a/nixos/modules/services/networking/yggdrasil.nix b/nixos/modules/services/networking/yggdrasil.nix index 3c3ff4ce3c48..fd2dede13577 100644 --- a/nixos/modules/services/networking/yggdrasil.nix +++ b/nixos/modules/services/networking/yggdrasil.nix @@ -193,8 +193,7 @@ in { environment.systemPackages = [ cfg.package ]; }); meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./yggdrasil.xml; maintainers = with lib.maintainers; [ gazally ehmry ]; }; diff --git a/nixos/modules/services/networking/yggdrasil.xml b/nixos/modules/services/networking/yggdrasil.xml index 5b6f63b3ae06..35388ea4cf4b 100644 --- a/nixos/modules/services/networking/yggdrasil.xml +++ b/nixos/modules/services/networking/yggdrasil.xml @@ -6,7 +6,7 @@ Upstream documentation: - https://yggdrasil-network.github.io/ + https://yggdrasil-network.github.io/ Yggdrasil is an early-stage implementation of a fully end-to-end diff --git a/nixos/modules/services/search/meilisearch.nix b/nixos/modules/services/search/meilisearch.nix index 3983b1b2c92c..98364e141c27 100644 --- a/nixos/modules/services/search/meilisearch.nix +++ b/nixos/modules/services/search/meilisearch.nix @@ -9,8 +9,7 @@ in { meta.maintainers = with maintainers; [ Br1ght0ne happysalada ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc meilisearch.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > meilisearch.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./meilisearch.xml; ###### interface diff --git a/nixos/modules/services/web-apps/discourse.nix b/nixos/modules/services/web-apps/discourse.nix index 2796ba8c379e..b00aeab89b01 100644 --- a/nixos/modules/services/web-apps/discourse.nix +++ b/nixos/modules/services/web-apps/discourse.nix @@ -1080,8 +1080,7 @@ in ]; }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./discourse.xml; meta.maintainers = [ lib.maintainers.talyz ]; } diff --git a/nixos/modules/services/web-apps/discourse.xml b/nixos/modules/services/web-apps/discourse.xml index 1aec160b7b40..ff7534ba5a5a 100644 --- a/nixos/modules/services/web-apps/discourse.xml +++ b/nixos/modules/services/web-apps/discourse.xml @@ -36,8 +36,8 @@ security.acme.acceptTerms = true; Using a regular TLS certificate To set up TLS using a regular certificate and key on file, use the - and - + and + options: @@ -61,22 +61,20 @@ services.discourse = { Discourse uses PostgreSQL to store most of its data. A database will automatically be enabled and a database and role created - unless - is + unless is changed from its default of null or - + is set to false. External database access can also be configured by setting - , - - and - - as appropriate. Note that you need to manually create a database + , + and + as + appropriate. Note that you need to manually create a database called discourse (or the name you chose in - ) and - allow the configured database user full access to it. + ) and allow + the configured database user full access to it.
@@ -127,19 +125,18 @@ services.discourse = { If you want to use a different domain for your outgoing email (for example example.com instead of discourse.example.com) you should set - + and - + manually. Setup of TLS for incoming email is currently only configured - automatically when a regular TLS certificate is used, i.e. when - - and - - are set. + automatically when a regular TLS certificate is used, i.e. when + and + are + set.
@@ -148,8 +145,8 @@ services.discourse = { Additional site settings and backend settings, for which no explicit NixOS options are provided, can be set in - and - + and + respectively.
@@ -158,15 +155,15 @@ services.discourse = { Site settings are the settings that can be changed through the Discourse UI. Their default values can be set using - . + . Settings are expressed as a Nix attribute set which matches the structure of the configuration in config/site_settings.yml. To find a setting’s path, you only need to care about the first - two levels; i.e. its category (e.g. login) - and name (e.g. invite_only). + two levels; i.e. its category (e.g. login) + and name (e.g. invite_only). Settings containing secret data should be set to an attribute @@ -245,12 +242,12 @@ services.discourse = { Plugins You can install Discourse plugins using the - option. + option. Pre-packaged plugins are provided in <your_discourse_package_here>.plugins. If you want the full suite of plugins provided through nixpkgs, you can also set the - option to + option to pkgs.discourseAllPlugins. @@ -284,10 +281,10 @@ services.discourse = { Some plugins provide site settings. Their defaults can be configured using - , just - like regular site settings. To find the names of these settings, - look in the config/settings.yml file of the - plugin repo. + , just like + regular site settings. To find the names of these settings, look + in the config/settings.yml file of the plugin + repo. For example, to add the diff --git a/nixos/modules/services/web-apps/grocy.nix b/nixos/modules/services/web-apps/grocy.nix index 187eed8f0c8d..1d5244b42ce2 100644 --- a/nixos/modules/services/web-apps/grocy.nix +++ b/nixos/modules/services/web-apps/grocy.nix @@ -167,8 +167,7 @@ in { meta = { maintainers = with maintainers; [ ma27 ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./grocy.xml; }; } diff --git a/nixos/modules/services/web-apps/jitsi-meet.nix b/nixos/modules/services/web-apps/jitsi-meet.nix index 2c2d5f21319a..b82138a307b9 100644 --- a/nixos/modules/services/web-apps/jitsi-meet.nix +++ b/nixos/modules/services/web-apps/jitsi-meet.nix @@ -451,8 +451,7 @@ in }; }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./jitsi-meet.xml; meta.maintainers = lib.teams.jitsi.members; } diff --git a/nixos/modules/services/web-apps/keycloak.nix b/nixos/modules/services/web-apps/keycloak.nix index 8d7f046aa117..7b3814485b96 100644 --- a/nixos/modules/services/web-apps/keycloak.nix +++ b/nixos/modules/services/web-apps/keycloak.nix @@ -674,8 +674,7 @@ in mkIf createLocalMySQL (mkDefault dbPkg); }; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./keycloak.xml; meta.maintainers = [ maintainers.talyz ]; } diff --git a/nixos/modules/services/web-apps/keycloak.xml b/nixos/modules/services/web-apps/keycloak.xml index a15cd9a4188f..037ae7ff75a1 100644 --- a/nixos/modules/services/web-apps/keycloak.xml +++ b/nixos/modules/services/web-apps/keycloak.xml @@ -15,8 +15,8 @@ An administrative user with the username admin is automatically created in the master realm. Its initial password can be configured by setting - - and defaults to changeme. The password is not + and + defaults to changeme. The password is not stored safely and should be changed immediately in the admin panel. @@ -32,30 +32,30 @@ Keycloak can be used with either PostgreSQL, MariaDB or MySQL. Which one is used can be configured in - . The + . The selected database will automatically be enabled and a database and role created unless - is - changed from its default of localhost or - - is set to false. + is changed + from its default of localhost or + is + set to false. External database access can also be configured by setting - , - , - , - and - as + , + , + , + and + as appropriate. Note that you need to manually create the database and allow the configured database user full access to it. - + must be set to the path to a file containing the password used to log in to the database. If - and - + and + are kept at their defaults, the database role keycloak with that password is provisioned on the local database instance. @@ -72,20 +72,20 @@ The hostname is used to build the public URL used as base for all frontend requests and must be configured through - . + . If you’re migrating an old Wildfly based Keycloak instance and want to keep compatibility with your current clients, you’ll likely want to set - + to /auth. See the option description for more details. - + determines whether Keycloak should force all requests to go through the frontend URL. By default, Keycloak allows backend requests to instead use its local hostname or IP address and may @@ -110,8 +110,8 @@ both PEM formatted. Their paths should be set through - and - . + and + . @@ -124,8 +124,7 @@ Themes You can package custom themes and make them visible to Keycloak - through . See - the + through . See the Themes section of the Keycloak Server Development Guide and the description of the aforementioned NixOS option for more @@ -136,7 +135,7 @@ Configuration file settings Keycloak server configuration parameters can be set in - . These + . These correspond directly to options in conf/keycloak.conf. Some of the most important parameters are documented as suboptions, the rest can be @@ -150,8 +149,7 @@ containing the attribute _secret - a string pointing to a file containing the value the option should be set to. See the description of - for an - example. + for an example.
diff --git a/nixos/modules/services/web-apps/lemmy.nix b/nixos/modules/services/web-apps/lemmy.nix index 267584dd0ca7..db1518ec2936 100644 --- a/nixos/modules/services/web-apps/lemmy.nix +++ b/nixos/modules/services/web-apps/lemmy.nix @@ -6,8 +6,7 @@ let in { meta.maintainers = with maintainers; [ happysalada ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc lemmy.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > lemmy.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./lemmy.xml; imports = [ diff --git a/nixos/modules/services/web-apps/matomo-doc.md b/nixos/modules/services/web-apps/matomo.md similarity index 100% rename from nixos/modules/services/web-apps/matomo-doc.md rename to nixos/modules/services/web-apps/matomo.md diff --git a/nixos/modules/services/web-apps/matomo.nix b/nixos/modules/services/web-apps/matomo.nix index eb204eb3f3d8..706e41cbed0a 100644 --- a/nixos/modules/services/web-apps/matomo.nix +++ b/nixos/modules/services/web-apps/matomo.nix @@ -325,9 +325,8 @@ in { }; meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` - doc = ./matomo-doc.xml; + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh + doc = ./matomo.xml; maintainers = with lib.maintainers; [ florianjacob ]; }; } diff --git a/nixos/modules/services/web-apps/matomo-doc.xml b/nixos/modules/services/web-apps/matomo.xml similarity index 94% rename from nixos/modules/services/web-apps/matomo-doc.xml rename to nixos/modules/services/web-apps/matomo.xml index 0254d978698c..0d76e4d7e599 100644 --- a/nixos/modules/services/web-apps/matomo-doc.xml +++ b/nixos/modules/services/web-apps/matomo.xml @@ -38,11 +38,11 @@ GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost'; matomo database user (without needing a password), but no other users. For more information on passwordless login, see - https://mariadb.com/kb/en/mariadb/unix_socket-authentication-plugin/. + https://mariadb.com/kb/en/mariadb/unix_socket-authentication-plugin/. - Of course, you can use password based authentication as well, - e.g. when the database is not on the same host. + Of course, you can use password based authentication as well, e.g. + when the database is not on the same host.
@@ -75,7 +75,7 @@ GRANT ALL PRIVILEGES ON matomo.* TO 'matomo'@'localhost'; /var/lib/matomo/config/config.ini.php file. Use a user in the matomo group or root to access the file. For more information, see - https://matomo.org/faq/how-to-install/faq_138/. + https://matomo.org/faq/how-to-install/faq_138/.
diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix index 3d30c712f674..64e8e4ed5d60 100644 --- a/nixos/modules/services/web-apps/nextcloud.nix +++ b/nixos/modules/services/web-apps/nextcloud.nix @@ -1146,7 +1146,6 @@ in { } ]); - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./nextcloud.xml; } diff --git a/nixos/modules/services/web-apps/nextcloud.xml b/nixos/modules/services/web-apps/nextcloud.xml index 0998f29bac27..40d94cb5858e 100644 --- a/nixos/modules/services/web-apps/nextcloud.xml +++ b/nixos/modules/services/web-apps/nextcloud.xml @@ -192,24 +192,24 @@ external storage such as S3. Please note that this won’t work anymore when using OpenSSL 3 for PHP’s openssl extension because this is implemented using the legacy cipher RC4. If - is + is above 22.05, this is disabled by default. To turn it on again and for further information please refer to - . + .
- Using an alternative webserver as reverse-proxy - (e.g. <literal>httpd</literal>) + Using an alternative webserver as reverse-proxy (e.g. + <literal>httpd</literal>) By default, nginx is used as reverse-proxy for - nextcloud. However, it’s possible to use - e.g. httpd by explicitly disabling + nextcloud. However, it’s possible to use e.g. + httpd by explicitly disabling nginx using - and fixing the + and fixing the settings listen.owner & listen.group in the corresponding @@ -268,13 +268,13 @@ Nextcloud apps are installed statefully through the web interface. Some apps may require extra PHP extensions to be installed. This can be configured with the - + setting. Alternatively, extra apps can also be declared with the - setting. - When using this setting, apps can no longer be managed statefully + setting. When + using this setting, apps can no longer be managed statefully because this can lead to Nextcloud updating apps that are managed by Nix. If you want automatic updates it is recommended that you use web interface to install apps. @@ -292,7 +292,7 @@ While minor and patch-level updates are no problem and can be done directly in the package-expression (and should be backported to supported stable branches after that), major-releases should be - added in a new attribute (e.g. Nextcloud + added in a new attribute (e.g. Nextcloud v19.0.0 should be available in nixpkgs as pkgs.nextcloud19). To provide simple upgrade @@ -323,8 +323,8 @@ Ideally we should make sure that it’s possible to jump two NixOS - versions forward: i.e. the warnings and the logic in the module - should guard a user to upgrade from a Nextcloud on e.g. 19.09 to a + versions forward: i.e. the warnings and the logic in the module + should guard a user to upgrade from a Nextcloud on e.g. 19.09 to a Nextcloud on 20.09.
diff --git a/nixos/modules/services/web-apps/pict-rs.nix b/nixos/modules/services/web-apps/pict-rs.nix index ee9ff9b484f6..5f02bce3a0a8 100644 --- a/nixos/modules/services/web-apps/pict-rs.nix +++ b/nixos/modules/services/web-apps/pict-rs.nix @@ -5,8 +5,7 @@ let in { meta.maintainers = with maintainers; [ happysalada ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc pict-rs.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > pict-rs.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./pict-rs.xml; options.services.pict-rs = { diff --git a/nixos/modules/services/web-apps/pict-rs.xml b/nixos/modules/services/web-apps/pict-rs.xml index 6cae82e01eca..511da8012b74 100644 --- a/nixos/modules/services/web-apps/pict-rs.xml +++ b/nixos/modules/services/web-apps/pict-rs.xml @@ -30,8 +30,26 @@ services.pict-rs.enable = true; This endpoint returns the following JSON structure on success with a 201 Created status - json { "files": [ { "delete_token": "JFvFhqJA98", "file": "lkWZDRvugm.jpg" }, { "delete_token": "kAYy9nk2WK", "file": "8qFS0QooAn.jpg" }, { "delete_token": "OxRpM3sf0Y", "file": "1hJaYfGE01.jpg" } ], "msg": "ok" } + +{ + "files": [ + { + "delete_token": "JFvFhqJA98", + "file": "lkWZDRvugm.jpg" + }, + { + "delete_token": "kAYy9nk2WK", + "file": "8qFS0QooAn.jpg" + }, + { + "delete_token": "OxRpM3sf0Y", + "file": "1hJaYfGE01.jpg" + } + ], + "msg": "ok" +} + @@ -53,8 +71,20 @@ services.pict-rs.enable = true; GET /image/details/original/{file} for getting the details of a full-resolution image. The returned JSON is structured like so: - json { "width": 800, "height": 537, "content_type": "image/webp", "created_at": [ 2020, 345, 67376, 394363487 ] } + +{ + "width": 800, + "height": 537, + "content_type": "image/webp", + "created_at": [ + 2020, + 345, + 67376, + 394363487 + ] +} + @@ -111,7 +141,11 @@ services.pict-rs.enable = true; An example of usage could be - GET /image/process.jpg?src=asdf.png&thumbnail=256&blur=3.0 + + +GET /image/process.jpg?src=asdf.png&thumbnail=256&blur=3.0 + + which would create a 256x256px JPEG thumbnail and blur it diff --git a/nixos/modules/services/web-apps/plausible.nix b/nixos/modules/services/web-apps/plausible.nix index cb46a88cd9f5..0475bb796cd2 100644 --- a/nixos/modules/services/web-apps/plausible.nix +++ b/nixos/modules/services/web-apps/plausible.nix @@ -292,7 +292,6 @@ in { }; meta.maintainers = with maintainers; [ ma27 ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh meta.doc = ./plausible.xml; } diff --git a/nixos/modules/services/web-servers/garage-doc.md b/nixos/modules/services/web-servers/garage.md similarity index 100% rename from nixos/modules/services/web-servers/garage-doc.md rename to nixos/modules/services/web-servers/garage.md diff --git a/nixos/modules/services/web-servers/garage.nix b/nixos/modules/services/web-servers/garage.nix index ed5b89f916c6..afdb8044c29f 100644 --- a/nixos/modules/services/web-servers/garage.nix +++ b/nixos/modules/services/web-servers/garage.nix @@ -9,9 +9,8 @@ let in { meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` - doc = ./garage-doc.xml; + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh + doc = ./garage.xml; maintainers = with pkgs.lib.maintainers; [ raitobezarius ]; }; diff --git a/nixos/modules/services/web-servers/garage-doc.xml b/nixos/modules/services/web-servers/garage.xml similarity index 93% rename from nixos/modules/services/web-servers/garage-doc.xml rename to nixos/modules/services/web-servers/garage.xml index 447a27d2bf85..cb9d50a2aa1d 100644 --- a/nixos/modules/services/web-servers/garage-doc.xml +++ b/nixos/modules/services/web-servers/garage.xml @@ -16,7 +16,7 @@ General considerations on upgrades Garage provides a cookbook documentation on how to upgrade: - https://garagehq.deuxfleurs.fr/documentation/cookbook/upgrading/ + https://garagehq.deuxfleurs.fr/documentation/cookbook/upgrading/ @@ -36,7 +36,7 @@ Until 1.0 is released, patch-level upgrades are considered as minor version upgrades. Minor version upgrades are considered as - major version upgrades. i.e. 0.6 to 0.7 is a major version + major version upgrades. i.e. 0.6 to 0.7 is a major version upgrade. @@ -45,7 +45,7 @@ Straightforward upgrades (patch-level upgrades). Upgrades must be performed one by one, - i.e. for each node, stop it, upgrade it : change + i.e. for each node, stop it, upgrade it : change stateVersion or services.garage.package, restart it if it was not already by switching. @@ -110,7 +110,7 @@ - Backup the metadata folder of ALL your nodes, e.g. for a + Backup the metadata folder of ALL your nodes, e.g. for a metadata directory (the default one) in /var/lib/garage/meta, you can run pushd /var/lib/garage; tar -acf meta-v0.7.tar.zst meta/; popd. @@ -166,7 +166,7 @@ While patch-level updates are no problem and can be done directly in the package-expression (and should be backported to supported stable branches after that), major-releases should be added in a - new attribute (e.g. Garage v0.8.0 should be + new attribute (e.g. Garage v0.8.0 should be available in nixpkgs as pkgs.garage_0_8_0). To provide simple upgrade paths it’s generally useful to backport those as well to stable @@ -196,8 +196,8 @@ Ideally we should make sure that it’s possible to jump two NixOS - versions forward: i.e. the warnings and the logic in the module - should guard a user to upgrade from a Garage on e.g. 22.11 to a + versions forward: i.e. the warnings and the logic in the module + should guard a user to upgrade from a Garage on e.g. 22.11 to a Garage on 23.11.
diff --git a/nixos/modules/services/x11/desktop-managers/gnome.nix b/nixos/modules/services/x11/desktop-managers/gnome.nix index 62535e996bb6..63de21594766 100644 --- a/nixos/modules/services/x11/desktop-managers/gnome.nix +++ b/nixos/modules/services/x11/desktop-managers/gnome.nix @@ -66,8 +66,7 @@ in { meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./gnome.xml; maintainers = teams.gnome.members; }; diff --git a/nixos/modules/services/x11/desktop-managers/gnome.xml b/nixos/modules/services/x11/desktop-managers/gnome.xml index d1038bded000..2c46b39ead18 100644 --- a/nixos/modules/services/x11/desktop-managers/gnome.xml +++ b/nixos/modules/services/x11/desktop-managers/gnome.xml @@ -48,9 +48,9 @@ services.gnome.core-utilities.enable = false; If you’d only like to omit a subset of the core utilities, you can use - . - Note that this mechanism can only exclude core utilities, games - and core developer tools. + . Note + that this mechanism can only exclude core utilities, games and + core developer tools.
@@ -103,7 +103,7 @@ services.xserver.desktopManager.gnome.flashback.enableMetacity = true; It is also possible to create custom sessions that replace Metacity with a different window manager using - . + . The following example uses xmonad window @@ -128,8 +128,8 @@ services.xserver.desktopManager.gnome.flashback.customSessions = [ You can add them to - and switch - to them with GNOME Tweaks. If you’d like to do this manually in + and switch to + them with GNOME Tweaks. If you’d like to do this manually in dconf, change the values of the following keys: @@ -204,13 +204,13 @@ environment.systemPackages = [ You can override the default GSettings values using the - + option. Take note that whatever packages you want to override GSettings for, you need to add them to - . + . You can use dconf-editor tool to explore which diff --git a/nixos/modules/services/x11/desktop-managers/pantheon.nix b/nixos/modules/services/x11/desktop-managers/pantheon.nix index 14a03c0408ee..90990cd54da7 100644 --- a/nixos/modules/services/x11/desktop-managers/pantheon.nix +++ b/nixos/modules/services/x11/desktop-managers/pantheon.nix @@ -17,8 +17,7 @@ in { meta = { - # Don't edit the docbook xml directly, edit the md and generate it: - # `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` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./pantheon.xml; maintainers = teams.pantheon.members; }; diff --git a/nixos/modules/services/x11/desktop-managers/pantheon.xml b/nixos/modules/services/x11/desktop-managers/pantheon.xml index 5aa575aeec4a..1377927fe6ae 100644 --- a/nixos/modules/services/x11/desktop-managers/pantheon.xml +++ b/nixos/modules/services/x11/desktop-managers/pantheon.xml @@ -35,8 +35,8 @@ services.pantheon.apps.enable = false; You can also use - - to remove any other app (like elementary-mail). + to + remove any other app (like elementary-mail).
@@ -51,12 +51,12 @@ services.pantheon.apps.enable = false; - + - + @@ -108,7 +108,7 @@ switchboard-with-plugs.override {
FAQ - + I have diff --git a/nixos/modules/system/boot/loader/external/external.nix b/nixos/modules/system/boot/loader/external/external.nix index 5cf478e6c83c..0f4f82da6937 100644 --- a/nixos/modules/system/boot/loader/external/external.nix +++ b/nixos/modules/system/boot/loader/external/external.nix @@ -8,8 +8,7 @@ in { meta = { maintainers = with maintainers; [ cole-h grahamc raitobezarius ]; - # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc external.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart > external.xml` + # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh doc = ./external.xml; };