diff options
author | Reuben D'Netto <rdnetto@gmail.com> | 2018-04-05 18:43:56 +1000 |
---|---|---|
committer | Reuben D'Netto <rdnetto@gmail.com> | 2018-04-12 09:39:14 +1000 |
commit | 42a84598fb7baacc991c03e228a07a536bc0624a (patch) | |
tree | a851974a590af5863bc2235e33a4670ce6c72a0c /nixos/modules | |
parent | a683d2cd00780cf7d20caeeef44deb4cc60d2add (diff) |
Added cross-references to NixOS manual
Diffstat (limited to 'nixos/modules')
-rw-r--r-- | nixos/modules/i18n/input-method/default.xml | 78 | ||||
-rw-r--r-- | nixos/modules/programs/digitalbitbox/doc.xml | 38 | ||||
-rw-r--r-- | nixos/modules/programs/plotinus.xml | 2 | ||||
-rw-r--r-- | nixos/modules/security/acme.xml | 22 | ||||
-rw-r--r-- | nixos/modules/security/hidepid.xml | 12 | ||||
-rw-r--r-- | nixos/modules/services/databases/postgresql.xml | 12 | ||||
-rw-r--r-- | nixos/modules/services/editors/emacs.xml | 20 | ||||
-rw-r--r-- | nixos/modules/services/misc/gitlab.xml | 59 | ||||
-rw-r--r-- | nixos/modules/services/misc/taskserver/doc.xml | 12 | ||||
-rw-r--r-- | nixos/modules/services/networking/dnscrypt-proxy.xml | 20 |
10 files changed, 137 insertions, 138 deletions
diff --git a/nixos/modules/i18n/input-method/default.xml b/nixos/modules/i18n/input-method/default.xml index 45d6daf068b34..76ffa8cb7e37b 100644 --- a/nixos/modules/i18n/input-method/default.xml +++ b/nixos/modules/i18n/input-method/default.xml @@ -6,56 +6,56 @@ <title>Input Methods</title> -<para>Input methods are an operating system component that allows any data, such - as keyboard strokes or mouse movements, to be received as input. In this way - users can enter characters and symbols not found on their input devices. Using - an input method is obligatory for any language that has more graphemes than +<para>Input methods are an operating system component that allows any data, such + as keyboard strokes or mouse movements, to be received as input. In this way + users can enter characters and symbols not found on their input devices. Using + an input method is obligatory for any language that has more graphemes than there are keys on the keyboard.</para> <para>The following input methods are available in NixOS:</para> <itemizedlist> <listitem><para>IBus: The intelligent input bus.</para></listitem> - <listitem><para>Fcitx: A customizable lightweight input + <listitem><para>Fcitx: A customizable lightweight input method.</para></listitem> <listitem><para>Nabi: A Korean input method based on XIM.</para></listitem> - <listitem><para>Uim: The universal input method, is a library with a XIM + <listitem><para>Uim: The universal input method, is a library with a XIM bridge.</para></listitem> </itemizedlist> <section><title>IBus</title> -<para>IBus is an Intelligent Input Bus. It provides full featured and user +<para>IBus is an Intelligent Input Bus. It provides full featured and user friendly input method user interface.</para> <para>The following snippet can be used to configure IBus:</para> <programlisting> i18n.inputMethod = { - enabled = "ibus"; - ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ]; + <link linkend="opt-i18n.inputMethod.enabled">enabled</link> = "ibus"; + <link linkend="opt-i18n.inputMethod.ibus.engines">ibus.engines</link> = with pkgs.ibus-engines; [ anthy hangul mozc ]; }; </programlisting> -<para><literal>i18n.inputMethod.ibus.engines</literal> is optional and can be +<para><literal>i18n.inputMethod.ibus.engines</literal> is optional and can be used to add extra IBus engines.</para> <para>Available extra IBus engines are:</para> <itemizedlist> - <listitem><para>Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a - system for Japanese input method. It converts Hiragana text to Kana Kanji + <listitem><para>Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a + system for Japanese input method. It converts Hiragana text to Kana Kanji mixed text.</para></listitem> - <listitem><para>Hangul (<literal>ibus-engines.hangul</literal>): Korean input + <listitem><para>Hangul (<literal>ibus-engines.hangul</literal>): Korean input method.</para></listitem> - <listitem><para>m17n (<literal>ibus-engines.m17n</literal>): m17n is an input - method that uses input methods and corresponding icons in the m17n + <listitem><para>m17n (<literal>ibus-engines.m17n</literal>): m17n is an input + method that uses input methods and corresponding icons in the m17n database.</para></listitem> - <listitem><para>mozc (<literal>ibus-engines.mozc</literal>): A Japanese input + <listitem><para>mozc (<literal>ibus-engines.mozc</literal>): A Japanese input method from Google.</para></listitem> - <listitem><para>Table (<literal>ibus-engines.table</literal>): An input method + <listitem><para>Table (<literal>ibus-engines.table</literal>): An input method that load tables of input methods.</para></listitem> - <listitem><para>table-others (<literal>ibus-engines.table-others</literal>): + <listitem><para>table-others (<literal>ibus-engines.table-others</literal>): Various table-based input methods. To use this, and any other table-based input methods, it must appear in the list of engines along with <literal>table</literal>. For example: @@ -72,71 +72,71 @@ ibus.engines = with pkgs.ibus-engines; [ table table-others ]; <section><title>Fcitx</title> -<para>Fcitx is an input method framework with extension support. It has three - built-in Input Method Engine, Pinyin, QuWei and Table-based input +<para>Fcitx is an input method framework with extension support. It has three + built-in Input Method Engine, Pinyin, QuWei and Table-based input methods.</para> <para>The following snippet can be used to configure Fcitx:</para> <programlisting> i18n.inputMethod = { - enabled = "fcitx"; - fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ]; + <link linkend="opt-i18n.inputMethod.enabled">enabled</link> = "fcitx"; + <link linkend="opt-i18n.inputMethod.fcitx.engines">fcitx.engines</link> = with pkgs.fcitx-engines; [ mozc hangul m17n ]; }; </programlisting> -<para><literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be +<para><literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be used to add extra Fcitx engines.</para> <para>Available extra Fcitx engines are:</para> <itemizedlist> - <listitem><para>Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a - system for Japanese input method. It converts Hiragana text to Kana Kanji + <listitem><para>Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a + system for Japanese input method. It converts Hiragana text to Kana Kanji mixed text.</para></listitem> - <listitem><para>Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is - an intelligent Zhuyin input method. It is one of the most popular input + <listitem><para>Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is + an intelligent Zhuyin input method. It is one of the most popular input methods among Traditional Chinese Unix users.</para></listitem> - <listitem><para>Hangul (<literal>fcitx-engines.hangul</literal>): Korean input + <listitem><para>Hangul (<literal>fcitx-engines.hangul</literal>): Korean input method.</para></listitem> - <listitem><para>Unikey (<literal>fcitx-engines.unikey</literal>): Vietnamese input + <listitem><para>Unikey (<literal>fcitx-engines.unikey</literal>): Vietnamese input method.</para></listitem> - <listitem><para>m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input - method that uses input methods and corresponding icons in the m17n + <listitem><para>m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input + method that uses input methods and corresponding icons in the m17n database.</para></listitem> - <listitem><para>mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input + <listitem><para>mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input method from Google.</para></listitem> - <listitem><para>table-others (<literal>fcitx-engines.table-others</literal>): + <listitem><para>table-others (<literal>fcitx-engines.table-others</literal>): Various table-based input methods.</para></listitem> </itemizedlist> </section> <section><title>Nabi</title> -<para>Nabi is an easy to use Korean X input method. It allows you to enter - phonetic Korean characters (hangul) and pictographic Korean characters +<para>Nabi is an easy to use Korean X input method. It allows you to enter + phonetic Korean characters (hangul) and pictographic Korean characters (hanja).</para> <para>The following snippet can be used to configure Nabi:</para> <programlisting> i18n.inputMethod = { - enabled = "nabi"; + <link linkend="opt-i18n.inputMethod.enabled">enabled</link> = "nabi"; }; </programlisting> </section> <section><title>Uim</title> -<para>Uim (short for "universal input method") is a multilingual input method +<para>Uim (short for "universal input method") is a multilingual input method framework. Applications can use it through so-called bridges.</para> <para>The following snippet can be used to configure uim:</para> <programlisting> i18n.inputMethod = { - enabled = "uim"; + <link linkend="opt-i18n.inputMethod.enabled">enabled</link> = "uim"; }; </programlisting> -<para>Note: The <literal>i18n.inputMethod.uim.toolbar</literal> option can be +<para>Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"/> option can be used to choose uim toolbar.</para> </section> diff --git a/nixos/modules/programs/digitalbitbox/doc.xml b/nixos/modules/programs/digitalbitbox/doc.xml index 7acbc2fc4dde8..a26653dda535f 100644 --- a/nixos/modules/programs/digitalbitbox/doc.xml +++ b/nixos/modules/programs/digitalbitbox/doc.xml @@ -15,9 +15,9 @@ installed by setting <literal>programs.digitalbitbox</literal> to <literal>true</literal> in a manner similar to - <programlisting> - programs.digitalbitbox.enable = true; - </programlisting> +<programlisting> +<xref linkend="opt-programs.digitalbitbox.enable"/> = true; +</programlisting> and bundles the <literal>digitalbitbox</literal> package (see <xref linkend="sec-digitalbitbox-package" />), which contains the @@ -46,11 +46,11 @@ <literal>digitalbitbox</literal> package which could be installed as follows: - <programlisting> - environment.systemPackages = [ - pkgs.digitalbitbox - ]; - </programlisting> +<programlisting> +<xref linkend="opt-environment.systemPackages"/> = [ + pkgs.digitalbitbox +]; +</programlisting> </para> </section> @@ -62,9 +62,9 @@ The digitalbitbox hardware package enables the udev rules for Digital Bitbox devices and may be installed as follows: - <programlisting> - hardware.digitalbitbox.enable = true; - </programlisting> +<programlisting> +<xref linkend="opt-hardware.digitalbitbox.enable"/> = true; +</programlisting> </para> <para> @@ -72,14 +72,14 @@ the <literal>udevRule51</literal> and <literal>udevRule52</literal> attributes by means of overriding as follows: - <programlisting> - programs.digitalbitbox = { - enable = true; - package = pkgs.digitalbitbox.override { - udevRule51 = "something else"; - }; - }; - </programlisting> +<programlisting> +programs.digitalbitbox = { + <link linkend="opt-programs.digitalbitbox.enable">enable</link> = true; + <link linkend="opt-programs.digitalbitbox.package">package</link> = pkgs.digitalbitbox.override { + udevRule51 = "something else"; + }; +}; +</programlisting> </para> </section> </chapter> diff --git a/nixos/modules/programs/plotinus.xml b/nixos/modules/programs/plotinus.xml index 85b0e023e6c17..91740ee16ec2f 100644 --- a/nixos/modules/programs/plotinus.xml +++ b/nixos/modules/programs/plotinus.xml @@ -17,7 +17,7 @@ <para>To enable Plotinus, add the following to your <filename>configuration.nix</filename>: <programlisting> -programs.plotinus.enable = true; +<xref linkend="opt-programs.plotinus.enable"/> = true; </programlisting> </para> diff --git a/nixos/modules/security/acme.xml b/nixos/modules/security/acme.xml index 6130ed82ed380..7cdc554989ea4 100644 --- a/nixos/modules/security/acme.xml +++ b/nixos/modules/security/acme.xml @@ -48,9 +48,9 @@ http { <filename>configuration.nix</filename>: <programlisting> -security.acme.certs."foo.example.com" = { - webroot = "/var/www/challenges"; - email = "foo@example.com"; +<xref linkend="opt-security.acme.certs"/>."foo.example.com" = { + <link linkend="opt-security.acme.certs._name_.webroot">webroot</link> = "/var/www/challenges"; + <link linkend="opt-security.acme.certs._name_.email">email</link> = "foo@example.com"; }; </programlisting> </para> @@ -58,17 +58,17 @@ security.acme.certs."foo.example.com" = { <para>The private key <filename>key.pem</filename> and certificate <filename>fullchain.pem</filename> will be put into <filename>/var/lib/acme/foo.example.com</filename>. The target directory can -be configured with the option <literal>security.acme.directory</literal>. +be configured with the option <xref linkend="opt-security.acme.directory"/>. </para> <para>Refer to <xref linkend="ch-options" /> for all available configuration -options for the <literal>security.acme</literal> module.</para> +options for the <link linkend="opt-security.acme.certs">security.acme</link> module.</para> </section> <section><title>Using ACME certificates in Nginx</title> <para>NixOS supports fetching ACME certificates for you by setting -<literal>enableACME = true;</literal> in a virtualHost config. We + <literal><link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = true;</literal> in a virtualHost config. We first create self-signed placeholder certificates in place of the real ACME certs. The placeholder certs are overwritten when the ACME certs arrive. For <literal>foo.example.com</literal> the config would @@ -77,13 +77,13 @@ look like. <programlisting> services.nginx = { - enable = true; - virtualHosts = { + <link linkend="opt-services.nginx.enable">enable = true;</link> + <link linkend="opt-services.nginx.virtualHosts">virtualHosts</link> = { "foo.example.com" = { - forceSSL = true; - enableACME = true; + <link linkend="opt-services.nginx.virtualHosts._name_.forceSSL">forceSSL</link> = true; + <link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = true; locations."/" = { - root = "/var/www"; + <link linkend="opt-services.nginx.virtualHosts._name_.locations._name_.root">root</link> = "/var/www"; }; }; }; diff --git a/nixos/modules/security/hidepid.xml b/nixos/modules/security/hidepid.xml index 5715ee7ac165b..d69341eb3cde1 100644 --- a/nixos/modules/security/hidepid.xml +++ b/nixos/modules/security/hidepid.xml @@ -8,9 +8,9 @@ <para> Setting - <programlisting> - security.hideProcessInformation = true; - </programlisting> +<programlisting> +<xref linkend="opt-security.hideProcessInformation"/> = true; +</programlisting> ensures that access to process information is restricted to the owning user. This implies, among other things, that command-line arguments remain private. Unless your deployment relies on unprivileged @@ -25,9 +25,9 @@ <para> To allow a service <replaceable>foo</replaceable> to run without process information hiding, set - <programlisting> - systemd.services.<replaceable>foo</replaceable>.serviceConfig.SupplementaryGroups = [ "proc" ]; - </programlisting> +<programlisting> +<link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.<replaceable>foo</replaceable>.serviceConfig</link>.SupplementaryGroups = [ "proc" ]; +</programlisting> </para> </chapter> diff --git a/nixos/modules/services/databases/postgresql.xml b/nixos/modules/services/databases/postgresql.xml index a98026942959c..98a631c0cd32a 100644 --- a/nixos/modules/services/databases/postgresql.xml +++ b/nixos/modules/services/databases/postgresql.xml @@ -23,15 +23,15 @@ <filename>configuration.nix</filename>: <programlisting> -services.postgresql.enable = true; -services.postgresql.package = pkgs.postgresql94; +<xref linkend="opt-services.postgresql.enable"/> = true; +<xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql94; </programlisting> Note that you are required to specify the desired version of PostgreSQL (e.g. <literal>pkgs.postgresql94</literal>). Since upgrading your PostgreSQL version requires a database dump and reload (see below), NixOS cannot provide a default value for -<option>services.postgresql.package</option> such as the most recent +<xref linkend="opt-services.postgresql.package"/> such as the most recent release of PostgreSQL.</para> <!-- @@ -49,10 +49,10 @@ alice=> <para>By default, PostgreSQL stores its databases in <filename>/var/db/postgresql</filename>. You can override this using -<option>services.postgresql.dataDir</option>, e.g. +<xref linkend="opt-services.postgresql.dataDir"/>, e.g. <programlisting> -services.postgresql.dataDir = "/data/postgresql"; +<xref linkend="opt-services.postgresql.dataDir"/> = "/data/postgresql"; </programlisting> </para> @@ -69,7 +69,7 @@ services.postgresql.dataDir = "/data/postgresql"; <section><title>Options</title> -<para>FIXME: auto-generated list of module options.</para> + <para>A complete list of options for the PostgreSQL module may be found <link linkend="opt-services.postgresql.enable">here</link>.</para> </section> diff --git a/nixos/modules/services/editors/emacs.xml b/nixos/modules/services/editors/emacs.xml index dd66bac442c68..dfab5ce4a79d3 100644 --- a/nixos/modules/services/editors/emacs.xml +++ b/nixos/modules/services/editors/emacs.xml @@ -404,10 +404,10 @@ in [...] user service for Emacs daemon, add the following to your <filename>configuration.nix</filename>: - <programlisting><![CDATA[ -services.emacs.enable = true; -services.emacs.package = import /home/cassou/.emacs.d { pkgs = pkgs; }; -]]></programlisting> +<programlisting> +<xref linkend="opt-services.emacs.enable"/> = true; +<xref linkend="opt-services.emacs.package"/> = import /home/cassou/.emacs.d { pkgs = pkgs; }; +</programlisting> </para> <para> @@ -462,7 +462,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal <!--<title><command>emacsclient</command> as the Default Editor</title>--> <para> - If <varname>services.emacs.defaultEditor</varname> is + If <xref linkend="opt-services.emacs.defaultEditor"/> is <literal>true</literal>, the <varname>EDITOR</varname> variable will be set to a wrapper script which launches <command>emacsclient</command>. @@ -497,10 +497,10 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal Emacs daemon is not wanted for all users, it is possible to install the service but not globally enable it: - <programlisting><![CDATA[ -services.emacs.enable = false; -services.emacs.install = true; -]]></programlisting> +<programlisting> +<xref linkend="opt-services.emacs.enable"/> = false; +<xref linkend="opt-services.emacs.install"/> = true; +</programlisting> </para> <para> @@ -582,7 +582,7 @@ services.emacs.install = true; <para> To install the DocBook 5.0 schemas, either add <varname>pkgs.docbook5</varname> to - <varname>environment.systemPackages</varname> (<link + <xref linkend="opt-environment.systemPackages"/> (<link linkend="sec-declarative-package-mgmt">NixOS</link>), or run <literal>nix-env -i pkgs.docbook5</literal> (<link linkend="sec-ad-hoc-packages">Nix</link>). diff --git a/nixos/modules/services/misc/gitlab.xml b/nixos/modules/services/misc/gitlab.xml index 4b00f50abd63d..3306ba8e9b11e 100644 --- a/nixos/modules/services/misc/gitlab.xml +++ b/nixos/modules/services/misc/gitlab.xml @@ -18,19 +18,18 @@ webserver to proxy HTTP requests to the socket.</para> frontend proxy: <programlisting> - services.nginx = { - enable = true; - recommendedGzipSettings = true; - recommendedOptimisation = true; - recommendedProxySettings = true; - recommendedTlsSettings = true; - virtualHosts."git.example.com" = { - enableACME = true; - forceSSL = true; - locations."/".proxyPass = "http://unix:/run/gitlab/gitlab-workhorse.socket"; - }; - }; -''; +<link linkend="opt-services.nginx.enable">services.nginx</link> = { + <link linkend="opt-services.nginx.enable">enable</link> = true; + <link linkend="opt-services.nginx.recommendedGzipSettings">recommendedGzipSettings</link> = true; + <link linkend="opt-services.nginx.recommendedOptimisation">recommendedOptimisation</link> = true; + <link linkend="opt-services.nginx.recommendedProxySettings">recommendedProxySettings</link> = true; + <link linkend="opt-services.nginx.recommendedTlsSettings">recommendedTlsSettings</link> = true; + <link linkend="opt-services.nginx.virtualHosts">virtualHosts</link>."git.example.com" = { + <link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = true; + <link linkend="opt-services.nginx.virtualHosts._name_.forceSSL">forceSSL</link> = true; + <link linkend="opt-services.nginx.virtualHosts._name_.locations._name_.proxyPass">locations."/".proxyPass</link> = "http://unix:/run/gitlab/gitlab-workhorse.socket"; + }; +}; </programlisting> </para> @@ -49,24 +48,24 @@ all data like the repositories and uploads will be stored.</para> <programlisting> services.gitlab = { - enable = true; - databasePassword = "eXaMpl3"; - initialRootPassword = "UseNixOS!"; - https = true; - host = "git.example.com"; - port = 443; - user = "git"; - group = "git"; + <link linkend="opt-services.gitlab.enable">enable</link> = true; + <link linkend="opt-services.gitlab.databasePassword">databasePassword</link> = "eXaMpl3"; + <link linkend="opt-services.gitlab.initialRootPassword">initialRootPassword</link> = "UseNixOS!"; + <link linkend="opt-services.gitlab.https">https</link> = true; + <link linkend="opt-services.gitlab.host">host</link> = "git.example.com"; + <link linkend="opt-services.gitlab.port">port</link> = 443; + <link linkend="opt-services.gitlab.user">user</link> = "git"; + <link linkend="opt-services.gitlab.group">group</link> = "git"; smtp = { - enable = true; - address = "localhost"; - port = 25; + <link linkend="opt-services.gitlab.smtp.enable">enable</link> = true; + <link linkend="opt-services.gitlab.smtp.address">address</link> = "localhost"; + <link linkend="opt-services.gitlab.smtp.port">port</link> = 25; }; secrets = { - db = "uPgq1gtwwHiatiuE0YHqbGa5lEIXH7fMsvuTNgdzJi8P0Dg12gibTzBQbq5LT7PNzcc3BP9P1snHVnduqtGF43PgrQtU7XL93ts6gqe9CBNhjtaqUwutQUDkygP5NrV6"; - secret = "devzJ0Tz0POiDBlrpWmcsjjrLaltyiAdS8TtgT9YNBOoUcDsfppiY3IXZjMVtKgXrFImIennFGOpPN8IkP8ATXpRgDD5rxVnKuTTwYQaci2NtaV1XxOQGjdIE50VGsR3"; - otp = "e1GATJVuS2sUh7jxiPzZPre4qtzGGaS22FR50Xs1TerRVdgI3CBVUi5XYtQ38W4xFeS4mDqi5cQjExE838iViSzCdcG19XSL6qNsfokQP9JugwiftmhmCadtsnHErBMI"; - jws = '' + <link linkend="opt-services.gitlab.secrets.db">db</link> = "uPgq1gtwwHiatiuE0YHqbGa5lEIXH7fMsvuTNgdzJi8P0Dg12gibTzBQbq5LT7PNzcc3BP9P1snHVnduqtGF43PgrQtU7XL93ts6gqe9CBNhjtaqUwutQUDkygP5NrV6"; + <link linkend="opt-services.gitlab.secrets.secret">secret</link> = "devzJ0Tz0POiDBlrpWmcsjjrLaltyiAdS8TtgT9YNBOoUcDsfppiY3IXZjMVtKgXrFImIennFGOpPN8IkP8ATXpRgDD5rxVnKuTTwYQaci2NtaV1XxOQGjdIE50VGsR3"; + <link linkend="opt-services.gitlab.secrets.otp">otp</link> = "e1GATJVuS2sUh7jxiPzZPre4qtzGGaS22FR50Xs1TerRVdgI3CBVUi5XYtQ38W4xFeS4mDqi5cQjExE838iViSzCdcG19XSL6qNsfokQP9JugwiftmhmCadtsnHErBMI"; + <link linkend="opt-services.gitlab.secrets.jws">jws</link> = '' -----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEArrtx4oHKwXoqUbMNqnHgAklnnuDon3XG5LJB35yPsXKv/8GK ke92wkI+s1Xkvsp8tg9BIY/7c6YK4SR07EWL+dB5qwctsWR2Q8z+/BKmTx9D99pm @@ -96,7 +95,7 @@ services.gitlab = { -----END RSA PRIVATE KEY----- ''; }; - extraConfig = { + <link linkend="opt-services.gitlab.extraConfig">extraConfig</link> = { gitlab = { email_from = "gitlab-no-reply@example.com"; email_display_name = "Example GitLab"; @@ -116,7 +115,7 @@ secret from <literal>config/secrets.yml</literal> located in your Gitlab state folder.</para> <para>Refer to <xref linkend="ch-options" /> for all available configuration -options for the <literal>services.gitlab</literal> module.</para> +options for the <link linkend="opt-services.gitlab.enable">services.gitlab</link> module.</para> </section> diff --git a/nixos/modules/services/misc/taskserver/doc.xml b/nixos/modules/services/misc/taskserver/doc.xml index 6d4d2a9b488c0..75493ac1394f6 100644 --- a/nixos/modules/services/misc/taskserver/doc.xml +++ b/nixos/modules/services/misc/taskserver/doc.xml @@ -55,7 +55,7 @@ Because Taskserver by default only provides scripts to setup users imperatively, the <command>nixos-taskserver</command> tool is used for addition and deletion of organisations along with users and groups defined - by <option>services.taskserver.organisations</option> and as well for + by <xref linkend="opt-services.taskserver.organisations"/> and as well for imperative set up. </para> @@ -99,10 +99,10 @@ For example, let's say you have the following configuration: <screen> { - services.taskserver.enable = true; - services.taskserver.fqdn = "server"; - services.taskserver.listenHost = "::"; - services.taskserver.organisations.my-company.users = [ "alice" ]; + <xref linkend="opt-services.taskserver.enable"/> = true; + <xref linkend="opt-services.taskserver.fqdn"/> = "server"; + <xref linkend="opt-services.taskserver.listenHost"/> = "::"; + <link linkend="opt-services.taskserver.organisations._name_.users">services.taskserver.organisations.my-company.users</link> = [ "alice" ]; } </screen> This creates an organisation called <literal>my-company</literal> with the @@ -136,7 +136,7 @@ $ ssh server nixos-taskserver user export my-company alice | sh <para> If you set any options within - <option>service.taskserver.pki.manual.*</option>, + <link linkend="opt-services.taskserver.pki.manual.ca.cert">service.taskserver.pki.manual</link>.*, <command>nixos-taskserver</command> won't issue certificates, but you can still use it for adding or removing user accounts. </para> diff --git a/nixos/modules/services/networking/dnscrypt-proxy.xml b/nixos/modules/services/networking/dnscrypt-proxy.xml index 555c6df4d551f..ff10886985891 100644 --- a/nixos/modules/services/networking/dnscrypt-proxy.xml +++ b/nixos/modules/services/networking/dnscrypt-proxy.xml @@ -19,7 +19,7 @@ <para> To enable the client proxy, set <programlisting> - services.dnscrypt-proxy.enable = true; +<xref linkend="opt-services.dnscrypt-proxy.enable"/> = true; </programlisting> </para> @@ -38,17 +38,17 @@ DNS client, change the default proxy listening port to a non-standard value and point the other client to it: <programlisting> - services.dnscrypt-proxy.localPort = 43; +<xref linkend="opt-services.dnscrypt-proxy.localPort"/> = 43; </programlisting> </para> <sect2><title>dnsmasq</title> <para> <programlisting> - { - services.dnsmasq.enable = true; - services.dnsmasq.servers = [ "127.0.0.1#43" ]; - } +{ + <xref linkend="opt-services.dnsmasq.enable"/> = true; + <xref linkend="opt-services.dnsmasq.servers"/> = [ "127.0.0.1#43" ]; +} </programlisting> </para> </sect2> @@ -56,10 +56,10 @@ <sect2><title>unbound</title> <para> <programlisting> - { - services.unbound.enable = true; - services.unbound.forwardAddresses = [ "127.0.0.1@43" ]; - } +{ + <xref linkend="opt-services.unbound.enable"/> = true; + <xref linkend="opt-services.unbound.forwardAddresses"/> = [ "127.0.0.1@43" ]; +} </programlisting> </para> </sect2> |