commit c603692b0cfb096e9f8b861b7ce39978779a200a · pyrox.dev/nixpkgs

+62

nixos/doc/manual/administration/cleaning-store.chapter.md

···

       1
       1
       +
       # Cleaning the Nix Store {#sec-nix-gc}

     

       2
       2
       +
       

     

       3
       3
       +
       Nix has a purely functional model, meaning that packages are never

     

       4
       4
       +
       upgraded in place. Instead new versions of packages end up in a

     

       5
       5
       +
       different location in the Nix store (`/nix/store`). You should

     

       6
       6
       +
       periodically run Nix's *garbage collector* to remove old, unreferenced

     

       7
       7
       +
       packages. This is easy:

     

       8
       8
       +
       

     

       9
       9
       +
       ```ShellSession

     

       10
       10
       +
       $ nix-collect-garbage

     

       11
       11
       +
       ```

     

       12
       12
       +
       

     

       13
       13
       +
       Alternatively, you can use a systemd unit that does the same in the

     

       14
       14
       +
       background:

     

       15
       15
       +
       

     

       16
       16
       +
       ```ShellSession

     

       17
       17
       +
       # systemctl start nix-gc.service

     

       18
       18
       +
       ```

     

       19
       19
       +
       

     

       20
       20
       +
       You can tell NixOS in `configuration.nix` to run this unit automatically

     

       21
       21
       +
       at certain points in time, for instance, every night at 03:15:

     

       22
       22
       +
       

     

       23
       23
       +
       ```nix

     

       24
       24
       +
       nix.gc.automatic = true;

     

       25
       25
       +
       nix.gc.dates = "03:15";

     

       26
       26
       +
       ```

     

       27
       27
       +
       

     

       28
       28
       +
       The commands above do not remove garbage collector roots, such as old

     

       29
       29
       +
       system configurations. Thus they do not remove the ability to roll back

     

       30
       30
       +
       to previous configurations. The following command deletes old roots,

     

       31
       31
       +
       removing the ability to roll back to them:

     

       32
       32
       +
       

     

       33
       33
       +
       ```ShellSession

     

       34
       34
       +
       $ nix-collect-garbage -d

     

       35
       35
       +
       ```

     

       36
       36
       +
       

     

       37
       37
       +
       You can also do this for specific profiles, e.g.

     

       38
       38
       +
       

     

       39
       39
       +
       ```ShellSession

     

       40
       40
       +
       $ nix-env -p /nix/var/nix/profiles/per-user/eelco/profile --delete-generations old

     

       41
       41
       +
       ```

     

       42
       42
       +
       

     

       43
       43
       +
       Note that NixOS system configurations are stored in the profile

     

       44
       44
       +
       `/nix/var/nix/profiles/system`.

     

       45
       45
       +
       

     

       46
       46
       +
       Another way to reclaim disk space (often as much as 40% of the size of

     

       47
       47
       +
       the Nix store) is to run Nix's store optimiser, which seeks out

     

       48
       48
       +
       identical files in the store and replaces them with hard links to a

     

       49
       49
       +
       single copy.

     

       50
       50
       +
       

     

       51
       51
       +
       ```ShellSession

     

       52
       52
       +
       $ nix-store --optimise

     

       53
       53
       +
       ```

     

       54
       54
       +
       

     

       55
       55
       +
       Since this command needs to read the entire Nix store, it can take quite

     

       56
       56
       +
       a while to finish.

     

       57
       57
       +
       

     

       58
       58
       +
       ## NixOS Boot Entries {#sect-nixos-gc-boot-entries}

     

       59
       59
       +
       

     

       60
       60
       +
       If your `/boot` partition runs out of space, after clearing old profiles

     

       61
       61
       +
       you must rebuild your system with `nixos-rebuild` to update the `/boot`

     

       62
       62
       +
       partition and clear space.

-63

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

···

       1
       1
       -
       <chapter 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-gc">

     

       6
       6
       -
        <title>Cleaning the Nix Store</title>

     

       7
       7
       -
        <para>

     

       8
       8
       -
         Nix has a purely functional model, meaning that packages are never upgraded

     

       9
       9
       -
         in place. Instead new versions of packages end up in a different location in

     

       10
       10
       -
         the Nix store (<filename>/nix/store</filename>). You should periodically run

     

       11
       11
       -
         Nix’s <emphasis>garbage collector</emphasis> to remove old, unreferenced

     

       12
       12
       -
         packages. This is easy:

     

       13
       13
       -
       <screen>

     

       14
       14
       -
       <prompt>$ </prompt>nix-collect-garbage

     

       15
       15
       -
       </screen>

     

       16
       16
       -
         Alternatively, you can use a systemd unit that does the same in the

     

       17
       17
       -
         background:

     

       18
       18
       -
       <screen>

     

       19
       19
       -
       <prompt># </prompt>systemctl start nix-gc.service

     

       20
       20
       -
       </screen>

     

       21
       21
       -
         You can tell NixOS in <filename>configuration.nix</filename> to run this unit

     

       22
       22
       -
         automatically at certain points in time, for instance, every night at 03:15:

     

       23
       23
       -
       <programlisting>

     

       24
       24
       -
       <xref linkend="opt-nix.gc.automatic"/> = true;

     

       25
       25
       -
       <xref linkend="opt-nix.gc.dates"/> = "03:15";

     

       26
       26
       -
       </programlisting>

     

       27
       27
       -
        </para>

     

       28
       28
       -
        <para>

     

       29
       29
       -
         The commands above do not remove garbage collector roots, such as old system

     

       30
       30
       -
         configurations. Thus they do not remove the ability to roll back to previous

     

       31
       31
       -
         configurations. The following command deletes old roots, removing the ability

     

       32
       32
       -
         to roll back to them:

     

       33
       33
       -
       <screen>

     

       34
       34
       -
       <prompt>$ </prompt>nix-collect-garbage -d

     

       35
       35
       -
       </screen>

     

       36
       36
       -
         You can also do this for specific profiles, e.g.

     

       37
       37
       -
       <screen>

     

       38
       38
       -
       <prompt>$ </prompt>nix-env -p /nix/var/nix/profiles/per-user/eelco/profile --delete-generations old

     

       39
       39
       -
       </screen>

     

       40
       40
       -
         Note that NixOS system configurations are stored in the profile

     

       41
       41
       -
         <filename>/nix/var/nix/profiles/system</filename>.

     

       42
       42
       -
        </para>

     

       43
       43
       -
        <para>

     

       44
       44
       -
         Another way to reclaim disk space (often as much as 40% of the size of the

     

       45
       45
       -
         Nix store) is to run Nix’s store optimiser, which seeks out identical files

     

       46
       46
       -
         in the store and replaces them with hard links to a single copy.

     

       47
       47
       -
       <screen>

     

       48
       48
       -
       <prompt>$ </prompt>nix-store --optimise

     

       49
       49
       -
       </screen>

     

       50
       50
       -
         Since this command needs to read the entire Nix store, it can take quite a

     

       51
       51
       -
         while to finish.

     

       52
       52
       -
        </para>

     

       53
       53
       -
        <section xml:id="sect-nixos-gc-boot-entries">

     

       54
       54
       -
         <title>NixOS Boot Entries</title>

     

       55
       55
       -
       

     

       56
       56
       -
         <para>

     

       57
       57
       -
          If your <filename>/boot</filename> partition runs out of space, after

     

       58
       58
       -
          clearing old profiles you must rebuild your system with

     

       59
       59
       -
          <literal>nixos-rebuild</literal> to update the <filename>/boot</filename>

     

       60
       60
       -
          partition and clear space.

     

       61
       61
       -
         </para>

     

       62
       62
       -
        </section>

     

       63
       63
       -
       </chapter>

+1 -1

nixos/doc/manual/administration/running.xml

···

       15
       15
        
        <xi:include href="../from_md/administration/user-sessions.chapter.xml" />

     

       16
       16
        
        <xi:include href="../from_md/administration/control-groups.chapter.xml" />

     

       17
       17
        
        <xi:include href="../from_md/administration/logging.chapter.xml" />

     

       18
       18
       -
        <xi:include href="cleaning-store.xml" />

     

       18
       18
       +
        <xi:include href="../from_md/administration/cleaning-store.chapter.xml" />

     

       19
       19
        
        <xi:include href="containers.xml" />

     

       20
       20
        
        <xi:include href="troubleshooting.xml" />

     

       21
       21
        
       </part>

+71

nixos/doc/manual/from_md/administration/cleaning-store.chapter.xml

···

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

     

       2
       2
       +
         <title>Cleaning the Nix Store</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           Nix has a purely functional model, meaning that packages are never

     

       5
       5
       +
           upgraded in place. Instead new versions of packages end up in a

     

       6
       6
       +
           different location in the Nix store (<literal>/nix/store</literal>).

     

       7
       7
       +
           You should periodically run Nix’s <emphasis>garbage

     

       8
       8
       +
           collector</emphasis> to remove old, unreferenced packages. This is

     

       9
       9
       +
           easy:

     

       10
       10
       +
         </para>

     

       11
       11
       +
         <programlisting>

     

       12
       12
       +
       $ nix-collect-garbage

     

       13
       13
       +
       </programlisting>

     

       14
       14
       +
         <para>

     

       15
       15
       +
           Alternatively, you can use a systemd unit that does the same in the

     

       16
       16
       +
           background:

     

       17
       17
       +
         </para>

     

       18
       18
       +
         <programlisting>

     

       19
       19
       +
       # systemctl start nix-gc.service

     

       20
       20
       +
       </programlisting>

     

       21
       21
       +
         <para>

     

       22
       22
       +
           You can tell NixOS in <literal>configuration.nix</literal> to run

     

       23
       23
       +
           this unit automatically at certain points in time, for instance,

     

       24
       24
       +
           every night at 03:15:

     

       25
       25
       +
         </para>

     

       26
       26
       +
         <programlisting language="bash">

     

       27
       27
       +
       nix.gc.automatic = true;

     

       28
       28
       +
       nix.gc.dates = &quot;03:15&quot;;

     

       29
       29
       +
       </programlisting>

     

       30
       30
       +
         <para>

     

       31
       31
       +
           The commands above do not remove garbage collector roots, such as

     

       32
       32
       +
           old system configurations. Thus they do not remove the ability to

     

       33
       33
       +
           roll back to previous configurations. The following command deletes

     

       34
       34
       +
           old roots, removing the ability to roll back to them:

     

       35
       35
       +
         </para>

     

       36
       36
       +
         <programlisting>

     

       37
       37
       +
       $ nix-collect-garbage -d

     

       38
       38
       +
       </programlisting>

     

       39
       39
       +
         <para>

     

       40
       40
       +
           You can also do this for specific profiles, e.g.

     

       41
       41
       +
         </para>

     

       42
       42
       +
         <programlisting>

     

       43
       43
       +
       $ nix-env -p /nix/var/nix/profiles/per-user/eelco/profile --delete-generations old

     

       44
       44
       +
       </programlisting>

     

       45
       45
       +
         <para>

     

       46
       46
       +
           Note that NixOS system configurations are stored in the profile

     

       47
       47
       +
           <literal>/nix/var/nix/profiles/system</literal>.

     

       48
       48
       +
         </para>

     

       49
       49
       +
         <para>

     

       50
       50
       +
           Another way to reclaim disk space (often as much as 40% of the size

     

       51
       51
       +
           of the Nix store) is to run Nix’s store optimiser, which seeks out

     

       52
       52
       +
           identical files in the store and replaces them with hard links to a

     

       53
       53
       +
           single copy.

     

       54
       54
       +
         </para>

     

       55
       55
       +
         <programlisting>

     

       56
       56
       +
       $ nix-store --optimise

     

       57
       57
       +
       </programlisting>

     

       58
       58
       +
         <para>

     

       59
       59
       +
           Since this command needs to read the entire Nix store, it can take

     

       60
       60
       +
           quite a while to finish.

     

       61
       61
       +
         </para>

     

       62
       62
       +
         <section xml:id="sect-nixos-gc-boot-entries">

     

       63
       63
       +
           <title>NixOS Boot Entries</title>

     

       64
       64
       +
           <para>

     

       65
       65
       +
             If your <literal>/boot</literal> partition runs out of space,

     

       66
       66
       +
             after clearing old profiles you must rebuild your system with

     

       67
       67
       +
             <literal>nixos-rebuild</literal> to update the

     

       68
       68
       +
             <literal>/boot</literal> partition and clear space.

     

       69
       69
       +
           </para>

     

       70
       70
       +
         </section>

     

       71
       71
       +
       </chapter>