diff options
author | Domen Kožar <domen@dev.si> | 2016-04-29 10:41:13 +0100 |
---|---|---|
committer | Domen Kožar <domen@dev.si> | 2016-04-29 10:42:45 +0100 |
commit | 90d7041ce4d270bbcf0efefd1d1e42c097c1335d (patch) | |
tree | d86a77b402c73dae942d1c7f10f018f7b252851d /nixos/doc | |
parent | 83c0aca062369aa43d5e692f22ff22e8d2e787a1 (diff) |
PXE boot: add manual section and note in changelog
Diffstat (limited to 'nixos/doc')
-rw-r--r-- | nixos/doc/manual/installation/installing-pxe.xml | 48 | ||||
-rw-r--r-- | nixos/doc/manual/installation/installing.xml | 1 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/release-notes.xml | 1 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-1609.xml | 48 |
4 files changed, 98 insertions, 0 deletions
diff --git a/nixos/doc/manual/installation/installing-pxe.xml b/nixos/doc/manual/installation/installing-pxe.xml new file mode 100644 index 000000000000..7b7597c91626 --- /dev/null +++ b/nixos/doc/manual/installation/installing-pxe.xml @@ -0,0 +1,48 @@ +<section xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + version="5.0" + xml:id="sec-booting-from-pxe"> + +<title>Booting from the <quote>netboot</quote> media (PXE)</title> +<para> + Advanced users may wish to install NixOS using an existing PXE or + iPXE setup. +</para> +<para> + These instructions assume that you have an existing PXE or iPXE + infrastructure and simply want to add the NixOS installer as another + option. To build the necessary files from a recent version of + nixpkgs, you can run: +</para> +<programlisting> +nix-build -A netboot nixos/release.nix +</programlisting> +<para> + This will create a <literal>result</literal> directory containing: * + <literal>bzImage</literal> – the Linux kernel * + <literal>initrd</literal> – the initrd file * + <literal>netboot.ipxe</literal> – an example ipxe script + demonstrating the appropriate kernel command line arguments for this + image +</para> +<para> + If you’re using plain PXE, configure your boot loader to use the + <literal>bzImage</literal> and <literal>initrd</literal> files and + have it provide the same kernel command line arguments found in + <literal>netboot.ipxe</literal>. +</para> +<para> + If you’re using iPXE, depending on how your HTTP/FTP/etc. server is + configured you may be able to use <literal>netboot.ipxe</literal> + unmodified, or you may need to update the paths to the files to + match your server’s directory layout +</para> +<para> + In the future we may begin making these files available as build + products from hydra at which point we will update this documentation + with instructions on how to obtain them either for placing on a + dedicated TFTP server or to boot them directly over the internet. +</para> + +</section> diff --git a/nixos/doc/manual/installation/installing.xml b/nixos/doc/manual/installation/installing.xml index 4a0b3fee7c18..3e53062c3e84 100644 --- a/nixos/doc/manual/installation/installing.xml +++ b/nixos/doc/manual/installation/installing.xml @@ -270,5 +270,6 @@ $ reboot</screen> <xi:include href="installing-uefi.xml" /> <xi:include href="installing-usb.xml" /> +<xi:include href="installing-pxe.xml" /> </chapter> diff --git a/nixos/doc/manual/release-notes/release-notes.xml b/nixos/doc/manual/release-notes/release-notes.xml index 2beaab00800d..31a7ae04a4f5 100644 --- a/nixos/doc/manual/release-notes/release-notes.xml +++ b/nixos/doc/manual/release-notes/release-notes.xml @@ -9,6 +9,7 @@ <para>This section lists the release notes for each stable version of NixOS and current unstable revision.</para> +<xi:include href="rl-1609.xml" /> <xi:include href="rl-1603.xml" /> <xi:include href="rl-1509.xml" /> <xi:include href="rl-1412.xml" /> diff --git a/nixos/doc/manual/release-notes/rl-1609.xml b/nixos/doc/manual/release-notes/rl-1609.xml new file mode 100644 index 000000000000..22dea8029242 --- /dev/null +++ b/nixos/doc/manual/release-notes/rl-1609.xml @@ -0,0 +1,48 @@ +<section xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + version="5.0" + xml:id="sec-release-16.09"> + +<title>Release 16.09 (“Flounder”, 2016/09/??)</title> + +<para>In addition to numerous new and upgraded packages, this release +has the following highlights: </para> + +<itemizedlist> + + <listitem> + <para>PXE "netboot" media has landed in <link xlink:href="https://github.com/NixOS/nixpkgs/pull/14740" />. + See <xref linkend="sec-booting-from-pxe" /> for documentation.</para> + </listitem> + +</itemizedlist> + +<para>The following new services were added since the last release:</para> + + <itemizedlist> + <listitem><para><literal>(this will get automatically generated at release time)</literal></para></listitem> + </itemizedlist> + + +<para>When upgrading from a previous release, please be aware of the +following incompatible changes:</para> + +<itemizedlist> + <listitem> + <para>todo</para> + </listitem> +</itemizedlist> + + +<para>Other notable improvements:</para> + +<itemizedlist> + <listitem> + <para>todo</para> + </listitem> + +</itemizedlist> + + +</section> |