mirror of
https://github.com/nix-community/nixos-anywhere.git
synced 2024-09-11 08:35:24 +03:00
deploy: 0586b4da4f
This commit is contained in:
bors[bot]
parent
abac2f723f
commit
22014eb592
@ -1,2 +1,2 @@
|
||||
cp -r /nix/store/k6adgxqbs1l4mzlylwlphjkc38rxmyh0-source/* .
|
||||
cp -r /nix/store/dmlq2d0kf1jsmq077jvl7lmg20x61q3y-source/* .
|
||||
/nix/store/hrfzqg370iw27fskr9h2lypip815cr55-mdbook-0.4.28/bin/mdbook build --dest-dir "$out"
|
||||
|
||||
6
env-vars
6
env-vars
@ -3,10 +3,10 @@ declare -x HOME="/homeless-shelter"
|
||||
declare -x HOST_PATH="/nix/store/ahkfdxq8mcpsb5kvdvgqr1wv8zjngbh4-coreutils-9.1/bin:/nix/store/4qrbfa42xyicny7vlgbbqxz07kcsjbx2-findutils-4.9.0/bin:/nix/store/6bcqajyagcc4s3azx0zqnb3rqxd7gdnv-diffutils-3.9/bin:/nix/store/gy82r5cf12hgkmhzifsyx3fp6cnf6j2l-gnused-4.9/bin:/nix/store/zrls4w5lxynqakh1jlrp03kg4bxzp9yi-gnugrep-3.7/bin:/nix/store/s3yl3l8na93v53k2cfsyz0jrb50bnk8n-gawk-5.2.1/bin:/nix/store/czy796d2241296bdy45w87cmaiig50zr-gnutar-1.34/bin:/nix/store/hdbb5ayyrz1b5hicbsb4am8vin0xxxg6-gzip-1.12/bin:/nix/store/hd573q7097cxj5q29pnc3z0rvakz7ga3-bzip2-1.0.8-bin/bin:/nix/store/nnis9ph3wj866bbs0lalbf22i5bq8yry-gnumake-4.4.1/bin:/nix/store/rhvbjmcfnkg8i2dxpzr114cp1ws7f667-bash-5.2-p15/bin:/nix/store/x4ckkjsxfl4ihl82v0bzsyxs4ay2d5b5-patch-2.7.6/bin:/nix/store/8xjzmhw6hgqmynb5f1v7aw2lvafij405-xz-5.4.3-bin/bin:/nix/store/lcjsmsxqwd4vkq2wj5mmbyjzny3i6k49-file-5.44/bin"
|
||||
declare -x NIX_BUILD_CORES="2"
|
||||
declare -x NIX_BUILD_TOP="/build"
|
||||
declare -x NIX_CFLAGS_COMPILE=" -frandom-seed=rczdbnp800"
|
||||
declare -x NIX_CFLAGS_COMPILE=" -frandom-seed=0pglw66az4"
|
||||
declare -x NIX_ENFORCE_NO_NATIVE="1"
|
||||
declare -x NIX_ENFORCE_PURITY="1"
|
||||
declare -x NIX_LDFLAGS="-rpath /nix/store/rczdbnp800ylsj44qvlkwihfxn3jh70d-nixos-anywhere-docs/lib64 -rpath /nix/store/rczdbnp800ylsj44qvlkwihfxn3jh70d-nixos-anywhere-docs/lib "
|
||||
declare -x NIX_LDFLAGS="-rpath /nix/store/0pglw66az4hcl40siqm5l11vx6v5v821-nixos-anywhere-docs/lib64 -rpath /nix/store/0pglw66az4hcl40siqm5l11vx6v5v821-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/rczdbnp800ylsj44qvlkwihfxn3jh70d-nixos-anywhere-docs"
|
||||
declare -x out="/nix/store/0pglw66az4hcl40siqm5l11vx6v5v821-nixos-anywhere-docs"
|
||||
declare -x outputs="out"
|
||||
declare -x passAsFile="buildCommand"
|
||||
declare -x patches=""
|
||||
|
||||
146
print.html
146
print.html
@ -155,9 +155,149 @@
|
||||
</ul>
|
||||
<div style="break-before: page; page-break-before: always;"></div><h1 id="reference"><a class="header" href="#reference">Reference</a></h1>
|
||||
<div style="break-before: page; page-break-before: always;"></div><h1 id="quickstart-guide-nixos-anywhere"><a class="header" href="#quickstart-guide-nixos-anywhere">Quickstart Guide: nixos-anywhere</a></h1>
|
||||
<p>This document describes how to use <strong>nixos-anywhere</strong> in its simplest case:
|
||||
installing NixOS on an existing Linux distribution via SSH.</p>
|
||||
<p>TODO: Populate this guide</p>
|
||||
<p><strong><em>Install NixOS everywhere via ssh</em></strong></p>
|
||||
<img src="https://raw.githubusercontent.com/numtide/nixos-anywhere/main/docs/logo.png" width="150" height="150">
|
||||
<h2 id="inroduction"><a class="header" href="#inroduction">Inroduction</a></h2>
|
||||
<p>This guide documents a simple installation of NixOS using <strong>nixos-anywhere</strong> on
|
||||
a target machine running x86_64 Linux with
|
||||
<a href="https://man7.org/linux/man-pages/man8/kexec.8.html">kexec</a> support. The example
|
||||
used in this guide installs NixOS on a Hetzner cloud machine. The configuration
|
||||
may be different for some other instances. We will be including further examples
|
||||
in the <a href="./howtos.html">How To Guide</a> as and when they are available.</p>
|
||||
<p>You will need:</p>
|
||||
<ul>
|
||||
<li>A <a href="https://nixos.wiki/wiki/Flakes">flake</a> that controls the actions to be
|
||||
performed</li>
|
||||
<li>A disk configuration containing details of the file system that will be
|
||||
created on the new server.</li>
|
||||
</ul>
|
||||
<p><strong>nixos-anywhere</strong> doesn’t need to be installed. You can run it directly from
|
||||
<a href="https://github.com/numtide/nixos-anywhere">Numtide's repository on Github.</a></p>
|
||||
<p>Details of the flake, the disk configuration and the CLI command are discussed
|
||||
below.</p>
|
||||
<h2 id="steps-required-to-run-nixos-anywhere"><a class="header" href="#steps-required-to-run-nixos-anywhere">Steps required to run nixos-anywhere</a></h2>
|
||||
<ol>
|
||||
<li>
|
||||
<p>Create a directory for the flake and configuration files, and ensure flakes
|
||||
are enabled on your system. The
|
||||
<a href="https://nixos.wiki/wiki/Flakes#enable-flakes">Nixos Wiki</a> describes how to
|
||||
enable flakes.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>In this directory, run the following command to create a flake.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<pre><code>nix flake init
|
||||
</code></pre>
|
||||
<p>This will create a flake in a file named flake.nix. Edit the flake to suit your
|
||||
requirements. For a minimal installation, you can paste in the contents of the
|
||||
example flake from
|
||||
<a href="https://github.com/numtide/nixos-anywhere-examples/blob/main/flake.nix">here</a>.</p>
|
||||
<p>Lines 29 in the sample file reads:</p>
|
||||
<pre><code># change this to your ssh key
|
||||
"CHANGE"
|
||||
</code></pre>
|
||||
<p>Substitute the text that reads <code>CHANGE</code> with your own SSH key. This is
|
||||
important, otherwise you will not be able to log on to the target machine after
|
||||
NixOS has been installed.</p>
|
||||
<ol start="3">
|
||||
<li>
|
||||
<p>In the same directory, create a file named <code>disk-config.nix</code>. This will be
|
||||
used to specify the disk layout to the <strong>disko</strong> tool, which nixos-anywhere
|
||||
uses to partition, format and mount the disks. Again, for a simple
|
||||
installation you can paste the contents from the example
|
||||
<a href="https://github.com/numtide/nixos-anywhere-examples/blob/main/disk-config.nix">here</a>.
|
||||
This configures a standard GPT (GUID Partition Table) partition compatible
|
||||
with both EFI and BIOS systems, and mounts the disk as <code>/dev/sda</code>. If this
|
||||
doesn’t meet your requirements, choose an example that suits your disk
|
||||
layout from the
|
||||
<a href="https://github.com/nix-community/disko/tree/master/example">disko examples</a>.
|
||||
For more information about this configuration, refer to the
|
||||
<a href="https://github.com/nix-community/disko">disko documentation.</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Run the following command to create the <code>flake.lock</code> file:</p>
|
||||
</li>
|
||||
</ol>
|
||||
<pre><code>nix flake lock
|
||||
</code></pre>
|
||||
<p>Optionally, you can commit these files to a repo such as Github, or you can
|
||||
simply reference your local directory when you run <strong>nixos-anywhere</strong>. This
|
||||
example uses a local directory on the source machine.</p>
|
||||
<ol start="5">
|
||||
<li>
|
||||
<p>On the target machine, make sure you have access as root via ssh by adding
|
||||
your SSH key to the file <code>authorized_keys</code> in the directory <code>/root/.ssh</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p>You can now run <strong>nixos-anywhere</strong> from the command line as shown below,
|
||||
where:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><code><path to configuration></code> is the path to the directory or repository
|
||||
containing <code>flake.nix</code> and <code>disk-config.nix</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code><configuration name></code> must match the name that immediately follows the
|
||||
text <code>nixosConfigurations.</code> in the flake, as indicated by the comment in
|
||||
the
|
||||
<a href="https://github.com/numtide/nixos-anywhere-examples/blob/main/flake.nix">example</a>).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code><ip address></code> is the IP address of the target machine.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
<pre><code>nix run github:numtide/nixos-anywhere -- --flake <path to configuration>#<configuration name> root@<ip address>
|
||||
</code></pre>
|
||||
<p>The command would look like this if you had created your files in a directory
|
||||
named <code>/home/mydir/test</code> and the IP address of your target machine is
|
||||
<code>37.27.18.135</code>:</p>
|
||||
<pre><code>nix run github:numtide/nixos-anywhere -- --flake /home/mydir/test#hetzner-cloud root@37.27.18.135
|
||||
</code></pre>
|
||||
<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>
|
||||
<pre><code>Installation finished. No error reported.
|
||||
Warning: Permanently added '<ip-address>' (ED25519) to the list of known hosts
|
||||
</code></pre>
|
||||
<p>When this happens, the target server will have been overwritten with a new
|
||||
installation of NixOS. Note that the server's public SSH key will have changed.</p>
|
||||
<p>If you have previously accessed this server using SSH, you may see the following
|
||||
message the next time you try to log in to the target.</p>
|
||||
<pre><code> @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
|
||||
@ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @
|
||||
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
|
||||
IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!
|
||||
Someone could be eavesdropping on you right now (man-in-the-middle attack)!
|
||||
It is also possible that a host key has just been changed.
|
||||
The fingerprint for the ED25519 key sent by the remote host is
|
||||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
|
||||
Please contact your system administrator.
|
||||
Add correct host key in ~/.ssh/known_hosts to get rid of this message.
|
||||
Offending ECDSA key in ~/.ssh/known_hosts:6
|
||||
remove with:
|
||||
ssh-keygen -f ~/.ssh/known_hosts" -R "<ip addrress>"
|
||||
Host key for <ip_address> has changed and you have requested strict checking.
|
||||
Host key verification failed.
|
||||
</code></pre>
|
||||
<p>This is because the <code>known_hosts</code> file in the <code>.ssh</code> directory now contains a
|
||||
mismatch, since the server has been overwritten. To solve this, use a text
|
||||
editor to remove the old entry from the <code>known_hosts</code> file. The next connection
|
||||
attempt will then treat this as a new server.</p>
|
||||
<p>The error message line <code>Offending ECDSA key in ~/.ssh/known_hosts:</code> gives the
|
||||
line number that needs to be removed from the <code>known_hosts</code> file.</p>
|
||||
<p><strong>Note:</strong> If you subsequently make any changes to either the <code>flake.nix</code> or
|
||||
<code>disk-config.nix</code> file, you will need to run the following command in the
|
||||
directory containing the flake to update <code>flake.lock</code> before rerunning
|
||||
<strong>nixos-anywhere</strong>:</p>
|
||||
<pre><code>nix flake update
|
||||
</code></pre>
|
||||
<p>For more information on different use cases of <strong>nixos-anywhere</strong> please refer
|
||||
to the <a href="./howtos.html">How to Guide</a>, and for more technical information and
|
||||
explanation of known error messages, refer to the
|
||||
<a href="./reference.html">Reference Manual</a>.</p>
|
||||
<div style="break-before: page; page-break-before: always;"></div><h1 id="reference-1"><a class="header" href="#reference-1">Reference</a></h1>
|
||||
<div style="break-before: page; page-break-before: always;"></div><h1 id="reference-2"><a class="header" href="#reference-2">Reference</a></h1>
|
||||
<div style="break-before: page; page-break-before: always;"></div><h1 id="reference-3"><a class="header" href="#reference-3">Reference</a></h1>
|
||||
|
||||
146
quickstart.html
146
quickstart.html
@ -145,9 +145,149 @@
|
||||
<div id="content" class="content">
|
||||
<main>
|
||||
<h1 id="quickstart-guide-nixos-anywhere"><a class="header" href="#quickstart-guide-nixos-anywhere">Quickstart Guide: nixos-anywhere</a></h1>
|
||||
<p>This document describes how to use <strong>nixos-anywhere</strong> in its simplest case:
|
||||
installing NixOS on an existing Linux distribution via SSH.</p>
|
||||
<p>TODO: Populate this guide</p>
|
||||
<p><strong><em>Install NixOS everywhere via ssh</em></strong></p>
|
||||
<img src="https://raw.githubusercontent.com/numtide/nixos-anywhere/main/docs/logo.png" width="150" height="150">
|
||||
<h2 id="inroduction"><a class="header" href="#inroduction">Inroduction</a></h2>
|
||||
<p>This guide documents a simple installation of NixOS using <strong>nixos-anywhere</strong> on
|
||||
a target machine running x86_64 Linux with
|
||||
<a href="https://man7.org/linux/man-pages/man8/kexec.8.html">kexec</a> support. The example
|
||||
used in this guide installs NixOS on a Hetzner cloud machine. The configuration
|
||||
may be different for some other instances. We will be including further examples
|
||||
in the <a href="./howtos.html">How To Guide</a> as and when they are available.</p>
|
||||
<p>You will need:</p>
|
||||
<ul>
|
||||
<li>A <a href="https://nixos.wiki/wiki/Flakes">flake</a> that controls the actions to be
|
||||
performed</li>
|
||||
<li>A disk configuration containing details of the file system that will be
|
||||
created on the new server.</li>
|
||||
</ul>
|
||||
<p><strong>nixos-anywhere</strong> doesn’t need to be installed. You can run it directly from
|
||||
<a href="https://github.com/numtide/nixos-anywhere">Numtide's repository on Github.</a></p>
|
||||
<p>Details of the flake, the disk configuration and the CLI command are discussed
|
||||
below.</p>
|
||||
<h2 id="steps-required-to-run-nixos-anywhere"><a class="header" href="#steps-required-to-run-nixos-anywhere">Steps required to run nixos-anywhere</a></h2>
|
||||
<ol>
|
||||
<li>
|
||||
<p>Create a directory for the flake and configuration files, and ensure flakes
|
||||
are enabled on your system. The
|
||||
<a href="https://nixos.wiki/wiki/Flakes#enable-flakes">Nixos Wiki</a> describes how to
|
||||
enable flakes.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>In this directory, run the following command to create a flake.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<pre><code>nix flake init
|
||||
</code></pre>
|
||||
<p>This will create a flake in a file named flake.nix. Edit the flake to suit your
|
||||
requirements. For a minimal installation, you can paste in the contents of the
|
||||
example flake from
|
||||
<a href="https://github.com/numtide/nixos-anywhere-examples/blob/main/flake.nix">here</a>.</p>
|
||||
<p>Lines 29 in the sample file reads:</p>
|
||||
<pre><code># change this to your ssh key
|
||||
"CHANGE"
|
||||
</code></pre>
|
||||
<p>Substitute the text that reads <code>CHANGE</code> with your own SSH key. This is
|
||||
important, otherwise you will not be able to log on to the target machine after
|
||||
NixOS has been installed.</p>
|
||||
<ol start="3">
|
||||
<li>
|
||||
<p>In the same directory, create a file named <code>disk-config.nix</code>. This will be
|
||||
used to specify the disk layout to the <strong>disko</strong> tool, which nixos-anywhere
|
||||
uses to partition, format and mount the disks. Again, for a simple
|
||||
installation you can paste the contents from the example
|
||||
<a href="https://github.com/numtide/nixos-anywhere-examples/blob/main/disk-config.nix">here</a>.
|
||||
This configures a standard GPT (GUID Partition Table) partition compatible
|
||||
with both EFI and BIOS systems, and mounts the disk as <code>/dev/sda</code>. If this
|
||||
doesn’t meet your requirements, choose an example that suits your disk
|
||||
layout from the
|
||||
<a href="https://github.com/nix-community/disko/tree/master/example">disko examples</a>.
|
||||
For more information about this configuration, refer to the
|
||||
<a href="https://github.com/nix-community/disko">disko documentation.</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Run the following command to create the <code>flake.lock</code> file:</p>
|
||||
</li>
|
||||
</ol>
|
||||
<pre><code>nix flake lock
|
||||
</code></pre>
|
||||
<p>Optionally, you can commit these files to a repo such as Github, or you can
|
||||
simply reference your local directory when you run <strong>nixos-anywhere</strong>. This
|
||||
example uses a local directory on the source machine.</p>
|
||||
<ol start="5">
|
||||
<li>
|
||||
<p>On the target machine, make sure you have access as root via ssh by adding
|
||||
your SSH key to the file <code>authorized_keys</code> in the directory <code>/root/.ssh</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p>You can now run <strong>nixos-anywhere</strong> from the command line as shown below,
|
||||
where:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p><code><path to configuration></code> is the path to the directory or repository
|
||||
containing <code>flake.nix</code> and <code>disk-config.nix</code></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code><configuration name></code> must match the name that immediately follows the
|
||||
text <code>nixosConfigurations.</code> in the flake, as indicated by the comment in
|
||||
the
|
||||
<a href="https://github.com/numtide/nixos-anywhere-examples/blob/main/flake.nix">example</a>).</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><code><ip address></code> is the IP address of the target machine.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
<pre><code>nix run github:numtide/nixos-anywhere -- --flake <path to configuration>#<configuration name> root@<ip address>
|
||||
</code></pre>
|
||||
<p>The command would look like this if you had created your files in a directory
|
||||
named <code>/home/mydir/test</code> and the IP address of your target machine is
|
||||
<code>37.27.18.135</code>:</p>
|
||||
<pre><code>nix run github:numtide/nixos-anywhere -- --flake /home/mydir/test#hetzner-cloud root@37.27.18.135
|
||||
</code></pre>
|
||||
<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>
|
||||
<pre><code>Installation finished. No error reported.
|
||||
Warning: Permanently added '<ip-address>' (ED25519) to the list of known hosts
|
||||
</code></pre>
|
||||
<p>When this happens, the target server will have been overwritten with a new
|
||||
installation of NixOS. Note that the server's public SSH key will have changed.</p>
|
||||
<p>If you have previously accessed this server using SSH, you may see the following
|
||||
message the next time you try to log in to the target.</p>
|
||||
<pre><code> @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
|
||||
@ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @
|
||||
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
|
||||
IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!
|
||||
Someone could be eavesdropping on you right now (man-in-the-middle attack)!
|
||||
It is also possible that a host key has just been changed.
|
||||
The fingerprint for the ED25519 key sent by the remote host is
|
||||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
|
||||
Please contact your system administrator.
|
||||
Add correct host key in ~/.ssh/known_hosts to get rid of this message.
|
||||
Offending ECDSA key in ~/.ssh/known_hosts:6
|
||||
remove with:
|
||||
ssh-keygen -f ~/.ssh/known_hosts" -R "<ip addrress>"
|
||||
Host key for <ip_address> has changed and you have requested strict checking.
|
||||
Host key verification failed.
|
||||
</code></pre>
|
||||
<p>This is because the <code>known_hosts</code> file in the <code>.ssh</code> directory now contains a
|
||||
mismatch, since the server has been overwritten. To solve this, use a text
|
||||
editor to remove the old entry from the <code>known_hosts</code> file. The next connection
|
||||
attempt will then treat this as a new server.</p>
|
||||
<p>The error message line <code>Offending ECDSA key in ~/.ssh/known_hosts:</code> gives the
|
||||
line number that needs to be removed from the <code>known_hosts</code> file.</p>
|
||||
<p><strong>Note:</strong> If you subsequently make any changes to either the <code>flake.nix</code> or
|
||||
<code>disk-config.nix</code> file, you will need to run the following command in the
|
||||
directory containing the flake to update <code>flake.lock</code> before rerunning
|
||||
<strong>nixos-anywhere</strong>:</p>
|
||||
<pre><code>nix flake update
|
||||
</code></pre>
|
||||
<p>For more information on different use cases of <strong>nixos-anywhere</strong> please refer
|
||||
to the <a href="./howtos.html">How to Guide</a>, and for more technical information and
|
||||
explanation of known error messages, refer to the
|
||||
<a href="./reference.html">Reference Manual</a>.</p>
|
||||
|
||||
</main>
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user