forked from mirrors/nixpkgs
* Manual updates.
svn path=/nixos/trunk/; revision=10560
This commit is contained in:
Eelco Dolstra
parent
c21ba2d99e
commit
0efc29afa4
|
|
@ -14,13 +14,49 @@ NixOS.</para>
|
|||
<para>
|
||||
|
||||
<screen>
|
||||
$ nix-build system/system.nix \
|
||||
--arg configuration "import /etc/nixos/configuration.nix" \
|
||||
-A <replaceable>attr</replaceable></screen>
|
||||
$ nix-build /etc/nixos/nixos <replaceable>attr</replaceable></screen>
|
||||
|
||||
where <replaceable>attr</replaceable> is an attribute in
|
||||
<filename>system/system.nix</filename> (e.g.,
|
||||
<literal>bootStage1</literal>).</para>
|
||||
<filename>/etc/nixos/nixos/default.nix</filename>. Attributes of interest include:
|
||||
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>kernel</varname></term>
|
||||
<listitem><para>The kernel.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>initialRamdisk</varname></term>
|
||||
<listitem><para>The initial ramdisk (initrd) for this configuration.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>bootStage1</varname></term>
|
||||
<listitem><para>The stage 1 (initrd) init script.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>bootStage2</varname></term>
|
||||
<listitem><para>The stage 2 init script.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>etc</varname></term>
|
||||
<listitem><para>The statically computed parts of <filename>/etc</filename>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>upstartJobs</varname></term>
|
||||
<listitem><para>An attribute set containing the Upstart jobs. For
|
||||
instance, the <varname>sshd</varname> Upstart job can be built by
|
||||
doing <literal>nix-build /etc/nixos/nixos -A
|
||||
upstartJobs.sshd</literal>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
|
|
|
|||
|
|
@ -58,11 +58,9 @@ $ ln -s nixpkgs/pkgs nixos/</screen>
|
|||
$ nix-build configuration/rescue-cd.nix -A rescueCD</screen>
|
||||
|
||||
If everything goes well, you’ll end up with an ISO image in
|
||||
<filename>./result/iso/nixos.iso</filename>.</para></listitem>
|
||||
|
||||
<listitem><para>Burn the ISO image
|
||||
<filename>./result/iso/nixos.iso</filename> onto a CD or DVD or
|
||||
attach it to a CD-ROM drive in VMware.</para></listitem>
|
||||
<filename>./result/iso/nixos-<replaceable>version</replaceable>-<replaceable>platform</replaceable>.iso</filename>
|
||||
that you can burn onto a CD or attach to a virtual CD-ROM drive in
|
||||
your favourite virtual machine software.</para></listitem>
|
||||
|
||||
</orderedlist>
|
||||
|
||||
|
|
@ -81,13 +79,18 @@ $ nix-build configuration/rescue-cd.nix -A rescueCD</screen>
|
|||
|
||||
<listitem><para>Boot from the CD.</para></listitem>
|
||||
|
||||
<listitem><para>The CD contains a basic NixOS installation. When
|
||||
it’s finished booting, it should have detected most of your hardware
|
||||
and brought up networking (check <command>ifconfig</command>).
|
||||
Networking is necessary for the installer, since it will download
|
||||
lots of stuff (such as source tarballs or Nixpkgs channel binaries).
|
||||
It’s best if you have a DHCP server on your network. Otherwise
|
||||
configure manually.</para></listitem>
|
||||
<listitem><para>The CD contains a basic NixOS installation. (It
|
||||
also contain Memtest86+, useful if you want to test new hardware.)
|
||||
When it’s finished booting, it should have detected most of your
|
||||
hardware and brought up networking (check
|
||||
<command>ifconfig</command>). Networking is necessary for the
|
||||
installer, since it will download lots of stuff (such as source
|
||||
tarballs or Nixpkgs channel binaries). It’s best if you have a DHCP
|
||||
server on your network. Otherwise configure
|
||||
manually.</para></listitem>
|
||||
|
||||
<listitem><para>The NixOS manual is available on virtual console 7
|
||||
(press Alt+F7 to access).</para></listitem>
|
||||
|
||||
<listitem><para>Login as <literal>root</literal>, empty
|
||||
password.</para></listitem>
|
||||
|
|
@ -130,33 +133,76 @@ $ lvcreate --size 1G --name smalldisk MyVolGroup</screen>
|
|||
<listitem><para>For creating software RAID devices:
|
||||
<command>mdadm</command>.</para></listitem>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</para></listitem>
|
||||
|
||||
<listitem><para>Mount the target file system on
|
||||
<filename>/mnt</filename>.</para></listitem>
|
||||
|
||||
<listitem><para>The installation is declarative; you need to write
|
||||
a description of the configuration that you want to be built and
|
||||
<listitem>
|
||||
|
||||
<para>The installation is declarative; you need to write a
|
||||
description of the configuration that you want to be built and
|
||||
activated. The configuration is specified in a Nix expression and
|
||||
should be stored in
|
||||
<filename>/etc/nixos/configuration.nix</filename>. See
|
||||
must be stored <emphasis>on the target file system</emphasis> in
|
||||
<filename>/mnt/etc/nixos/configuration.nix</filename>. See
|
||||
<filename>/etc/nixos/nixos/configuration/examples</filename> for
|
||||
example machine configurations. You can copy and edit one of
|
||||
those (e.g., copy
|
||||
<filename>/etc/nixos/nixos/configuration/examples/basic.nix</filename>
|
||||
to <filename>/etc/nixos/configuration.nix</filename>). See <xref
|
||||
linkend="ch-options"/> for a list of the available configuration
|
||||
options. The text editor <command>nano</command> is
|
||||
available.</para>
|
||||
to <filename>/mnt/etc/nixos/configuration.nix</filename>). See
|
||||
<xref linkend="ch-options"/> for a list of the available
|
||||
configuration options. The text editors <command>nano</command>
|
||||
and <command>vim</command> are available.</para>
|
||||
|
||||
<para>In particular you need to specify a root file system in
|
||||
<option>fileSystems</option> and the target device for the Grub
|
||||
boot loader in <option>boot.grubDevice</option>.</para>
|
||||
|
||||
<para>The command <command>nixos-hardware-scan</command> can
|
||||
generate an initial configuration file for you, i.e.,
|
||||
|
||||
<screen>
|
||||
$ mkdir -p /mnt/etc/nixos
|
||||
$ nixos-hardware-scan > /mnt/etc/nixos/configuration.nix</screen>
|
||||
|
||||
It tries to figure out the modules necessary for mounting the root
|
||||
device, as well as various other hardware characteristics.
|
||||
However, it doesn’t try to figure out the
|
||||
<option>fileSystems</option> option yet.</para>
|
||||
|
||||
<para>More examples of NixOS configurations for some actual
|
||||
machines can be found at <link
|
||||
xlink:href="https://svn.cs.uu.nl:12443/repos/trace/configurations/trunk/"/>.</para>
|
||||
|
||||
<note><para>It is very important that you specify in the option
|
||||
<option>boot.initrd.extraKernelModules</option> all kernel modules
|
||||
that are necessary for mounting the root file system, otherwise
|
||||
the installed system will not be able to boot. (If this happens,
|
||||
boot from CD again, mount the target file system on
|
||||
<filename>/mnt</filename>, fix
|
||||
<filename>/mnt/etc/nixos/configuration.nix</filename> and rerun
|
||||
<filename>nixos-install</filename>.)
|
||||
<command>nixos-hardware-scan</command> should figure out the
|
||||
required modules in most cases.</para></note>
|
||||
|
||||
</listitem>
|
||||
|
||||
<listitem><para>If your machine has a limited amount of memory, you
|
||||
may want to activate swap devices now (<command>swapon
|
||||
<replaceable>device</replaceable></command>). The installer (or
|
||||
rather, the build actions that it may spawn) may need quite a bit of
|
||||
RAM, depending on your configuration.</para></listitem>
|
||||
|
||||
<listitem><para>Optionally, you can run
|
||||
|
||||
<screen>
|
||||
$ nixos-checkout</screen>
|
||||
|
||||
to make the installer use the latest NixOS/Nixpkgs sources from the
|
||||
Subversion repository, rather than the sources on CD.</para></listitem>
|
||||
|
||||
<listitem><para>Do the installation:
|
||||
|
||||
<screen>
|
||||
|
|
@ -169,22 +215,95 @@ $ nixos-install</screen>
|
|||
<screen>
|
||||
$ reboot</screen>
|
||||
|
||||
You should now be able to boot into the installed NixOS. The Grub
|
||||
boot menu shows a list of <emphasis>available
|
||||
</para></listitem>
|
||||
|
||||
<listitem>
|
||||
|
||||
<para>You should now be able to boot into the installed NixOS.
|
||||
The Grub boot menu shows a list of <emphasis>available
|
||||
configurations</emphasis> (initially just one). Every time you
|
||||
change the NixOS configuration, a new item appears in the menu.
|
||||
change the NixOS configuration (see <xref
|
||||
linkend="sec-changing-config" />), a new item appears in the menu.
|
||||
This allows you to go back easily to another configuration if
|
||||
something goes wrong.</para>
|
||||
|
||||
<para>You should log in and change the <literal>root</literal>
|
||||
password with <command>passwd</command>.</para></listitem>
|
||||
password with <command>passwd</command>.</para>
|
||||
|
||||
</itemizedlist>
|
||||
<para>You’ll probably want to create some user accounts as well,
|
||||
which can be done with <command>useradd</command>:
|
||||
|
||||
</para></listitem>
|
||||
<screen>
|
||||
$ useradd -c 'Eelco Dolstra' -m eelco
|
||||
$ passwd eelco</screen>
|
||||
|
||||
</para>
|
||||
|
||||
<para>You may also want to install some software. For instance,
|
||||
|
||||
<screen>
|
||||
$ nix-env -qa \*</screen>
|
||||
|
||||
shows what packages are available, and
|
||||
|
||||
<screen>
|
||||
$ nix-env -i w3m</screen>
|
||||
|
||||
install the <literal>w3m</literal> browser.</para>
|
||||
|
||||
</listitem>
|
||||
|
||||
</orderedlist>
|
||||
|
||||
<para><xref linkend="ex-install-sequence" /> shows a typical sequence
|
||||
of commands for installing NixOS on an empty hard drive (here
|
||||
<filename>/dev/sda). <xref linkend="ex-config" /> shows a
|
||||
corresponding configuration Nix expression.</filename>
|
||||
|
||||
</para>
|
||||
|
||||
<example xml:id='ex-install-sequence'><title>Commands for installing NixOS on <filename>/dev/sda</filename></title>
|
||||
<screen>
|
||||
$ fdisk /dev/sda <lineannotation>(or whatever device you want to install on)</lineannotation>
|
||||
$ mke2fs -j -L nixos /dev/sda1 <lineannotation>(idem)</lineannotation>
|
||||
$ mkswap -L swap /dev/sda2 <lineannotation>(idem)</lineannotation>
|
||||
$ mount LABEL=nixos /mnt
|
||||
$ mkdir -p /mnt/etc/nixos
|
||||
$ nixos-hardware-scan > /mnt/etc/nixos/configuration.nix
|
||||
$ nano /mnt/etc/nixos/configuration.nix
|
||||
<lineannotation>(in particular, set the fileSystems and swapDevices options)</lineannotation>
|
||||
$ nixos-install
|
||||
$ reboot</screen>
|
||||
</example>
|
||||
|
||||
<example xml:id='ex-config'><title>NixOS configuration</title>
|
||||
<screen>
|
||||
{
|
||||
boot = {
|
||||
initrd = {
|
||||
extraKernelModules = [ "ata_piix" ];
|
||||
};
|
||||
grubDevice = "/dev/sda";
|
||||
};
|
||||
|
||||
fileSystems = [
|
||||
{ mountPoint = "/";
|
||||
label = "nixos";
|
||||
}
|
||||
];
|
||||
|
||||
swapDevices = [
|
||||
{ label = "swap"; }
|
||||
];
|
||||
|
||||
services = {
|
||||
sshd = {
|
||||
enable = true;
|
||||
};
|
||||
};
|
||||
}</screen>
|
||||
</example>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -56,11 +56,11 @@
|
|||
<para>
|
||||
To have pidgin-latex plugin working after installation, you need the following:
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<listitem><para>
|
||||
Symlink <filename>/var/run/current-system/sw/share/pidgin-latex/pidgin-latex.so</filename>
|
||||
to <filename>$HOME/.purple/plugins/pidgin-latex.so</filename>
|
||||
</listitem>
|
||||
<listitem>
|
||||
</para></listitem>
|
||||
<listitem><para>
|
||||
Enable smileys. If you do not want to, you can create
|
||||
<filename>$HOME/.purple/smileys/empty/theme</filename> with the following contents:
|
||||
<programlisting>
|
||||
|
|
@ -69,10 +69,10 @@
|
|||
Author=Nobody
|
||||
</programlisting>
|
||||
Enabling this theme will enable smileys, but define none.
|
||||
</listitem>
|
||||
<listitem>
|
||||
</para></listitem>
|
||||
<listitem><para>
|
||||
Enable the plugin.
|
||||
</listitem>
|
||||
</para></listitem>
|
||||
</orderedlist>
|
||||
</para>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -2071,7 +2071,7 @@ root ALL=(ALL) SETENV: ALL
|
|||
description = "
|
||||
There are some times when you want really small system for specific
|
||||
purpose and do not want default package list. Setting
|
||||
<varname>cleanStart<varname> to <literal>true</literal> allows you
|
||||
<varname>cleanStart</varname> to <literal>true</literal> allows you
|
||||
to create a system with empty path - only extraPackages will be
|
||||
included.
|
||||
";
|
||||
|
|
|
|||
Loading…
Reference in a new issue