Merge pull request #45917 from grahamc/nixos-section-ids

Nixos docs: section ids
This commit is contained in:
Graham Christensen 2018-09-01 16:38:44 -04:00 committed by GitHub
commit 367c484b64
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
20 changed files with 75 additions and 74 deletions

View File

@ -11,7 +11,7 @@ manual-combined.xml: generated *.xml
.PHONY: format .PHONY: format
format: format:
find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \ find ../../ -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \
xmlformat --config-file "../xmlformat.conf" -i {} xmlformat --config-file "../xmlformat.conf" -i {}
.PHONY: fix-misc-xml .PHONY: fix-misc-xml

View File

@ -66,14 +66,15 @@ nixpkgs.config.packageOverrides = pkgs:
sets the kernels TCP keepalive time to 120 seconds. To see the available sets the kernels TCP keepalive time to 120 seconds. To see the available
parameters, run <command>sysctl -a</command>. parameters, run <command>sysctl -a</command>.
</para> </para>
<section> <section xml:id="sec-linux-config-customizing">
<title>Customize your kernel</title> <title>Customize your kernel</title>
<para> <para>
The first step before compiling the kernel is to generate an appropriate The first step before compiling the kernel is to generate an appropriate
<literal>.config</literal> configuration. Either you pass your own config via <literal>.config</literal> configuration. Either you pass your own config
the <literal>configfile</literal> setting of <literal>linuxManualConfig</literal>: via the <literal>configfile</literal> setting of
<screen><![CDATA[ <literal>linuxManualConfig</literal>:
<screen><![CDATA[
custom-kernel = super.linuxManualConfig { custom-kernel = super.linuxManualConfig {
inherit (super) stdenv hostPlatform; inherit (super) stdenv hostPlatform;
inherit (linux_4_9) src; inherit (linux_4_9) src;
@ -117,7 +118,7 @@ You can edit the config with this snippet (by default <command>make menuconfig</
]]></screen> ]]></screen>
</para> </para>
</section> </section>
<section> <section xml:id="sec-linux-config-developing-modules">
<title>Developing kernel modules</title> <title>Developing kernel modules</title>
<para> <para>

View File

@ -74,7 +74,7 @@ The unique option `services.httpd.adminAddr' is defined multiple times, in `/etc
argument is for: it contains the complete, merged system configuration. That argument is for: it contains the complete, merged system configuration. That
is, <varname>config</varname> is the result of combining the configurations is, <varname>config</varname> is the result of combining the configurations
returned by every module returned by every module
<footnote> <footnote xml:id="footnote-nix-is-lazy">
<para> <para>
If youre wondering how its possible that the (indirect) If youre wondering how its possible that the (indirect)
<emphasis>result</emphasis> of a function is passed as an <emphasis>result</emphasis> of a function is passed as an

View File

@ -20,7 +20,7 @@
NixOS module system. NixOS module system.
</para> </para>
<section> <section xml:id="sec-assertions-warnings">
<title>Warnings</title> <title>Warnings</title>
<para> <para>
@ -44,7 +44,7 @@
</programlisting> </programlisting>
</section> </section>
<section> <section xml:id="sec-assertions-assertions">
<title>Assertions</title> <title>Assertions</title>
<para> <para>

View File

@ -11,7 +11,7 @@
value definitions. value definitions.
</para> </para>
<section> <section xml:id="sec-option-types-basic">
<title>Basic Types</title> <title>Basic Types</title>
<para> <para>
@ -196,7 +196,7 @@
</variablelist> </variablelist>
</section> </section>
<section> <section xml:id="sec-option-types-value">
<title>Value Types</title> <title>Value Types</title>
<para> <para>
@ -257,7 +257,7 @@
</variablelist> </variablelist>
</section> </section>
<section> <section xml:id="sec-option-types-composed">
<title>Composed Types</title> <title>Composed Types</title>
<para> <para>
@ -483,7 +483,7 @@ config.mod.two = { foo = 2; bar = "two"; };</screen>
</example> </example>
</section> </section>
<section> <section xml:id="sec-option-types-extending">
<title>Extending types</title> <title>Extending types</title>
<para> <para>
@ -543,7 +543,7 @@ nixThings = mkOption {
</variablelist> </variablelist>
</section> </section>
<section> <section xml:id="sec-option-types-custom">
<title>Custom Types</title> <title>Custom Types</title>
<para> <para>

View File

@ -10,7 +10,7 @@
sources and presenting it in an accessible style would be a worthy sources and presenting it in an accessible style would be a worthy
contribution to the project. contribution to the project.
</para> </para>
<section> <section xml:id="sec-writing-docs-building-the-manual">
<title>Building the Manual</title> <title>Building the Manual</title>
<para> <para>
@ -42,7 +42,7 @@
<filename>./result/share/doc/nixos/index.html</filename>. <filename>./result/share/doc/nixos/index.html</filename>.
</para> </para>
</section> </section>
<section> <section xml:id="sec-writing-docs-editing-docbook-xml">
<title>Editing DocBook XML</title> <title>Editing DocBook XML</title>
<para> <para>
@ -76,7 +76,7 @@
Issue</link> and someone will handle the conversion to XML for you. Issue</link> and someone will handle the conversion to XML for you.
</para> </para>
</section> </section>
<section> <section xml:id="sec-writing-docs-creating-a-topic">
<title>Creating a Topic</title> <title>Creating a Topic</title>
<para> <para>
@ -128,7 +128,7 @@
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>
<section> <section xml:id="sec-writing-docs-adding-a-topic">
<title>Adding a Topic to the Book</title> <title>Adding a Topic to the Book</title>
<para> <para>

View File

@ -109,7 +109,7 @@ nixos https://nixos.org/channels/nixos-unstable
so in that case you will not be able to go back to your original channel. so in that case you will not be able to go back to your original channel.
</para> </para>
</warning> </warning>
<section> <section xml:id="sec-upgrading-automatic">
<title>Automatic Upgrades</title> <title>Automatic Upgrades</title>
<para> <para>

View File

@ -8,7 +8,7 @@
<subtitle>Version <xi:include href="./generated/version" parse="text" /> <subtitle>Version <xi:include href="./generated/version" parse="text" />
</subtitle> </subtitle>
</info> </info>
<preface> <preface xml:id="preface">
<title>Preface</title> <title>Preface</title>
<para> <para>
This manual describes how to install, use and extend NixOS, a Linux This manual describes how to install, use and extend NixOS, a Linux

View File

@ -15,7 +15,7 @@
<xsl:template match="/expr/list"> <xsl:template match="/expr/list">
<appendix> <appendix xml:id="appendix-configuration-options">
<title>Configuration Options</title> <title>Configuration Options</title>
<variablelist xml:id="configuration-variable-list"> <variablelist xml:id="configuration-variable-list">
<xsl:for-each select="attrs"> <xsl:for-each select="attrs">

View File

@ -23,7 +23,7 @@
bridge.</para></listitem> bridge.</para></listitem>
</itemizedlist> </itemizedlist>
<section><title>IBus</title> <section xml:id="module-services-input-methods-ibus"><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> friendly input method user interface.</para>
@ -82,7 +82,7 @@ ibus.engines = with pkgs.ibus-engines; [ table table-others ];
</simplesect> </simplesect>
</section> </section>
<section><title>Fcitx</title> <section xml:id="module-services-input-methods-fcitx"><title>Fcitx</title>
<para>Fcitx is an input method framework with extension support. It has three <para>Fcitx is an input method framework with extension support. It has three
built-in Input Method Engine, Pinyin, QuWei and Table-based input built-in Input Method Engine, Pinyin, QuWei and Table-based input
@ -122,7 +122,7 @@ i18n.inputMethod = {
</itemizedlist> </itemizedlist>
</section> </section>
<section><title>Nabi</title> <section xml:id="module-services-input-methods-nabi"><title>Nabi</title>
<para>Nabi is an easy to use Korean X input method. It allows you to enter <para>Nabi is an easy to use Korean X input method. It allows you to enter
phonetic Korean characters (hangul) and pictographic Korean characters phonetic Korean characters (hangul) and pictographic Korean characters
@ -136,7 +136,7 @@ i18n.inputMethod = {
</programlisting> </programlisting>
</section> </section>
<section><title>Uim</title> <section xml:id="module-services-input-methods-uim"><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> framework. Applications can use it through so-called bridges.</para>

View File

@ -10,7 +10,7 @@
to manage your <link xlink:href="https://www.zsh.org/">ZSH</link> configuration to manage your <link xlink:href="https://www.zsh.org/">ZSH</link> configuration
including completion scripts for several CLI tools or custom prompt themes.</para> including completion scripts for several CLI tools or custom prompt themes.</para>
<section><title>Basic usage</title> <section xml:id="module-programs-oh-my-zsh-usage"><title>Basic usage</title>
<para>The module uses the <literal>oh-my-zsh</literal> package with all available features. The <para>The module uses the <literal>oh-my-zsh</literal> package with all available features. The
initial setup using Nix expressions is fairly similar to the configuration format initial setup using Nix expressions is fairly similar to the configuration format
of <literal>oh-my-zsh</literal>. of <literal>oh-my-zsh</literal>.
@ -32,7 +32,7 @@ For a detailed explanation of these arguments please refer to the
configuration and writes it into your <literal>/etc/zshrc</literal>. configuration and writes it into your <literal>/etc/zshrc</literal>.
</para></section> </para></section>
<section><title>Custom additions</title> <section xml:id="module-programs-oh-my-zsh-additions"><title>Custom additions</title>
<para>Sometimes third-party or custom scripts such as a modified theme may be needed. <para>Sometimes third-party or custom scripts such as a modified theme may be needed.
<literal>oh-my-zsh</literal> provides the <literal>oh-my-zsh</literal> provides the
@ -48,7 +48,7 @@ environment variable for this which points to a directory with additional script
</programlisting> </programlisting>
</para></section> </para></section>
<section><title>Custom environments</title> <section xml:id="module-programs-oh-my-zsh-environments"><title>Custom environments</title>
<para>There are several extensions for <literal>oh-my-zsh</literal> packaged in <literal>nixpkgs</literal>. <para>There are several extensions for <literal>oh-my-zsh</literal> packaged in <literal>nixpkgs</literal>.
One of them is <link xlink:href="https://github.com/spwhitt/nix-zsh-completions">nix-zsh-completions</link> One of them is <link xlink:href="https://github.com/spwhitt/nix-zsh-completions">nix-zsh-completions</link>
@ -77,7 +77,7 @@ as it requires an immutable store path while <literal>custom</literal> shall rem
will be thrown if both <literal>custom</literal> and <literal>customPkgs</literal> are set.</emphasis> will be thrown if both <literal>custom</literal> and <literal>customPkgs</literal> are set.</emphasis>
</para></section> </para></section>
<section><title>Package your own customizations</title> <section xml:id="module-programs-oh-my-zsh-packaging-customizations"><title>Package your own customizations</title>
<para>If third-party customizations (e.g. new themes) are supposed to be added to <literal>oh-my-zsh</literal> <para>If third-party customizations (e.g. new themes) are supposed to be added to <literal>oh-my-zsh</literal>
there are several pitfalls to keep in mind:</para> there are several pitfalls to keep in mind:</para>

View File

@ -11,7 +11,7 @@ retrieval and renewal using the ACME protocol. This is currently only
implemented by and for Let's Encrypt. The alternative ACME client implemented by and for Let's Encrypt. The alternative ACME client
<literal>simp_le</literal> is used under the hood.</para> <literal>simp_le</literal> is used under the hood.</para>
<section><title>Prerequisites</title> <section xml:id="module-security-acme-prerequisites"><title>Prerequisites</title>
<para>You need to have a running HTTP server for verification. The server must <para>You need to have a running HTTP server for verification. The server must
have a webroot defined that can serve have a webroot defined that can serve
@ -41,7 +41,7 @@ http {
</section> </section>
<section><title>Configuring</title> <section xml:id="module-security-acme-configuring"><title>Configuring</title>
<para>To enable ACME certificate retrieval &amp; renewal for a certificate for <para>To enable ACME certificate retrieval &amp; renewal for a certificate for
<literal>foo.example.com</literal>, add the following in your <literal>foo.example.com</literal>, add the following in your
@ -66,7 +66,7 @@ options for the <link linkend="opt-security.acme.certs">security.acme</link> mod
</section> </section>
<section><title>Using ACME certificates in Nginx</title> <section xml:id="module-security-acme-nginx"><title>Using ACME certificates in Nginx</title>
<para>NixOS supports fetching ACME certificates for you by setting <para>NixOS supports fetching ACME certificates for you by setting
<literal><link linkend="opt-services.nginx.virtualHosts._name_.enableACME">enableACME</link> = 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 first create self-signed placeholder certificates in place of the

View File

@ -17,7 +17,7 @@
<para>FoundationDB (or "FDB") is an open source, distributed, transactional <para>FoundationDB (or "FDB") is an open source, distributed, transactional
key-value store.</para> key-value store.</para>
<section><title>Configuring and basic setup</title> <section xml:id="module-services-foundationdb-configuring"><title>Configuring and basic setup</title>
<para>To enable FoundationDB, add the following to your <para>To enable FoundationDB, add the following to your
<filename>configuration.nix</filename>: <filename>configuration.nix</filename>:
@ -133,7 +133,7 @@ corresponding <option>services.foundationdb.logDir</option> as well.</para>
</section> </section>
<section><title>Scaling processes and backup agents</title> <section xml:id="module-services-foundationdb-scaling"><title>Scaling processes and backup agents</title>
<para>Scaling the number of server processes is quite easy; simply specify <para>Scaling the number of server processes is quite easy; simply specify
<option>services.foundationdb.serverProcesses</option> to be the number of <option>services.foundationdb.serverProcesses</option> to be the number of
@ -151,7 +151,7 @@ available backup processes.</para>
</section> </section>
<section><title>Clustering</title> <section xml:id="module-services-foundationdb-clustering"><title>Clustering</title>
<para>FoundationDB on NixOS works similarly to other Linux systems, so this <para>FoundationDB on NixOS works similarly to other Linux systems, so this
section will be brief. Please refer to the full FoundationDB documentation for section will be brief. Please refer to the full FoundationDB documentation for
@ -221,7 +221,7 @@ informing all client processes to do the same.</para>
</section> </section>
<section><title>Client connectivity</title> <section xml:id="module-services-foundationdb-connectivity"><title>Client connectivity</title>
<para>By default, all clients must use the current <para>By default, all clients must use the current
<command>fdb.cluster</command> file to access a given FoundationDB cluster. <command>fdb.cluster</command> file to access a given FoundationDB cluster.
@ -232,7 +232,7 @@ to a new node in order to connect, if it is not part of the cluster.</para>
</section> </section>
<section><title>Client authorization and TLS</title> <section xml:id="module-services-foundationdb-authorization"><title>Client authorization and TLS</title>
<para>By default, any user who can connect to a FoundationDB process with the <para>By default, any user who can connect to a FoundationDB process with the
correct cluster configuration can access anything. FoundationDB uses a correct cluster configuration can access anything. FoundationDB uses a
@ -270,7 +270,7 @@ on.</para>
</section> </section>
<section><title>Backups and Disaster Recovery</title> <section xml:id="module-services-foundationdb-disaster-recovery"><title>Backups and Disaster Recovery</title>
<para>The usual rules for doing FoundationDB backups apply on NixOS as written <para>The usual rules for doing FoundationDB backups apply on NixOS as written
in the FoundationDB manual. However, one important difference is the security in the FoundationDB manual. However, one important difference is the security
@ -316,7 +316,7 @@ $ sudo -u foundationdb fdbbackup status -t default
</section> </section>
<section><title>Known limitations</title> <section xml:id="module-services-foundationdb-limitations"><title>Known limitations</title>
<para>The FoundationDB setup for NixOS should currently be considered beta. <para>The FoundationDB setup for NixOS should currently be considered beta.
FoundationDB is not new software, but the NixOS compilation and integration has FoundationDB is not new software, but the NixOS compilation and integration has
@ -333,7 +333,7 @@ only undergone fairly basic testing of all the available functionality.</para>
</section> </section>
<section><title>Options</title> <section xml:id="module-services-foundationdb-options"><title>Options</title>
<para>NixOS's FoundationDB module allows you to configure all of the most <para>NixOS's FoundationDB module allows you to configure all of the most
relevant configuration options for <command>fdbmonitor</command>, matching it relevant configuration options for <command>fdbmonitor</command>, matching it
@ -343,7 +343,7 @@ also read the FoundationDB documentation as well.</para>
</section> </section>
<section><title>Full documentation</title> <section xml:id="module-services-foundationdb-full-docs"><title>Full documentation</title>
<para>FoundationDB is a complex piece of software, and requires careful <para>FoundationDB is a complex piece of software, and requires careful
administration to properly use. Full documentation for administration can be administration to properly use. Full documentation for administration can be

View File

@ -17,7 +17,7 @@
<para>PostgreSQL is an advanced, free relational database.<!-- MORE --></para> <para>PostgreSQL is an advanced, free relational database.<!-- MORE --></para>
<section><title>Configuring</title> <section xml:id="module-services-postgres-configuring"><title>Configuring</title>
<para>To enable PostgreSQL, add the following to your <para>To enable PostgreSQL, add the following to your
<filename>configuration.nix</filename>: <filename>configuration.nix</filename>:
@ -60,14 +60,14 @@ alice=>
</section> </section>
<section><title>Upgrading</title> <section xml:id="module-services-postgres-upgrading"><title>Upgrading</title>
<para>FIXME: document dump/upgrade/load cycle.</para> <para>FIXME: document dump/upgrade/load cycle.</para>
</section> </section>
<section><title>Options</title> <section xml:id="module-services-postgres-options"><title>Options</title>
<para>A complete list of options for the PostgreSQL module may be found <link linkend="opt-services.postgresql.enable">here</link>.</para> <para>A complete list of options for the PostgreSQL module may be found <link linkend="opt-services.postgresql.enable">here</link>.</para>

View File

@ -39,7 +39,7 @@
starting the Emacs daemon. starting the Emacs daemon.
</para> </para>
<section> <section xml:id="module-services-emacs-installing">
<title>Installing <application>Emacs</application></title> <title>Installing <application>Emacs</application></title>
<para> <para>
@ -49,7 +49,7 @@
can be enabled. can be enabled.
</para> </para>
<section> <section xml:id="module-services-emacs-releases">
<title>The Different Releases of Emacs</title> <title>The Different Releases of Emacs</title>
<para> <para>
@ -100,7 +100,7 @@
</para> </para>
</section> </section>
<section> <section xml:id="module-services-emacs-adding-packages">
<title>Adding Packages to Emacs</title> <title>Adding Packages to Emacs</title>
<para> <para>
Emacs includes an entire ecosystem of functionality beyond Emacs includes an entire ecosystem of functionality beyond
@ -339,7 +339,7 @@ https://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides
</para> </para>
</section> </section>
<section> <section xml:id="module-services-emacs-advanced">
<title>Advanced Emacs Configuration</title> <title>Advanced Emacs Configuration</title>
<para> <para>
@ -380,7 +380,7 @@ in [...]
</section> </section>
</section> </section>
<section> <section xml:id="module-services-emacs-running">
<title>Running Emacs as a Service</title> <title>Running Emacs as a Service</title>
<para> <para>
<productname>NixOS</productname> provides an optional <productname>NixOS</productname> provides an optional
@ -396,7 +396,7 @@ in [...]
<filename>modules/services/editors/emacs.nix</filename> <filename>modules/services/editors/emacs.nix</filename>
</para> </para>
<section> <section xml:id="module-services-emacs-enabling">
<title>Enabling the Service</title> <title>Enabling the Service</title>
<para> <para>
@ -438,7 +438,7 @@ $ systemctl --user start emacs.service # to start the Emacs daemon
</section> </section>
<section> <section xml:id="module-services-emacs-starting-client">
<title>Starting the client</title> <title>Starting the client</title>
<para> <para>
Ensure that the emacs server is enabled, either by customizing Ensure that the emacs server is enabled, either by customizing
@ -457,7 +457,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
</para> </para>
</section> </section>
<section> <section xml:id="module-services-emacs-editor-variable">
<title>Configuring the <varname>EDITOR</varname> variable</title> <title>Configuring the <varname>EDITOR</varname> variable</title>
<!--<title><command>emacsclient</command> as the Default Editor</title>--> <!--<title><command>emacsclient</command> as the Default Editor</title>-->
@ -487,7 +487,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
</para> </para>
</section> </section>
<section> <section xml:id="module-services-emacs-per-user">
<title>Per-User Enabling of the Service</title> <title>Per-User Enabling of the Service</title>
<para> <para>
@ -515,7 +515,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
</section> </section>
</section> </section>
<section> <section xml:id="module-services-emacs-configuring">
<title>Configuring Emacs</title> <title>Configuring Emacs</title>
<para> <para>
@ -548,7 +548,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
server-switch-hook, server-done-hook? server-switch-hook, server-done-hook?
--> -->
<section> <section xml:id="module-services-emacs-major-mode">
<title>A Major Mode for Nix Expressions</title> <title>A Major Mode for Nix Expressions</title>
<para> <para>
@ -558,7 +558,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
</para> </para>
</section> </section>
<section> <section xml:id="module-services-emacs-man-pages">
<title>Accessing man pages</title> <title>Accessing man pages</title>
<para> <para>
You can use <function>woman</function> to get completion of all You can use <function>woman</function> to get completion of all

View File

@ -8,7 +8,7 @@
<para>Gitlab is a feature-rich git hosting service.</para> <para>Gitlab is a feature-rich git hosting service.</para>
<section><title>Prerequisites</title> <section xml:id="module-services-gitlab-prerequisites"><title>Prerequisites</title>
<para>The gitlab service exposes only an Unix socket at <para>The gitlab service exposes only an Unix socket at
<literal>/run/gitlab/gitlab-workhorse.socket</literal>. You need to configure a <literal>/run/gitlab/gitlab-workhorse.socket</literal>. You need to configure a
@ -35,7 +35,7 @@ webserver to proxy HTTP requests to the socket.</para>
</section> </section>
<section><title>Configuring</title> <section xml:id="module-services-gitlab-configuring"><title>Configuring</title>
<para>Gitlab depends on both PostgreSQL and Redis and will automatically enable <para>Gitlab depends on both PostgreSQL and Redis and will automatically enable
both services. In the case of PostgreSQL, a database and a role will be created. both services. In the case of PostgreSQL, a database and a role will be created.
@ -119,7 +119,7 @@ options for the <link linkend="opt-services.gitlab.enable">services.gitlab</link
</section> </section>
<section><title>Maintenance</title> <section xml:id="module-services-gitlab-maintenance"><title>Maintenance</title>
<para>You can run Gitlab's rake tasks with <literal>gitlab-rake</literal> <para>You can run Gitlab's rake tasks with <literal>gitlab-rake</literal>
which will be available on the system when gitlab is enabled. You will which will be available on the system when gitlab is enabled. You will

View File

@ -16,7 +16,7 @@
<link xlink:href="https://taskwarrior.org/docs/#taskd"/> <link xlink:href="https://taskwarrior.org/docs/#taskd"/>
</para> </para>
<section> <section xml:id="module-services-taskserver-configuration">
<title>Configuration</title> <title>Configuration</title>
<para> <para>
@ -48,7 +48,7 @@
</para> </para>
</section> </section>
<section> <section xml:id="module-services-taskserver-nixos-taskserver-tool">
<title>The nixos-taskserver tool</title> <title>The nixos-taskserver tool</title>
<para> <para>
@ -78,7 +78,7 @@
<option>--help</option> switch. <option>--help</option> switch.
</para> </para>
</section> </section>
<section> <section xml:id="module-services-taskserver-declarative-ca-management">
<title>Declarative/automatic CA management</title> <title>Declarative/automatic CA management</title>
<para> <para>
@ -131,7 +131,7 @@ $ ssh server nixos-taskserver user export my-company alice | sh
<command>task sync</command> after that stage. <command>task sync</command> after that stage.
</para> </para>
</section> </section>
<section> <section xml:id="module-services-taskserver-manual-ca-management">
<title>Manual CA management</title> <title>Manual CA management</title>
<para> <para>

View File

@ -8,7 +8,7 @@
<para>Prometheus exporters provide metrics for the <link xlink:href="https://prometheus.io">prometheus monitoring system</link>.</para> <para>Prometheus exporters provide metrics for the <link xlink:href="https://prometheus.io">prometheus monitoring system</link>.</para>
<section><title>Configuration</title> <section xml:id="module-services-prometheus-exporters-configuration"><title>Configuration</title>
<para>One of the most common exporters is the <link xlink:href="https://github.com/prometheus/node_exporter">node exporter</link>, it provides hardware and OS metrics from the host it's running on. The exporter could be configured as follows: <para>One of the most common exporters is the <link xlink:href="https://github.com/prometheus/node_exporter">node exporter</link>, it provides hardware and OS metrics from the host it's running on. The exporter could be configured as follows:
<programlisting> <programlisting>
services.promtheus.exporters.node = { services.promtheus.exporters.node = {
@ -33,7 +33,7 @@ For more information about configuration see <literal>man configuration.nix</lit
search through the <link xlink:href="https://nixos.org/nixos/options.html#prometheus.exporters">available options</link>. search through the <link xlink:href="https://nixos.org/nixos/options.html#prometheus.exporters">available options</link>.
</para> </para>
</section> </section>
<section><title>Adding a new exporter</title> <section xml:id="module-services-prometheus-exporters-new-exporter"><title>Adding a new exporter</title>
<para>To add a new exporter, it has to be packaged first (see <literal>nixpkgs/pkgs/servers/monitoring/prometheus/</literal> for examples), then a module can be added. The postfix exporter is used in this example:</para> <para>To add a new exporter, it has to be packaged first (see <literal>nixpkgs/pkgs/servers/monitoring/prometheus/</literal> for examples), then a module can be added. The postfix exporter is used in this example:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>

View File

@ -14,7 +14,7 @@
upstream is trustworthy). upstream is trustworthy).
</para> </para>
<sect1><title>Basic configuration</title> <sect1 xml:id="sec-dnscrypt-proxy-configuration"><title>Basic configuration</title>
<para> <para>
To enable the client proxy, set To enable the client proxy, set
@ -31,7 +31,7 @@
</sect1> </sect1>
<sect1><title>As a forwarder for another DNS client</title> <sect1 xml:id="sec-dnscrypt-proxy-forwarder"><title>As a forwarder for another DNS client</title>
<para> <para>
To run the DNSCrypt proxy client as a forwarder for another To run the DNSCrypt proxy client as a forwarder for another
@ -42,7 +42,7 @@
</programlisting> </programlisting>
</para> </para>
<sect2><title>dnsmasq</title> <sect2 xml:id="sec-dnscrypt-proxy-forwarder-dsnmasq"><title>dnsmasq</title>
<para> <para>
<programlisting> <programlisting>
{ {
@ -53,7 +53,7 @@
</para> </para>
</sect2> </sect2>
<sect2><title>unbound</title> <sect2 xml:id="sec-dnscrypt-proxy-forwarder-unbound"><title>unbound</title>
<para> <para>
<programlisting> <programlisting>
{ {

View File

@ -15,7 +15,7 @@
</para> </para>
<section> <section xml:id="module-services-matomo-database-setup">
<title>Database Setup</title> <title>Database Setup</title>
<para> <para>
@ -51,7 +51,7 @@
</section> </section>
<section> <section xml:id="module-services-matomo-backups">
<title>Backup</title> <title>Backup</title>
<para> <para>
You only need to take backups of your MySQL database and the You only need to take backups of your MySQL database and the
@ -62,7 +62,7 @@
</section> </section>
<section> <section xml:id="module-services-matomo-issues">
<title>Issues</title> <title>Issues</title>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -83,7 +83,7 @@
</section> </section>
<section> <section xml:id="module-services-matomo-other-web-servers">
<title>Using other Web Servers than nginx</title> <title>Using other Web Servers than nginx</title>
<para> <para>