diff options
Diffstat (limited to 'nixos/doc/manual/installation')
5 files changed, 51 insertions, 45 deletions
diff --git a/nixos/doc/manual/installation/changing-config.xml b/nixos/doc/manual/installation/changing-config.xml index 4db9020b9606..52d8a292f8be 100644 --- a/nixos/doc/manual/installation/changing-config.xml +++ b/nixos/doc/manual/installation/changing-config.xml @@ -75,7 +75,7 @@ have set <literal>mutableUsers = false</literal>. Another way is to temporarily add the following to your configuration: <screen> -users.extraUsers.your-user.initialPassword = "test" +<link linkend="opt-users.users._name__.initialHashedPassword">users.extraUsers.your-user.initialHashedPassword</link> = "test"; </screen> <emphasis>Important:</emphasis> delete the $hostname.qcow2 file if you diff --git a/nixos/doc/manual/installation/installing-from-other-distro.xml b/nixos/doc/manual/installation/installing-from-other-distro.xml index ecd020a067a9..7e6ddb05cd66 100644 --- a/nixos/doc/manual/installation/installing-from-other-distro.xml +++ b/nixos/doc/manual/installation/installing-from-other-distro.xml @@ -111,7 +111,7 @@ $ nix-channel --add https://nixos.org/channels/nixos-<replaceable>version</repla <literal>configuration.nix</literal>:</para> <programlisting> -boot.loader.grub.extraEntries = '' +<xref linkend="opt-boot.loader.grub.extraEntries"/> = '' menuentry "Ubuntu" { search --set=ubuntu --fs-uuid 3cc3e652-0c1f-4800-8451-033754f68e6e configfile "($ubuntu)/boot/grub/grub.cfg" @@ -183,7 +183,9 @@ $ sudo groupdel nixbld</screen> account with <literal>sudo passwd -l root</literal> if you use <literal>sudo</literal>)</para> - <programlisting>users.extraUsers.root.initialHashedPassword = "";</programlisting> + <programlisting> +<link linkend="opt-users.users._name__.initialHashedPassword">users.extraUsers.root.initialHashedPassword</link> = ""; + </programlisting> </listitem> <listitem> @@ -243,13 +245,15 @@ $ sudo groupdel nixbld</screen> <screen> $ sudo touch /etc/NIXOS -$ sudo touch /etc/NIXOS_LUSTRATE</screen> +$ sudo touch /etc/NIXOS_LUSTRATE + </screen> <para>Let's also make sure the NixOS configuration files are kept once we reboot on NixOS:</para> <screen> -$ echo etc/nixos | sudo tee -a /etc/NIXOS_LUSTRATE</screen> +$ echo etc/nixos | sudo tee -a /etc/NIXOS_LUSTRATE + </screen> </listitem> <listitem> diff --git a/nixos/doc/manual/installation/installing-virtualbox-guest.xml b/nixos/doc/manual/installation/installing-virtualbox-guest.xml index 7fcd22a112cf..2b31b7ed3152 100644 --- a/nixos/doc/manual/installation/installing-virtualbox-guest.xml +++ b/nixos/doc/manual/installation/installing-virtualbox-guest.xml @@ -42,7 +42,7 @@ </para> <programlisting> -boot.loader.grub.device = "/dev/sda"; +<xref linkend="opt-boot.loader.grub.device"/> = "/dev/sda"; </programlisting> <para> @@ -51,7 +51,7 @@ boot.loader.grub.device = "/dev/sda"; </para> <programlisting> -boot.initrd.checkJournalingFS = false; +<xref linkend="opt-boot.initrd.checkJournalingFS"/> = false; </programlisting> <para> diff --git a/nixos/doc/manual/installation/installing.xml b/nixos/doc/manual/installation/installing.xml index 1f09704bce53..6b08bdb318bc 100644 --- a/nixos/doc/manual/installation/installing.xml +++ b/nixos/doc/manual/installation/installing.xml @@ -203,26 +203,29 @@ for a UEFI installation is by and large the same as a BIOS installation. The dif <variablelist> <varlistentry><term>BIOS systems</term> - <listitem><para>You <emphasis>must</emphasis> set the option - <option>boot.loader.grub.device</option> to specify on which disk - the GRUB boot loader is to be installed. Without it, NixOS cannot - boot.</para></listitem></varlistentry> + <listitem><para>You <emphasis>must</emphasis> set the option + <xref linkend="opt-boot.loader.grub.device"/> to specify on which disk + the GRUB boot loader is to be installed. Without it, NixOS cannot + boot.</para></listitem></varlistentry> <varlistentry><term>UEFI systems</term> - <listitem><para>You <emphasis>must</emphasis> set the option - <option>boot.loader.systemd-boot.enable</option> to <literal>true</literal>. - <command>nixos-generate-config</command> should do this automatically for new - configurations when booted in - UEFI mode.</para> - <para>You may want to look at the options starting with - <option>boot.loader.efi</option> and <option>boot.loader.systemd-boot</option> - as well.</para></listitem></varlistentry> + <listitem><para>You <emphasis>must</emphasis> set the option + <xref linkend="opt-boot.loader.systemd-boot.enable"/> to <literal>true</literal>. + <command>nixos-generate-config</command> should do this automatically for new + configurations when booted in + UEFI mode.</para> + <para>You may want to look at the options starting with + <option><link linkend="opt-boot.loader.efi.canTouchEfiVariables">boot.loader.efi</link></option> and + <option><link linkend="opt-boot.loader.systemd-boot.enable">boot.loader.systemd</link></option> as well. + </para> + </listitem> + </varlistentry> </variablelist> <para>If there are other operating systems running on the machine before installing NixOS, the - <option>boot.loader.grub.useOSProber</option> option can be set to + <xref linkend="opt-boot.loader.grub.useOSProber"/> option can be set to <literal>true</literal> to automatically add them to the grub menu.</para> <para>Another critical option is <option>fileSystems</option>, @@ -264,15 +267,15 @@ for a UEFI installation is by and large the same as a BIOS installation. The dif <para>As the last step, <command>nixos-install</command> will ask you to set the password for the <literal>root</literal> user, e.g. -<screen> + <screen> setting root password... Enter new UNIX password: *** Retype new UNIX password: *** -</screen> + </screen> <note> <para> - To prevent the password prompt, set <code>users.mutableUsers = false;</code> in + To prevent the password prompt, set <code><xref linkend="opt-users.mutableUsers"/> = false;</code> in <filename>configuration.nix</filename>, which allows unattended installation necessary in automation. </para> @@ -285,20 +288,20 @@ Retype new UNIX password: *** <listitem> <para>If everything went well: -<screen> -# reboot</screen> + <screen> + # reboot</screen> </para></listitem> <listitem> <para>You should now be able to boot into the installed NixOS. The - GRUB boot menu shows a list of <emphasis>available - configurations</emphasis> (initially just one). Every time you - change the NixOS configuration (see <link - linkend="sec-changing-config">Changing Configuration</link> ), a - new item is added to the menu. This allows you to easily roll back - to a previous configuration if something goes wrong.</para> + GRUB boot menu shows a list of <emphasis>available + configurations</emphasis> (initially just one). Every time you + change the NixOS configuration (see <link + linkend="sec-changing-config">Changing Configuration</link> ), a + new item is added to the menu. This allows you to easily roll back + to a previous configuration if something goes wrong.</para> <para>You should log in and change the <literal>root</literal> password with <command>passwd</command>.</para> @@ -372,26 +375,25 @@ drive (here <filename>/dev/sda</filename>). <xref linkend="ex-config" </example> <example xml:id='ex-config'><title>NixOS Configuration</title> -<screen> -{ config, pkgs, ... }: - -{ - imports = - [ # Include the results of the hardware scan. - ./hardware-configuration.nix - ]; + <screen> +{ config, pkgs, ... }: { + imports = [ + # Include the results of the hardware scan. + ./hardware-configuration.nix + ]; - boot.loader.grub.device = "/dev/sda"; # <lineannotation>(for BIOS systems only)</lineannotation> - boot.loader.systemd-boot.enable = true; # <lineannotation>(for UEFI systems only)</lineannotation> + <xref linkend="opt-boot.loader.grub.device"/> = "/dev/sda"; # <lineannotation>(for BIOS systems only)</lineannotation> + <xref linkend="opt-boot.loader.systemd-boot.enable"/> = true; # <lineannotation>(for UEFI systems only)</lineannotation> # Note: setting fileSystems is generally not # necessary, since nixos-generate-config figures them out # automatically in hardware-configuration.nix. - #fileSystems."/".device = "/dev/disk/by-label/nixos"; + #<link linkend="opt-fileSystems._name__.device">fileSystems."/".device</link> = "/dev/disk/by-label/nixos"; # Enable the OpenSSH server. services.sshd.enable = true; -}</screen> +} + </screen> </example> <xi:include href="installing-usb.xml" /> diff --git a/nixos/doc/manual/installation/upgrading.xml b/nixos/doc/manual/installation/upgrading.xml index aee6523345c4..24881c8fec0f 100644 --- a/nixos/doc/manual/installation/upgrading.xml +++ b/nixos/doc/manual/installation/upgrading.xml @@ -119,7 +119,7 @@ able to go back to your original channel.</para></warning> the following to <filename>configuration.nix</filename>: <programlisting> -system.autoUpgrade.enable = true; +<xref linkend="opt-system.autoUpgrade.enable"/> = true; </programlisting> This enables a periodically executed systemd service named @@ -130,7 +130,7 @@ runs, see <command>systemctl list-timers</command>.) You can also specify a channel explicitly, e.g. <programlisting> -system.autoUpgrade.channel = https://nixos.org/channels/nixos-17.03; +<xref linkend="opt-system.autoUpgrade.channel"/> = https://nixos.org/channels/nixos-17.03; </programlisting> </para> |