commit 5de68de484a67e3e7db053c67721c3fc66af793e · pyrox.dev/nixpkgs

+11

nixos/doc/manual/administration/maintenance-mode.section.md

···

       1
       1
       +
       # Maintenance Mode {#sec-maintenance-mode}

     

       2
       2
       +
       

     

       3
       3
       +
       You can enter rescue mode by running:

     

       4
       4
       +
       

     

       5
       5
       +
       ```ShellSession

     

       6
       6
       +
       # systemctl rescue

     

       7
       7
       +
       ```

     

       8
       8
       +
       

     

       9
       9
       +
       This will eventually give you a single-user root shell. Systemd will

     

       10
       10
       +
       stop (almost) all system services. To get out of maintenance mode, just

     

       11
       11
       +
       exit from the rescue shell.

-16

nixos/doc/manual/administration/maintenance-mode.xml

···

       1
       1
       -
       <section xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
               xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
               xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
               version="5.0"

     

       5
       5
       -
               xml:id="sec-maintenance-mode">

     

       6
       6
       -
        <title>Maintenance Mode</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         You can enter rescue mode by running:

     

       10
       10
       -
       <screen>

     

       11
       11
       -
       <prompt># </prompt>systemctl rescue</screen>

     

       12
       12
       -
         This will eventually give you a single-user root shell. Systemd will stop

     

       13
       13
       -
         (almost) all system services. To get out of maintenance mode, just exit from

     

       14
       14
       -
         the rescue shell.

     

       15
       15
       -
        </para>

     

       16
       16
       -
       </section>

+21

nixos/doc/manual/administration/network-problems.section.md

···

       1
       1
       +
       # Network Problems {#sec-nix-network-issues}

     

       2
       2
       +
       

     

       3
       3
       +
       Nix uses a so-called *binary cache* to optimise building a package from

     

       4
       4
       +
       source into downloading it as a pre-built binary. That is, whenever a

     

       5
       5
       +
       command like `nixos-rebuild` needs a path in the Nix store, Nix will try

     

       6
       6
       +
       to download that path from the Internet rather than build it from

     

       7
       7
       +
       source. The default binary cache is `https://cache.nixos.org/`. If this

     

       8
       8
       +
       cache is unreachable, Nix operations may take a long time due to HTTP

     

       9
       9
       +
       connection timeouts. You can disable the use of the binary cache by

     

       10
       10
       +
       adding `--option use-binary-caches false`, e.g.

     

       11
       11
       +
       

     

       12
       12
       +
       ```ShellSession

     

       13
       13
       +
       # nixos-rebuild switch --option use-binary-caches false

     

       14
       14
       +
       ```

     

       15
       15
       +
       

     

       16
       16
       +
       If you have an alternative binary cache at your disposal, you can use it

     

       17
       17
       +
       instead:

     

       18
       18
       +
       

     

       19
       19
       +
       ```ShellSession

     

       20
       20
       +
       # nixos-rebuild switch --option binary-caches http://my-cache.example.org/

     

       21
       21
       +
       ```

-27

nixos/doc/manual/administration/network-problems.xml

···

       1
       1
       -
       <section xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
               xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
               xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
               version="5.0"

     

       5
       5
       -
               xml:id="sec-nix-network-issues">

     

       6
       6
       -
        <title>Network Problems</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         Nix uses a so-called <emphasis>binary cache</emphasis> to optimise building a

     

       10
       10
       -
         package from source into downloading it as a pre-built binary. That is,

     

       11
       11
       -
         whenever a command like <command>nixos-rebuild</command> needs a path in the

     

       12
       12
       -
         Nix store, Nix will try to download that path from the Internet rather than

     

       13
       13
       -
         build it from source. The default binary cache is

     

       14
       14
       -
         <uri>https://cache.nixos.org/</uri>. If this cache is unreachable, Nix

     

       15
       15
       -
         operations may take a long time due to HTTP connection timeouts. You can

     

       16
       16
       -
         disable the use of the binary cache by adding <option>--option

     

       17
       17
       -
         use-binary-caches false</option>, e.g.

     

       18
       18
       -
       <screen>

     

       19
       19
       -
       <prompt># </prompt>nixos-rebuild switch --option use-binary-caches false

     

       20
       20
       -
       </screen>

     

       21
       21
       -
         If you have an alternative binary cache at your disposal, you can use it

     

       22
       22
       -
         instead:

     

       23
       23
       -
       <screen>

     

       24
       24
       -
       <prompt># </prompt>nixos-rebuild switch --option binary-caches <replaceable>http://my-cache.example.org/</replaceable>

     

       25
       25
       -
       </screen>

     

       26
       26
       -
        </para>

     

       27
       27
       -
       </section>

+38

nixos/doc/manual/administration/rollback.section.md

···

       1
       1
       +
       # Rolling Back Configuration Changes {#sec-rollback}

     

       2
       2
       +
       

     

       3
       3
       +
       After running `nixos-rebuild` to switch to a new configuration, you may

     

       4
       4
       +
       find that the new configuration doesn't work very well. In that case,

     

       5
       5
       +
       there are several ways to return to a previous configuration.

     

       6
       6
       +
       

     

       7
       7
       +
       First, the GRUB boot manager allows you to boot into any previous

     

       8
       8
       +
       configuration that hasn't been garbage-collected. These configurations

     

       9
       9
       +
       can be found under the GRUB submenu "NixOS - All configurations". This

     

       10
       10
       +
       is especially useful if the new configuration fails to boot. After the

     

       11
       11
       +
       system has booted, you can make the selected configuration the default

     

       12
       12
       +
       for subsequent boots:

     

       13
       13
       +
       

     

       14
       14
       +
       ```ShellSession

     

       15
       15
       +
       # /run/current-system/bin/switch-to-configuration boot

     

       16
       16
       +
       ```

     

       17
       17
       +
       

     

       18
       18
       +
       Second, you can switch to the previous configuration in a running

     

       19
       19
       +
       system:

     

       20
       20
       +
       

     

       21
       21
       +
       ```ShellSession

     

       22
       22
       +
       # nixos-rebuild switch --rollback

     

       23
       23
       +
       ```

     

       24
       24
       +
       

     

       25
       25
       +
       This is equivalent to running:

     

       26
       26
       +
       

     

       27
       27
       +
       ```ShellSession

     

       28
       28
       +
       # /nix/var/nix/profiles/system-N-link/bin/switch-to-configuration switch

     

       29
       29
       +
       ```

     

       30
       30
       +
       

     

       31
       31
       +
       where `N` is the number of the NixOS system configuration. To get a

     

       32
       32
       +
       list of the available configurations, do:

     

       33
       33
       +
       

     

       34
       34
       +
       ```ShellSession

     

       35
       35
       +
       $ ls -l /nix/var/nix/profiles/system-*-link

     

       36
       36
       +
       ...

     

       37
       37
       +
       lrwxrwxrwx 1 root root 78 Aug 12 13:54 /nix/var/nix/profiles/system-268-link -> /nix/store/202b...-nixos-13.07pre4932_5a676e4-4be1055

     

       38
       38
       +
       ```

-41

nixos/doc/manual/administration/rollback.xml

···

       1
       1
       -
       <section xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
               xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
               xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
               version="5.0"

     

       5
       5
       -
               xml:id="sec-rollback">

     

       6
       6
       -
        <title>Rolling Back Configuration Changes</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         After running <command>nixos-rebuild</command> to switch to a new

     

       10
       10
       -
         configuration, you may find that the new configuration doesn’t work very

     

       11
       11
       -
         well. In that case, there are several ways to return to a previous

     

       12
       12
       -
         configuration.

     

       13
       13
       -
        </para>

     

       14
       14
       -
       

     

       15
       15
       -
        <para>

     

       16
       16
       -
         First, the GRUB boot manager allows you to boot into any previous

     

       17
       17
       -
         configuration that hasn’t been garbage-collected. These configurations can

     

       18
       18
       -
         be found under the GRUB submenu “NixOS - All configurations”. This is

     

       19
       19
       -
         especially useful if the new configuration fails to boot. After the system

     

       20
       20
       -
         has booted, you can make the selected configuration the default for

     

       21
       21
       -
         subsequent boots:

     

       22
       22
       -
       <screen>

     

       23
       23
       -
       <prompt># </prompt>/run/current-system/bin/switch-to-configuration boot</screen>

     

       24
       24
       -
        </para>

     

       25
       25
       -
       

     

       26
       26
       -
        <para>

     

       27
       27
       -
         Second, you can switch to the previous configuration in a running system:

     

       28
       28
       -
       <screen>

     

       29
       29
       -
       <prompt># </prompt>nixos-rebuild switch --rollback</screen>

     

       30
       30
       -
         This is equivalent to running:

     

       31
       31
       -
       <screen>

     

       32
       32
       -
       <prompt># </prompt>/nix/var/nix/profiles/system-<replaceable>N</replaceable>-link/bin/switch-to-configuration switch</screen>

     

       33
       33
       -
         where <replaceable>N</replaceable> is the number of the NixOS system

     

       34
       34
       -
         configuration. To get a list of the available configurations, do:

     

       35
       35
       -
       <screen>

     

       36
       36
       -
       <prompt>$ </prompt>ls -l /nix/var/nix/profiles/system-*-link

     

       37
       37
       -
       <replaceable>...</replaceable>

     

       38
       38
       -
       lrwxrwxrwx 1 root root 78 Aug 12 13:54 /nix/var/nix/profiles/system-268-link -> /nix/store/202b...-nixos-13.07pre4932_5a676e4-4be1055

     

       39
       39
       -
       </screen>

     

       40
       40
       -
        </para>

     

       41
       41
       -
       </section>

+28

nixos/doc/manual/administration/store-corruption.section.md

···

       1
       1
       +
       # Nix Store Corruption {#sec-nix-store-corruption}

     

       2
       2
       +
       

     

       3
       3
       +
       After a system crash, it's possible for files in the Nix store to become

     

       4
       4
       +
       corrupted. (For instance, the Ext4 file system has the tendency to

     

       5
       5
       +
       replace un-synced files with zero bytes.) NixOS tries hard to prevent

     

       6
       6
       +
       this from happening: it performs a `sync` before switching to a new

     

       7
       7
       +
       configuration, and Nix's database is fully transactional. If corruption

     

       8
       8
       +
       still occurs, you may be able to fix it automatically.

     

       9
       9
       +
       

     

       10
       10
       +
       If the corruption is in a path in the closure of the NixOS system

     

       11
       11
       +
       configuration, you can fix it by doing

     

       12
       12
       +
       

     

       13
       13
       +
       ```ShellSession

     

       14
       14
       +
       # nixos-rebuild switch --repair

     

       15
       15
       +
       ```

     

       16
       16
       +
       

     

       17
       17
       +
       This will cause Nix to check every path in the closure, and if its

     

       18
       18
       +
       cryptographic hash differs from the hash recorded in Nix's database, the

     

       19
       19
       +
       path is rebuilt or redownloaded.

     

       20
       20
       +
       

     

       21
       21
       +
       You can also scan the entire Nix store for corrupt paths:

     

       22
       22
       +
       

     

       23
       23
       +
       ```ShellSession

     

       24
       24
       +
       # nix-store --verify --check-contents --repair

     

       25
       25
       +
       ```

     

       26
       26
       +
       

     

       27
       27
       +
       Any corrupt paths will be redownloaded if they're available in a binary

     

       28
       28
       +
       cache; otherwise, they cannot be repaired.

-36

nixos/doc/manual/administration/store-corruption.xml

···

       1
       1
       -
       <section xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
               xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
               xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
               version="5.0"

     

       5
       5
       -
               xml:id="sec-nix-store-corruption">

     

       6
       6
       -
        <title>Nix Store Corruption</title>

     

       7
       7
       -
       

     

       8
       8
       -
        <para>

     

       9
       9
       -
         After a system crash, it’s possible for files in the Nix store to become

     

       10
       10
       -
         corrupted. (For instance, the Ext4 file system has the tendency to replace

     

       11
       11
       -
         un-synced files with zero bytes.) NixOS tries hard to prevent this from

     

       12
       12
       -
         happening: it performs a <command>sync</command> before switching to a new

     

       13
       13
       -
         configuration, and Nix’s database is fully transactional. If corruption

     

       14
       14
       -
         still occurs, you may be able to fix it automatically.

     

       15
       15
       -
        </para>

     

       16
       16
       -
       

     

       17
       17
       -
        <para>

     

       18
       18
       -
         If the corruption is in a path in the closure of the NixOS system

     

       19
       19
       -
         configuration, you can fix it by doing

     

       20
       20
       -
       <screen>

     

       21
       21
       -
       <prompt># </prompt>nixos-rebuild switch --repair

     

       22
       22
       -
       </screen>

     

       23
       23
       -
         This will cause Nix to check every path in the closure, and if its

     

       24
       24
       -
         cryptographic hash differs from the hash recorded in Nix’s database, the

     

       25
       25
       -
         path is rebuilt or redownloaded.

     

       26
       26
       -
        </para>

     

       27
       27
       -
       

     

       28
       28
       -
        <para>

     

       29
       29
       -
         You can also scan the entire Nix store for corrupt paths:

     

       30
       30
       -
       <screen>

     

       31
       31
       -
       <prompt># </prompt>nix-store --verify --check-contents --repair

     

       32
       32
       -
       </screen>

     

       33
       33
       -
         Any corrupt paths will be redownloaded if they’re available in a binary

     

       34
       34
       -
         cache; otherwise, they cannot be repaired.

     

       35
       35
       -
        </para>

     

       36
       36
       -
       </section>

+4 -4

nixos/doc/manual/administration/troubleshooting.xml

···

       9
       9
        
         you manage your NixOS system.

     

       10
       10
        
        </para>

     

       11
       11
        
        <xi:include href="../from_md/administration/boot-problems.section.xml" />

     

       12
       12
       -
        <xi:include href="maintenance-mode.xml" />

     

       13
       13
       -
        <xi:include href="rollback.xml" />

     

       14
       14
       -
        <xi:include href="store-corruption.xml" />

     

       15
       15
       -
        <xi:include href="network-problems.xml" />

     

       12
       12
       +
        <xi:include href="../from_md/administration/maintenance-mode.section.xml" />

     

       13
       13
       +
        <xi:include href="../from_md/administration/rollback.section.xml" />

     

       14
       14
       +
        <xi:include href="../from_md/administration/store-corruption.section.xml" />

     

       15
       15
       +
        <xi:include href="../from_md/administration/network-problems.section.xml" />

     

       16
       16
        
       </chapter>

+14

nixos/doc/manual/from_md/administration/maintenance-mode.section.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-maintenance-mode">

     

       2
       2
       +
         <title>Maintenance Mode</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           You can enter rescue mode by running:

     

       5
       5
       +
         </para>

     

       6
       6
       +
         <programlisting>

     

       7
       7
       +
       # systemctl rescue

     

       8
       8
       +
       </programlisting>

     

       9
       9
       +
         <para>

     

       10
       10
       +
           This will eventually give you a single-user root shell. Systemd will

     

       11
       11
       +
           stop (almost) all system services. To get out of maintenance mode,

     

       12
       12
       +
           just exit from the rescue shell.

     

       13
       13
       +
         </para>

     

       14
       14
       +
       </section>

+25

nixos/doc/manual/from_md/administration/network-problems.section.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-nix-network-issues">

     

       2
       2
       +
         <title>Network Problems</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           Nix uses a so-called <emphasis>binary cache</emphasis> to optimise

     

       5
       5
       +
           building a package from source into downloading it as a pre-built

     

       6
       6
       +
           binary. That is, whenever a command like

     

       7
       7
       +
           <literal>nixos-rebuild</literal> needs a path in the Nix store, Nix

     

       8
       8
       +
           will try to download that path from the Internet rather than build

     

       9
       9
       +
           it from source. The default binary cache is

     

       10
       10
       +
           <literal>https://cache.nixos.org/</literal>. If this cache is

     

       11
       11
       +
           unreachable, Nix operations may take a long time due to HTTP

     

       12
       12
       +
           connection timeouts. You can disable the use of the binary cache by

     

       13
       13
       +
           adding <literal>--option use-binary-caches false</literal>, e.g.

     

       14
       14
       +
         </para>

     

       15
       15
       +
         <programlisting>

     

       16
       16
       +
       # nixos-rebuild switch --option use-binary-caches false

     

       17
       17
       +
       </programlisting>

     

       18
       18
       +
         <para>

     

       19
       19
       +
           If you have an alternative binary cache at your disposal, you can

     

       20
       20
       +
           use it instead:

     

       21
       21
       +
         </para>

     

       22
       22
       +
         <programlisting>

     

       23
       23
       +
       # nixos-rebuild switch --option binary-caches http://my-cache.example.org/

     

       24
       24
       +
       </programlisting>

     

       25
       25
       +
       </section>

+42

nixos/doc/manual/from_md/administration/rollback.section.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-rollback">

     

       2
       2
       +
         <title>Rolling Back Configuration Changes</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           After running <literal>nixos-rebuild</literal> to switch to a new

     

       5
       5
       +
           configuration, you may find that the new configuration doesn’t work

     

       6
       6
       +
           very well. In that case, there are several ways to return to a

     

       7
       7
       +
           previous configuration.

     

       8
       8
       +
         </para>

     

       9
       9
       +
         <para>

     

       10
       10
       +
           First, the GRUB boot manager allows you to boot into any previous

     

       11
       11
       +
           configuration that hasn’t been garbage-collected. These

     

       12
       12
       +
           configurations can be found under the GRUB submenu <quote>NixOS -

     

       13
       13
       +
           All configurations</quote>. This is especially useful if the new

     

       14
       14
       +
           configuration fails to boot. After the system has booted, you can

     

       15
       15
       +
           make the selected configuration the default for subsequent boots:

     

       16
       16
       +
         </para>

     

       17
       17
       +
         <programlisting>

     

       18
       18
       +
       # /run/current-system/bin/switch-to-configuration boot

     

       19
       19
       +
       </programlisting>

     

       20
       20
       +
         <para>

     

       21
       21
       +
           Second, you can switch to the previous configuration in a running

     

       22
       22
       +
           system:

     

       23
       23
       +
         </para>

     

       24
       24
       +
         <programlisting>

     

       25
       25
       +
       # nixos-rebuild switch --rollback

     

       26
       26
       +
       </programlisting>

     

       27
       27
       +
         <para>

     

       28
       28
       +
           This is equivalent to running:

     

       29
       29
       +
         </para>

     

       30
       30
       +
         <programlisting>

     

       31
       31
       +
       # /nix/var/nix/profiles/system-N-link/bin/switch-to-configuration switch

     

       32
       32
       +
       </programlisting>

     

       33
       33
       +
         <para>

     

       34
       34
       +
           where <literal>N</literal> is the number of the NixOS system

     

       35
       35
       +
           configuration. To get a list of the available configurations, do:

     

       36
       36
       +
         </para>

     

       37
       37
       +
         <programlisting>

     

       38
       38
       +
       $ ls -l /nix/var/nix/profiles/system-*-link

     

       39
       39
       +
       ...

     

       40
       40
       +
       lrwxrwxrwx 1 root root 78 Aug 12 13:54 /nix/var/nix/profiles/system-268-link -&gt; /nix/store/202b...-nixos-13.07pre4932_5a676e4-4be1055

     

       41
       41
       +
       </programlisting>

     

       42
       42
       +
       </section>

+34

nixos/doc/manual/from_md/administration/store-corruption.section.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-nix-store-corruption">

     

       2
       2
       +
         <title>Nix Store Corruption</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           After a system crash, it’s possible for files in the Nix store to

     

       5
       5
       +
           become corrupted. (For instance, the Ext4 file system has the

     

       6
       6
       +
           tendency to replace un-synced files with zero bytes.) NixOS tries

     

       7
       7
       +
           hard to prevent this from happening: it performs a

     

       8
       8
       +
           <literal>sync</literal> before switching to a new configuration, and

     

       9
       9
       +
           Nix’s database is fully transactional. If corruption still occurs,

     

       10
       10
       +
           you may be able to fix it automatically.

     

       11
       11
       +
         </para>

     

       12
       12
       +
         <para>

     

       13
       13
       +
           If the corruption is in a path in the closure of the NixOS system

     

       14
       14
       +
           configuration, you can fix it by doing

     

       15
       15
       +
         </para>

     

       16
       16
       +
         <programlisting>

     

       17
       17
       +
       # nixos-rebuild switch --repair

     

       18
       18
       +
       </programlisting>

     

       19
       19
       +
         <para>

     

       20
       20
       +
           This will cause Nix to check every path in the closure, and if its

     

       21
       21
       +
           cryptographic hash differs from the hash recorded in Nix’s database,

     

       22
       22
       +
           the path is rebuilt or redownloaded.

     

       23
       23
       +
         </para>

     

       24
       24
       +
         <para>

     

       25
       25
       +
           You can also scan the entire Nix store for corrupt paths:

     

       26
       26
       +
         </para>

     

       27
       27
       +
         <programlisting>

     

       28
       28
       +
       # nix-store --verify --check-contents --repair

     

       29
       29
       +
       </programlisting>

     

       30
       30
       +
         <para>

     

       31
       31
       +
           Any corrupt paths will be redownloaded if they’re available in a

     

       32
       32
       +
           binary cache; otherwise, they cannot be repaired.

     

       33
       33
       +
         </para>

     

       34
       34
       +
       </section>