mirror of
https://github.com/NixOS/nixpkgs.git
synced 2026-10-02 13:00:23 +00:00
doc/nixos: migrate inline includes to nav.json
This commit is contained in:
Johannes Kirschbauer
@@ -20,9 +20,3 @@ get upgraded along with your host system when you run `nixos-rebuild`,
|
||||
which is often not what you want. By contrast, in the imperative
|
||||
approach, containers are configured and updated independently from the
|
||||
host system.
|
||||
|
||||
```{=include=} sections
|
||||
imperative-containers.section.md
|
||||
declarative-containers.section.md
|
||||
container-networking.section.md
|
||||
```
|
||||
|
||||
@@ -1,15 +1,3 @@
|
||||
# Administration {#ch-running}
|
||||
|
||||
This chapter describes various aspects of managing a running NixOS system, such as how to use the {command}`systemd` service manager.
|
||||
|
||||
```{=include=} chapters
|
||||
service-mgmt.chapter.md
|
||||
rebooting.chapter.md
|
||||
user-sessions.chapter.md
|
||||
control-groups.chapter.md
|
||||
logging.chapter.md
|
||||
system-state.chapter.md
|
||||
cleaning-store.chapter.md
|
||||
containers.chapter.md
|
||||
troubleshooting.chapter.md
|
||||
```
|
||||
|
||||
@@ -8,10 +8,3 @@ However, it is possible and not-uncommon to create [impermanent systems], whose
|
||||
this kind of configuration, special care needs to be taken.
|
||||
|
||||
[impermanent systems]: https://wiki.nixos.org/wiki/Impermanence
|
||||
|
||||
|
||||
```{=include=} sections
|
||||
nixos-state.section.md
|
||||
systemd-state.section.md
|
||||
zfs-state.section.md
|
||||
```
|
||||
|
||||
@@ -2,11 +2,3 @@
|
||||
|
||||
This chapter describes solutions to common problems you might encounter
|
||||
when you manage your NixOS system.
|
||||
|
||||
```{=include=} sections
|
||||
boot-problems.section.md
|
||||
maintenance-mode.section.md
|
||||
rollback.section.md
|
||||
store-corruption.section.md
|
||||
network-problems.section.md
|
||||
```
|
||||
|
||||
@@ -10,9 +10,3 @@ of the Nix language are fully described in the [Nix
|
||||
manual](https://nixos.org/nix/manual/#chap-writing-nix-expressions), but
|
||||
here we give a short overview of the most important constructs useful in
|
||||
NixOS configuration files.
|
||||
|
||||
```{=include=} sections
|
||||
config-file.section.md
|
||||
abstractions.section.md
|
||||
modularity.section.md
|
||||
```
|
||||
|
||||
@@ -2,27 +2,4 @@
|
||||
|
||||
This chapter describes how to configure various aspects of a NixOS machine through the configuration file {file}`/etc/nixos/configuration.nix`. As described in [](#sec-changing-config), changes to this file only take effect after you run {command}`nixos-rebuild`.
|
||||
|
||||
```{=include=} chapters
|
||||
config-syntax.chapter.md
|
||||
package-mgmt.chapter.md
|
||||
user-mgmt.chapter.md
|
||||
file-systems.chapter.md
|
||||
x-windows.chapter.md
|
||||
wayland.chapter.md
|
||||
gpu-accel.chapter.md
|
||||
xfce.chapter.md
|
||||
networking.chapter.md
|
||||
linux-kernel.chapter.md
|
||||
subversion.chapter.md
|
||||
```
|
||||
|
||||
```{=include=} chapters
|
||||
@MODULE_CHAPTERS@
|
||||
```
|
||||
|
||||
```{=include=} chapters
|
||||
profiles.chapter.md
|
||||
mattermost.chapter.md
|
||||
kubernetes.chapter.md
|
||||
```
|
||||
<!-- Apache; libvirtd virtualisation -->
|
||||
|
||||
@@ -39,8 +39,3 @@ configuration, use `pkgs` prefix (variable).
|
||||
|
||||
To "uninstall" a package, remove it from
|
||||
[](#opt-environment.systemPackages) and run `nixos-rebuild switch`.
|
||||
|
||||
```{=include=} sections
|
||||
customizing-packages.section.md
|
||||
adding-custom-packages.section.md
|
||||
```
|
||||
|
||||
@@ -37,10 +37,3 @@ System startup will fail if any of the filesystems fails to mount,
|
||||
dropping you to the emergency shell. You can make a mount asynchronous
|
||||
and non-critical by adding `options = [ "nofail" ];`.
|
||||
:::
|
||||
|
||||
```{=include=} sections
|
||||
luks-file-systems.section.md
|
||||
sshfs-file-systems.section.md
|
||||
nfs-file-systems.section.md
|
||||
overlayfs.section.md
|
||||
```
|
||||
|
||||
@@ -3,14 +3,4 @@
|
||||
This section describes how to configure networking components
|
||||
on your NixOS machine.
|
||||
|
||||
```{=include=} sections
|
||||
network-manager.section.md
|
||||
ssh.section.md
|
||||
ipv4-config.section.md
|
||||
ipv6-config.section.md
|
||||
firewall.section.md
|
||||
wireless.section.md
|
||||
ad-hoc-network-config.section.md
|
||||
renaming-interfaces.section.md
|
||||
```
|
||||
<!-- TODO: OpenVPN, NAT -->
|
||||
|
||||
@@ -11,8 +11,3 @@ NixOS has two distinct styles of package management:
|
||||
- *Ad hoc*, where you install, upgrade and uninstall packages via the
|
||||
`nix-env` command. This style allows mixing packages from different
|
||||
Nixpkgs versions. It's the only choice for non-root users.
|
||||
|
||||
```{=include=} sections
|
||||
declarative-packages.section.md
|
||||
ad-hoc-packages.section.md
|
||||
```
|
||||
|
||||
@@ -16,17 +16,3 @@ install media, many are actually intended to be used in real installs.
|
||||
|
||||
What follows is a brief explanation of the purpose and use-case for each
|
||||
profile. Detailing each option configured by each one is out of scope.
|
||||
|
||||
```{=include=} sections
|
||||
profiles/all-hardware.section.md
|
||||
profiles/base.section.md
|
||||
profiles/clone-config.section.md
|
||||
profiles/demo.section.md
|
||||
profiles/docker-container.section.md
|
||||
profiles/graphical.section.md
|
||||
profiles/headless.section.md
|
||||
profiles/installation-device.section.md
|
||||
profiles/perlless.section.md
|
||||
profiles/minimal.section.md
|
||||
profiles/qemu-guest.section.md
|
||||
```
|
||||
|
||||
@@ -1,16 +1,3 @@
|
||||
# Development {#ch-development}
|
||||
|
||||
This chapter describes how you can modify and extend NixOS.
|
||||
|
||||
```{=include=} chapters
|
||||
sources.chapter.md
|
||||
writing-modules.chapter.md
|
||||
building-parts.chapter.md
|
||||
bootspec.chapter.md
|
||||
what-happens-during-a-system-switch.chapter.md
|
||||
writing-documentation.chapter.md
|
||||
nixos-tests.chapter.md
|
||||
developing-the-test-driver.chapter.md
|
||||
testing-installer.chapter.md
|
||||
modular-services.md
|
||||
```
|
||||
|
||||
@@ -4,11 +4,3 @@ When you add some feature to NixOS, you should write a test for it.
|
||||
NixOS tests are kept in the directory `nixos/tests`, and are executed
|
||||
(using Nix) by a testing framework that automatically starts one or more
|
||||
virtual machines containing the NixOS system(s) required for the test.
|
||||
|
||||
```{=include=} sections
|
||||
writing-nixos-tests.section.md
|
||||
running-nixos-tests.section.md
|
||||
running-nixos-tests-interactively.section.md
|
||||
linking-nixos-tests-to-packages.section.md
|
||||
testing-hardware-features.section.md
|
||||
```
|
||||
|
||||
@@ -53,10 +53,3 @@ More detailed output can be displayed by setting `STC_DEBUG=1`.
|
||||
Most of these actions are either self-explaining but some of them have to do
|
||||
with our units or the activation script. For this reason, these topics are
|
||||
explained in the next sections.
|
||||
|
||||
```{=include=} sections
|
||||
unit-handling.section.md
|
||||
activation-script.section.md
|
||||
non-switchable-systems.section.md
|
||||
etc-overlay.section.md
|
||||
```
|
||||
|
||||
@@ -209,16 +209,3 @@ in
|
||||
}
|
||||
```
|
||||
:::
|
||||
|
||||
```{=include=} sections
|
||||
option-declarations.section.md
|
||||
option-types.section.md
|
||||
option-def.section.md
|
||||
assertions.section.md
|
||||
meta-attributes.section.md
|
||||
importing-modules.section.md
|
||||
replace-modules.section.md
|
||||
freeform-modules.section.md
|
||||
settings-options.section.md
|
||||
state-revision.section.md
|
||||
```
|
||||
|
||||
@@ -1,13 +1,3 @@
|
||||
# Installation {#ch-installation}
|
||||
|
||||
This section describes how to obtain, install, and configure NixOS for first-time use.
|
||||
|
||||
```{=include=} chapters
|
||||
obtaining.chapter.md
|
||||
installing.chapter.md
|
||||
changing-config.chapter.md
|
||||
upgrading.chapter.md
|
||||
building-nixos.chapter.md
|
||||
building-images-via-nixos-rebuild-build-image.chapter.md
|
||||
building-images-via-systemd-repart.chapter.md
|
||||
```
|
||||
|
||||
@@ -577,12 +577,3 @@ With a partitioned disk.
|
||||
:::
|
||||
|
||||
## Additional installation notes {#sec-installation-additional-notes}
|
||||
|
||||
```{=include=} sections
|
||||
installing-usb.section.md
|
||||
installing-pxe.section.md
|
||||
installing-kexec.section.md
|
||||
installing-virtualbox-guest.section.md
|
||||
installing-from-other-distro.section.md
|
||||
installing-behind-a-proxy.section.md
|
||||
```
|
||||
|
||||
@@ -32,21 +32,6 @@
|
||||
|
||||
-->
|
||||
|
||||
```{=include=} preface
|
||||
preface.md
|
||||
```
|
||||
|
||||
```{=include=} parts
|
||||
installation/installation.md
|
||||
configuration/configuration.md
|
||||
administration/running.md
|
||||
development/development.md
|
||||
```
|
||||
|
||||
```{=include=} chapters
|
||||
contributing-to-this-manual.chapter.md
|
||||
```
|
||||
|
||||
```{=include=} appendix html:into-file=//options.html
|
||||
nixos-options.md
|
||||
```
|
||||
|
||||
@@ -1,4 +1,446 @@
|
||||
{
|
||||
"open": [],
|
||||
"items": []
|
||||
"items": [
|
||||
{
|
||||
"file": "preface.md"
|
||||
},
|
||||
{
|
||||
"label": "Installation",
|
||||
"id": "ch-installation",
|
||||
"children": [
|
||||
{
|
||||
"file": "installation/installation.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/obtaining.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "Installing NixOS",
|
||||
"id": "sec-installation",
|
||||
"children": [
|
||||
{
|
||||
"file": "installation/installing.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/installing-usb.section.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/installing-pxe.section.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/installing-kexec.section.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/installing-virtualbox-guest.section.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/installing-from-other-distro.section.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/installing-behind-a-proxy.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "installation/changing-config.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/upgrading.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/building-nixos.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/building-images-via-nixos-rebuild-build-image.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "installation/building-images-via-systemd-repart.chapter.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Configuration",
|
||||
"id": "ch-configuration",
|
||||
"children": [
|
||||
{
|
||||
"file": "configuration/configuration.md"
|
||||
},
|
||||
{
|
||||
"label": "Configuration Syntax",
|
||||
"id": "sec-configuration-syntax",
|
||||
"children": [
|
||||
{
|
||||
"file": "configuration/config-syntax.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/config-file.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/abstractions.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/modularity.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Package Management",
|
||||
"id": "sec-package-management",
|
||||
"children": [
|
||||
{
|
||||
"file": "configuration/package-mgmt.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "Declarative Package Management",
|
||||
"id": "sec-declarative-package-mgmt",
|
||||
"children": [
|
||||
{
|
||||
"file": "configuration/declarative-packages.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/customizing-packages.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/adding-custom-packages.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "configuration/ad-hoc-packages.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "configuration/user-mgmt.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "File Systems",
|
||||
"id": "ch-file-systems",
|
||||
"children": [
|
||||
{
|
||||
"file": "configuration/file-systems.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/luks-file-systems.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/sshfs-file-systems.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/nfs-file-systems.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/overlayfs.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "configuration/x-windows.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/wayland.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/gpu-accel.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/xfce.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "Networking",
|
||||
"id": "sec-networking",
|
||||
"children": [
|
||||
{
|
||||
"file": "configuration/networking.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/network-manager.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/ssh.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/ipv4-config.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/ipv6-config.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/firewall.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/wireless.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/ad-hoc-network-config.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/renaming-interfaces.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "configuration/linux-kernel.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/subversion.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/@MODULE_CHAPTERS@"
|
||||
},
|
||||
{
|
||||
"label": "Profiles",
|
||||
"id": "ch-profiles",
|
||||
"children": [
|
||||
{
|
||||
"file": "configuration/profiles.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/all-hardware.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/base.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/clone-config.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/demo.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/docker-container.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/graphical.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/headless.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/installation-device.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/perlless.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/minimal.section.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/profiles/qemu-guest.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "configuration/mattermost.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "configuration/kubernetes.chapter.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Administration",
|
||||
"id": "ch-running",
|
||||
"children": [
|
||||
{
|
||||
"file": "administration/running.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/service-mgmt.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/rebooting.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/user-sessions.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/control-groups.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/logging.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "Necessary system state",
|
||||
"id": "ch-system-state",
|
||||
"children": [
|
||||
{
|
||||
"file": "administration/system-state.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/nixos-state.section.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/systemd-state.section.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/zfs-state.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "administration/cleaning-store.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "Container Management",
|
||||
"id": "ch-containers",
|
||||
"children": [
|
||||
{
|
||||
"file": "administration/containers.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/imperative-containers.section.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/declarative-containers.section.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/container-networking.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Troubleshooting",
|
||||
"id": "ch-troubleshooting",
|
||||
"children": [
|
||||
{
|
||||
"file": "administration/troubleshooting.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/boot-problems.section.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/maintenance-mode.section.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/rollback.section.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/store-corruption.section.md"
|
||||
},
|
||||
{
|
||||
"file": "administration/network-problems.section.md"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Development",
|
||||
"id": "ch-development",
|
||||
"children": [
|
||||
{
|
||||
"file": "development/development.md"
|
||||
},
|
||||
{
|
||||
"file": "development/sources.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "Writing NixOS Modules",
|
||||
"id": "sec-writing-modules",
|
||||
"children": [
|
||||
{
|
||||
"file": "development/writing-modules.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "development/option-declarations.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/option-types.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/option-def.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/assertions.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/meta-attributes.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/importing-modules.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/replace-modules.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/freeform-modules.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/settings-options.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/state-revision.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "development/building-parts.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "development/bootspec.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "What happens during a system switch?",
|
||||
"id": "sec-switching-systems",
|
||||
"children": [
|
||||
{
|
||||
"file": "development/what-happens-during-a-system-switch.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "development/unit-handling.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/activation-script.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/non-switchable-systems.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/etc-overlay.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "development/writing-documentation.chapter.md"
|
||||
},
|
||||
{
|
||||
"label": "NixOS Tests",
|
||||
"id": "sec-nixos-tests",
|
||||
"children": [
|
||||
{
|
||||
"file": "development/nixos-tests.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "development/writing-nixos-tests.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/running-nixos-tests.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/running-nixos-tests-interactively.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/linking-nixos-tests-to-packages.section.md"
|
||||
},
|
||||
{
|
||||
"file": "development/testing-hardware-features.section.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "development/developing-the-test-driver.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "development/testing-installer.chapter.md"
|
||||
},
|
||||
{
|
||||
"file": "development/modular-services.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"file": "contributing-to-this-manual.chapter.md"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user