deploy: 3aca18a

Author: mergify[bot]

.attr-0l2nkwhif96f51f4amnlf414lhl4rv9vh8iffyp431v6s28gsr90

@@ -1,2 +1,2 @@
-cp -r /nix/store/jqhmj92wimia35fw1rnp3kkbv5qrymyx-source/* .
+cp -r /nix/store/0gk4l64rg6l2w5fqqhp5b2wgxbgn7lp3-source/* .
 /nix/store/kf6w5gcp13nl0k6q7ymp0p5mycmxpk1i-mdbook-0.4.40/bin/mdbook build --dest-dir "$out"

env-vars

@@ -3,10 +3,10 @@ declare -x HOME="/homeless-shelter"
 declare -x HOST_PATH="/nix/store/0kg70swgpg45ipcz3pr2siidq9fn6d77-coreutils-9.5/bin:/nix/store/fnq94lw19pnwdl9p8zhfrad4jmlgxlbr-findutils-4.10.0/bin:/nix/store/7jk4jrd99ngnm9iczcf63mfxqba0ak2y-diffutils-3.10/bin:/nix/store/gjlh1zvckhz0qv795lnzgw2zciklbzj2-gnused-4.9/bin:/nix/store/vsyc8jhsr4d9lm2r8yqq9n3j4i66inlj-gnugrep-3.11/bin:/nix/store/9hifsxkcrkvvb712ghnr3gy5g1aiym2d-gawk-5.2.2/bin:/nix/store/l2l5xr2zczq19gqpqz4j8vxxia1j41s1-gnutar-1.35/bin:/nix/store/164s7a7yscnicprzrr78bvk45d77a3yg-gzip-1.13/bin:/nix/store/f8p74dj4r4my8sw5prmm3y4ddkz7591j-bzip2-1.0.8-bin/bin:/nix/store/axrdky652lsmif6m5i8b55q91v4ly4gy-gnumake-4.4.1/bin:/nix/store/izpf49b74i15pcr9708s3xdwyqs4jxwl-bash-5.2p32/bin:/nix/store/7wg4bz2sika3wd7541rndbnwcq6k9h8v-patch-2.7.6/bin:/nix/store/02mf752h7f5fn7989awzca4ygy94k7w7-xz-5.6.2-bin/bin:/nix/store/fv56zpi80jpakbfmv16r60xvyqwzff6r-file-5.45/bin"
 declare -x NIX_BUILD_CORES="4"
 declare -x NIX_BUILD_TOP="/build"
-declare -x NIX_CFLAGS_COMPILE=" -frandom-seed=2d9rrhrkac"
+declare -x NIX_CFLAGS_COMPILE=" -frandom-seed=gragpkx7yq"
 declare -x NIX_ENFORCE_NO_NATIVE="1"
 declare -x NIX_ENFORCE_PURITY="1"
-declare -x NIX_LDFLAGS="-rpath /nix/store/2d9rrhrkac773py3m1wzlwzj0s7sbzi4-nixos-anywhere-docs/lib "
+declare -x NIX_LDFLAGS="-rpath /nix/store/gragpkx7yq88pzzdndyp7vpv0myijyfi-nixos-anywhere-docs/lib "
 declare -x NIX_LOG_FD="2"
 declare -x NIX_SSL_CERT_FILE="/no-cert-file.crt"
 declare -x NIX_STORE="/nix/store"
@@ -46,7 +46,7 @@ declare -x enableParallelInstalling="1"
 declare -x mesonFlags=""
 declare -x name="nixos-anywhere-docs"
 declare -x nativeBuildInputs=""
-declare -x out="/nix/store/2d9rrhrkac773py3m1wzlwzj0s7sbzi4-nixos-anywhere-docs"
+declare -x out="/nix/store/gragpkx7yq88pzzdndyp7vpv0myijyfi-nixos-anywhere-docs"
 declare -x outputs="out"
 declare -x passAsFile="buildCommand"
 declare -x patches=""

print.html

@@ -264,26 +264,9 @@ <h3 id="2-initialize-a-flake"><a class="header" href="#2-initialize-a-flake">2.
 into a new directory. This example is tailored for a virtual machine setup
 similar to one on <a href="https://www.hetzner.com/cloud">Hetzner Cloud</a>, so you might
 need to adapt it for your setup.</p>
-<p><strong>Hardware-Specific Configuration</strong>: If you're not using a virtual machine,
-you'll need to generate a custom hardware configuration with
-<code>nixos-generate-config</code>.</p>
 <p>If you already have a flake, you can use it by adding
 <a href="https://github.com/nix-community/disko?tab=readme-ov-file#how-to-use-disko">disko configuration</a>
 to it.</p>
-<h4 id="get-nixos-generate-config-onto-the-target-machine"><a class="header" href="#get-nixos-generate-config-onto-the-target-machine">Get <code>nixos-generate-config</code> onto the Target Machine</a></h4>
-<ol>
-<li><strong>Option 1</strong>: If NixOS is not installed, boot into an installer without first
-installing NixOS.</li>
-<li><strong>Option 2</strong>: Use the kexec tarball method, as described
-<a href="https://github.com/nix-community/nixos-images#kexec-tarballs">here</a>.</li>
-</ol>
-<h4 id="generate-configuration"><a class="header" href="#generate-configuration">Generate Configuration</a></h4>
-<p>Run the following command on the target machine:</p>
-<pre><code class="language-bash">nixos-generate-config --no-filesystems --dir /mnt/etc/nixos
-</code></pre>
-<p>This creates the necessary configuration files under <code>/mnt/etc/nixos/</code>, which
-you can then customize as needed and copy them to your local machine in order to
-include them in your flake.</p>
 <h3 id="3-configure-your-ssh-key"><a class="header" href="#3-configure-your-ssh-key">3. Configure your SSH key</a></h3>
 <p>If you cloned
 <a href="https://github.com/nix-community/nixos-anywhere-examples/blob/main/configuration.nix">our nixos-anywhere-example</a>
@@ -322,6 +305,10 @@ <h3 id="6-connectivity-to-the-target-machine"><a class="header" href="#6-connect
 SSH password prompts, set the <code>SSHPASS</code> environment variable to your password
 and add <code>--env-password</code> to the <code>nixos-anywhere</code> command.</p>
 <h3 id="7-optional-test-your-nixos-and-disko-configuration"><a class="header" href="#7-optional-test-your-nixos-and-disko-configuration">7. (Optional) Test your NixOS and Disko configuration</a></h3>
+<p>Skip this step and continue with Step 8, if you don't have a hardware
+configuration (hardware-configuration.nix or facter.json) generated yet or make
+sure you don't import non-existing hardware-configuration.nix or facter.json
+during running the vm test.</p>
 <p>The following command will automatically test your nixos configuration and run
 disko inside a virtual machine, where</p>
 <ul>
@@ -337,7 +324,58 @@ <h3 id="7-optional-test-your-nixos-and-disko-configuration"><a class="header" hr
 </ul>
 <pre><code>nix run github:nix-community/nixos-anywhere -- --flake &lt;path to configuration&gt;#&lt;configuration name&gt; --vm-test
 </code></pre>
-<h3 id="8-run-it"><a class="header" href="#8-run-it">8. Run it</a></h3>
+<h3 id="8-prepare-hardware-configuration"><a class="header" href="#8-prepare-hardware-configuration">8. Prepare Hardware Configuration</a></h3>
+<p>If you're not using a virtual machine, it's recommended to allow
+<code>nixos-anywhere</code> to generate a hardware configuration during installation. This
+ensures that essential drivers, such as those required for disk detection, are
+properly configured.</p>
+<p>To enable <code>nixos-anywhere</code> to integrate its generated configuration into your
+NixOS setup, you need to include an import for the hardware configuration
+beforehand.</p>
+<p>Here’s an example:</p>
+<pre><code class="language-diff"> nixosConfigurations.generic = nixpkgs.lib.nixosSystem {
+   system = "x86_64-linux";
+   modules = [
+     disko.nixosModules.disko
+     ./configuration.nix
++    ./hardware-configuration.nix
+   ];
+ };
+</code></pre>
+<p>When running <code>nixos-anywhere</code>, this file is automatically generated by including
+the following flags in your command:
+<code>--generate-hardware-config nixos-generate-config ./hardware-configuration.nix</code>.
+The second flag, <code>./hardware-configuration.nix</code>, specifies where
+<code>nixos-generate-config</code> will store the configuration. Adjust this path to
+reflect the location where you want the <code>hardware-configuration.nix</code> for this
+machine to be saved.</p>
+<h4 id="81-nixos-facter"><a class="header" href="#81-nixos-facter">8.1 nixos-facter</a></h4>
+<p>As an alternative to <code>nixos-generate-config</code>, you can use the experimental
+<a href="https://github.com/numtide/nixos-facter">nixos-facter</a> command, which offers
+more comprehensive hardware reports and advanced configuration options.</p>
+<p>To use <code>nixos-facter</code>, add the following to your flake inputs:</p>
+<pre><code class="language-diff"> {
++ inputs.nixos-facter-modules.url = "github:numtide/nixos-facter-modules";
+ }
+</code></pre>
+<p>Next, import the module into your configuration and specify <code>facter.json</code> as the
+path where the hardware report will be saved:</p>
+<pre><code class="language-diff"> nixosConfigurations.generic-nixos-facter = nixpkgs.lib.nixosSystem {
+   system = "x86_64-linux";
+   modules = [
+     disko.nixosModules.disko
+     ./configuration.nix
++    nixos-facter-modules.nixosModules.facter
++    { config.facter.reportPath = ./facter.json }
+   ];
+ };
+</code></pre>
+<p>To generate the configuration for <code>nixos-facter</code> with <code>nixos-anywhere</code>, use the
+following flags: <code>--generate-hardware-config nixos-facter ./facter.json</code>. The
+second flag, <code>./facter.json</code>, specifies where <code>nixos-generate-config</code> will store
+the hardware report. Adjust this path to suit the location where you want the
+<code>facter.json</code> to be saved.</p>
+<h3 id="9-run-it"><a class="header" href="#9-run-it">9. Run it</a></h3>
 <p>You can now run <strong>nixos-anywhere</strong> from the command line as shown below, where:</p>
 <ul>
 <li>
@@ -360,6 +398,15 @@ <h3 id="8-run-it"><a class="header" href="#8-run-it">8. Run it</a></h3>
 <code>37.27.18.135</code>:</p>
 <pre><code>nix run github:nix-community/nixos-anywhere -- --flake /home/mydir/test#hetzner-cloud root@37.27.18.135
 </code></pre>
+<p>If you also need to generate hardware configuration amend flags for
+nixos-generate-config:</p>
+<pre><code>nix run --generate-hardware-config nixos-generate-config ./hardware-configuration.nix github:nix-community/nixos-anywhere -- --flake &lt;path to configuration&gt;#&lt;configuration name&gt; root@&lt;ip address&gt;
+</code></pre>
+<p>Or these flags if you are using nixos-facter instead:</p>
+<pre><code>nix run --generate-hardware-config nixos-facter ./facter.json github:nix-community/nixos-anywhere -- --flake &lt;path to configuration&gt;#&lt;configuration name&gt; root@&lt;ip address&gt;
+</code></pre>
+<p>Adjust the location of <code>./hardware-configuration.nix</code> and <code>./facter.json</code>
+accordingly.</p>
 <p><strong>nixos-anywhere</strong> will then run, showing various output messages at each stage.
 It may take some time to complete, depending on Internet speeds. It should
 finish by showing the messages below before returning to the command prompt.</p>
@@ -775,12 +822,20 @@ <h2 id="command-line-usage"><a class="header" href="#command-line-usage">Command
   build the closure on the remote machine instead of locally and copy-closuring it
 * --vm-test
   build the system and test the disk configuration inside a VM without installing it to the target.
+* --generate-hardware-config nixos-facter|nixos-generate-config &lt;path&gt;
+  generate a hardware-configuration.nix file using the specified backend and write it to the specified path.
+  The backend can be either 'nixos-facter' or 'nixos-generate-config'.
 * --phases
   comma separated list of phases to run. Default is: kexec,disko,install,reboot
   kexec: kexec into the nixos installer
   disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
   install: install the system
   reboot: reboot the machine
+* --disko-mode create|mount|disko
+  set the disko mode to create, mount or destroy. Default is disko.
+  format: create partition tables, zpools, lvms, raids and filesystems (Experimental: Can be run increntally, but use with caution and good backups)
+  mount: mount the partition at the specified root-mountpoint
+  disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
 </code></pre>
 <h2 id="explanation-of-known-error-messages"><a class="header" href="#explanation-of-known-error-messages">Explanation of known error messages</a></h2>
 <p>TODO: Add additional error messages and meanings. Fill in missing explanations</p>

quickstart.html

@@ -209,26 +209,9 @@ <h3 id="2-initialize-a-flake"><a class="header" href="#2-initialize-a-flake">2.
 into a new directory. This example is tailored for a virtual machine setup
 similar to one on <a href="https://www.hetzner.com/cloud">Hetzner Cloud</a>, so you might
 need to adapt it for your setup.</p>
-<p><strong>Hardware-Specific Configuration</strong>: If you're not using a virtual machine,
-you'll need to generate a custom hardware configuration with
-<code>nixos-generate-config</code>.</p>
 <p>If you already have a flake, you can use it by adding
 <a href="https://github.com/nix-community/disko?tab=readme-ov-file#how-to-use-disko">disko configuration</a>
 to it.</p>
-<h4 id="get-nixos-generate-config-onto-the-target-machine"><a class="header" href="#get-nixos-generate-config-onto-the-target-machine">Get <code>nixos-generate-config</code> onto the Target Machine</a></h4>
-<ol>
-<li><strong>Option 1</strong>: If NixOS is not installed, boot into an installer without first
-installing NixOS.</li>
-<li><strong>Option 2</strong>: Use the kexec tarball method, as described
-<a href="https://github.com/nix-community/nixos-images#kexec-tarballs">here</a>.</li>
-</ol>
-<h4 id="generate-configuration"><a class="header" href="#generate-configuration">Generate Configuration</a></h4>
-<p>Run the following command on the target machine:</p>
-<pre><code class="language-bash">nixos-generate-config --no-filesystems --dir /mnt/etc/nixos
-</code></pre>
-<p>This creates the necessary configuration files under <code>/mnt/etc/nixos/</code>, which
-you can then customize as needed and copy them to your local machine in order to
-include them in your flake.</p>
 <h3 id="3-configure-your-ssh-key"><a class="header" href="#3-configure-your-ssh-key">3. Configure your SSH key</a></h3>
 <p>If you cloned
 <a href="https://github.com/nix-community/nixos-anywhere-examples/blob/main/configuration.nix">our nixos-anywhere-example</a>
@@ -267,6 +250,10 @@ <h3 id="6-connectivity-to-the-target-machine"><a class="header" href="#6-connect
 SSH password prompts, set the <code>SSHPASS</code> environment variable to your password
 and add <code>--env-password</code> to the <code>nixos-anywhere</code> command.</p>
 <h3 id="7-optional-test-your-nixos-and-disko-configuration"><a class="header" href="#7-optional-test-your-nixos-and-disko-configuration">7. (Optional) Test your NixOS and Disko configuration</a></h3>
+<p>Skip this step and continue with Step 8, if you don't have a hardware
+configuration (hardware-configuration.nix or facter.json) generated yet or make
+sure you don't import non-existing hardware-configuration.nix or facter.json
+during running the vm test.</p>
 <p>The following command will automatically test your nixos configuration and run
 disko inside a virtual machine, where</p>
 <ul>
@@ -282,7 +269,58 @@ <h3 id="7-optional-test-your-nixos-and-disko-configuration"><a class="header" hr
 </ul>
 <pre><code>nix run github:nix-community/nixos-anywhere -- --flake &lt;path to configuration&gt;#&lt;configuration name&gt; --vm-test
 </code></pre>
-<h3 id="8-run-it"><a class="header" href="#8-run-it">8. Run it</a></h3>
+<h3 id="8-prepare-hardware-configuration"><a class="header" href="#8-prepare-hardware-configuration">8. Prepare Hardware Configuration</a></h3>
+<p>If you're not using a virtual machine, it's recommended to allow
+<code>nixos-anywhere</code> to generate a hardware configuration during installation. This
+ensures that essential drivers, such as those required for disk detection, are
+properly configured.</p>
+<p>To enable <code>nixos-anywhere</code> to integrate its generated configuration into your
+NixOS setup, you need to include an import for the hardware configuration
+beforehand.</p>
+<p>Here’s an example:</p>
+<pre><code class="language-diff"> nixosConfigurations.generic = nixpkgs.lib.nixosSystem {
+   system = "x86_64-linux";
+   modules = [
+     disko.nixosModules.disko
+     ./configuration.nix
++    ./hardware-configuration.nix
+   ];
+ };
+</code></pre>
+<p>When running <code>nixos-anywhere</code>, this file is automatically generated by including
+the following flags in your command:
+<code>--generate-hardware-config nixos-generate-config ./hardware-configuration.nix</code>.
+The second flag, <code>./hardware-configuration.nix</code>, specifies where
+<code>nixos-generate-config</code> will store the configuration. Adjust this path to
+reflect the location where you want the <code>hardware-configuration.nix</code> for this
+machine to be saved.</p>
+<h4 id="81-nixos-facter"><a class="header" href="#81-nixos-facter">8.1 nixos-facter</a></h4>
+<p>As an alternative to <code>nixos-generate-config</code>, you can use the experimental
+<a href="https://github.com/numtide/nixos-facter">nixos-facter</a> command, which offers
+more comprehensive hardware reports and advanced configuration options.</p>
+<p>To use <code>nixos-facter</code>, add the following to your flake inputs:</p>
+<pre><code class="language-diff"> {
++ inputs.nixos-facter-modules.url = "github:numtide/nixos-facter-modules";
+ }
+</code></pre>
+<p>Next, import the module into your configuration and specify <code>facter.json</code> as the
+path where the hardware report will be saved:</p>
+<pre><code class="language-diff"> nixosConfigurations.generic-nixos-facter = nixpkgs.lib.nixosSystem {
+   system = "x86_64-linux";
+   modules = [
+     disko.nixosModules.disko
+     ./configuration.nix
++    nixos-facter-modules.nixosModules.facter
++    { config.facter.reportPath = ./facter.json }
+   ];
+ };
+</code></pre>
+<p>To generate the configuration for <code>nixos-facter</code> with <code>nixos-anywhere</code>, use the
+following flags: <code>--generate-hardware-config nixos-facter ./facter.json</code>. The
+second flag, <code>./facter.json</code>, specifies where <code>nixos-generate-config</code> will store
+the hardware report. Adjust this path to suit the location where you want the
+<code>facter.json</code> to be saved.</p>
+<h3 id="9-run-it"><a class="header" href="#9-run-it">9. Run it</a></h3>
 <p>You can now run <strong>nixos-anywhere</strong> from the command line as shown below, where:</p>
 <ul>
 <li>
@@ -305,6 +343,15 @@ <h3 id="8-run-it"><a class="header" href="#8-run-it">8. Run it</a></h3>
 <code>37.27.18.135</code>:</p>
 <pre><code>nix run github:nix-community/nixos-anywhere -- --flake /home/mydir/test#hetzner-cloud root@37.27.18.135
 </code></pre>
+<p>If you also need to generate hardware configuration amend flags for
+nixos-generate-config:</p>
+<pre><code>nix run --generate-hardware-config nixos-generate-config ./hardware-configuration.nix github:nix-community/nixos-anywhere -- --flake &lt;path to configuration&gt;#&lt;configuration name&gt; root@&lt;ip address&gt;
+</code></pre>
+<p>Or these flags if you are using nixos-facter instead:</p>
+<pre><code>nix run --generate-hardware-config nixos-facter ./facter.json github:nix-community/nixos-anywhere -- --flake &lt;path to configuration&gt;#&lt;configuration name&gt; root@&lt;ip address&gt;
+</code></pre>
+<p>Adjust the location of <code>./hardware-configuration.nix</code> and <code>./facter.json</code>
+accordingly.</p>
 <p><strong>nixos-anywhere</strong> will then run, showing various output messages at each stage.
 It may take some time to complete, depending on Internet speeds. It should
 finish by showing the messages below before returning to the command prompt.</p>

reference.html

@@ -229,12 +229,20 @@ <h2 id="command-line-usage"><a class="header" href="#command-line-usage">Command
   build the closure on the remote machine instead of locally and copy-closuring it
 * --vm-test
   build the system and test the disk configuration inside a VM without installing it to the target.
+* --generate-hardware-config nixos-facter|nixos-generate-config &lt;path&gt;
+  generate a hardware-configuration.nix file using the specified backend and write it to the specified path.
+  The backend can be either 'nixos-facter' or 'nixos-generate-config'.
 * --phases
   comma separated list of phases to run. Default is: kexec,disko,install,reboot
   kexec: kexec into the nixos installer
   disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
   install: install the system
   reboot: reboot the machine
+* --disko-mode create|mount|disko
+  set the disko mode to create, mount or destroy. Default is disko.
+  format: create partition tables, zpools, lvms, raids and filesystems (Experimental: Can be run increntally, but use with caution and good backups)
+  mount: mount the partition at the specified root-mountpoint
+  disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
 </code></pre>
 <h2 id="explanation-of-known-error-messages"><a class="header" href="#explanation-of-known-error-messages">Explanation of known error messages</a></h2>
 <p>TODO: Add additional error messages and meanings. Fill in missing explanations</p>