diff options
Diffstat (limited to 'nixos/modules/services')
| -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 |
5 files changed, 61 insertions, 62 deletions
diff --git a/nixos/modules/services/databases/postgresql.xml b/nixos/modules/services/databases/postgresql.xml index a98026942959..98a631c0cd32 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 dd66bac442c6..dfab5ce4a79d 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 4b00f50abd63..3306ba8e9b11 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 6d4d2a9b488c..75493ac1394f 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 555c6df4d551..ff1088698589 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> |