NixOS Wiki

NixOS Installation Guide: Difference between revisions

VisualWikitext
imported>Makefu
initial batch of nixos-users
 
Pigeon (talk | contribs)
12 edits
m fix typo in #Custom_configuration
 
(70 intermediate revisions by 27 users not shown)
Line 1: Line 1:
For commodity PC hardware the [https://nixos.org/nixos/manual/index.html#ch-installation official manual] should covers the most use cases.
<languages/>
<translate>
<!--T:1-->
This guide serves as a companion guide for the [https://nixos.org/nixos/manual/index.html#ch-installation official manual]. It describes installation of [[NixOS]] as a complete operating system. For instructions on installing [[Nix]] within an existing operating system, refer to the [[Nix Installation Guide]].


== Build a custom installation image ==
<!--T:2-->
In addition to covering the steps from the official manual, it provides known good instructions for common use cases. When there is a discrepancy between the manual and this guide, the supported case is the one described in the manual.


NixOS provides an easy way to build a custom variant of the installation image. This might be useful to embed your own ssh key or enable additional features like zfs support. It allows to specify a custom <code>configuration.nix</code> which is used to build the image
== Installation target == <!--T:4-->


<pre class="nix"># myiso.nix
<!--T:5-->
{ config, lib, pkgs, modulesPath, ... }:
NixOS can be installed on an increasing variety of hardware:
{
  imports = [
    &lt;nixpkgs/nixos/modules/installer/cd-dvd/installation-cd-minimal.nix&gt;
  ];
  # enable zfs support
  #boot.supportedFilesystems = [ &quot;zfs&quot; ];


  # enable sshd on boot
<!--T:6-->
  services.openssh = {
* regular (Intel or AMD) desktop computers, laptops or physically accessible servers, covered on this page
    enable = true;
* SBCs (like the Raspberry Pis) and other ARM boards, see [[NixOS on ARM]]
    startWhenNeeded = true;
* cloud and remote servers, see [[NixOS friendly hosters]]
  };
  # the following allows to embed your own ssh key into the image
  users.extraUsers.root.openssh.authorizedKeys.keys = [
    &quot;ssh-ed25519 AaAeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee username@host&quot;
  ];


  ## The following snippet is useful, when static ip addresses are required,
== Installation method == <!--T:7-->
  ## e.g. for VPS installation
  #
  #networking = {
  #  usePredictableInterfaceNames = false;
  #  interfaces.eth0.ip4 = [{
  #    address = &quot;64.137.201.46&quot;;
  #    prefixLength = 24;
  #  }];
  #  defaultGateway = &quot;64.137.201.1&quot;;
  #  nameServers = [ &quot;8.8.8.8&quot; ];
  #};


}</pre>
<!--T:8-->
The '''full path''' of the file needs to be passed to <code>nix-build</code>.
NixOS, as with most Linux-based operating systems, can be installed in different ways.


<pre>$ nix-build '&lt;nixpkgs/nixos&gt;' -A config.system.build.isoImage -I nixos-config=/etc/nixos/myiso.nix</pre>
<!--T:9-->
The resulting image can be found in <code>result</code>:
# The classic way, booting from the installation media. (Described below.)
# [[Installing from Linux|Booting the media from an existing Linux installation]]


<pre>$ ls result/iso/
== Making the installation media == <!--T:10-->
nixos-17.09.git.158ec57-x86_64-linux.iso</pre>
== Install Nixos on VPS/Cloud-Provider ==


Not all providers allow to upload own images or provide NixOS images for installation. However there are a few ways to install NixOS anyhow.
<!--T:11-->
Since NixOS 14.11 the installer ISO is hybrid. This means it is bootable on both CD and USB drives. It also boots on EFI systems, like most modern motherboards and apple systems. The following instructions will assume the standard way of copying the image to a USB drive. When using a CD or DVD, the usual methods to burn to disk should work with the iso.


[https://github.com/jeaye/nixos-in-place nixos-in-place] and [https://github.com/elitak/nixos-infect nixos-infect] are generic approaches to install NixOS from an existing Linux.
=== "Burning" to USB drive === <!--T:12-->


A different approach is to build an kexec-based image to start the installer from an booted linux as shown in this [https://github.com/cleverca22/nix-tests/tree/master/kexec repo]
<!--T:13-->
First, download a [https://nixos.org/download.html#nixos-iso NixOS ISO image] or [[Creating a NixOS live CD|create a custom ISO]]. Then plug in a USB stick large enough to accommodate the image. Then follow the platform instructions:


=== Installation Stories ===
==== From Linux ==== <!--T:14-->


Add the code you needed to run in order to deploy NixOS at $provider .
<!--T:15-->
# Find the right device with <code>lsblk</code> or <code>fdisk -l</code>. Replace <code><i>/dev/sdX</i></code> with the proper device in the following steps.
# Copy to device: <code>cp nixos-xxx.iso <em>/dev/sdX</em></code>


==== Hetzner ====
<!--T:16-->
{{note|do not use /dev/sdX1 or partitions of the disk, use the whole disk /dev/sdX.}}


Hetzner provides an [https://wiki.hetzner.de/index.php/LARA/en#Installing_an_OS interface] to upload your own ISO-images. However you may want to build your own iso-image, which has openssh with ssh keys due the lack of a remote console. An easier method to install NixOS on Hetzner, is to use the existing integration into [https://nixos.org/nixops/manual/#idm140737318364240 NixOps]
<!--T:17-->
Writing the disk image with <code>dd if=nixos.iso of=/dev/sdX bs=4M status=progress conv=fdatasync</code> also works.


==== Digitalocean ====
==== From macOS ==== <!--T:18-->


On Digitalocean the project [https://github.com/elitak/nixos-infect nixos-infect] can be used to transform an existing installation into NixOS. This method will be also used in [https://nixos.org/nixops/manual/#sec-deploying-to-digital-ocean NixOps].
<!--T:19-->
# Find the right device with <code>diskutil list</code>, let's say <code><i>diskX</i></code>.
# Unmount with <code>diskutil unmountDisk <i>diskX</i></code>.
# Burn with: <code>sudo dd if=<b>path_to_nixos.iso</b> of=/dev/<i>diskX</i></code>


==== Netcup ====
<!--T:20-->
{{tip|Using <code>rdiskX</code> instead of <code>diskX</code> can makes a large speed difference. You can check the write speed with <code>iostat 2</code> in another terminal.}}


You can mount your own images similar to hetzner, see the [https://www.netcup-wiki.de/wiki/Server_Control_Panel_%28SCP%29#Eigene_DVDs official netcup documentation].
==== From Windows ==== <!--T:21-->


==== Linode ====
<!--T:22-->
# Download [http://sourceforge.net/projects/usbwriter/ USBwriter].
# Start USBwriter.
# Choose the downloaded ISO as 'Source'
# Choose the USB drive as 'Target'
# Click 'Write'
# When USBwriter has finished writing, safely unplug the USB drive.


NixOS is official supported by Linode. Up to date documentation can be obtained from their [https://www.linode.com/docs/tools-reference/custom-kernels-distros/install-nixos-on-linode manual]
=== Alternative installation media instructions === <!--T:23-->


==== CloudAtCost ====
<!--T:24-->
The previous methods are the supported methods of making the USB installation media.


==== Scaleway ====
<!--T:25-->
Those methods are also documented, they can allow using the USB drive to boot multiple distributions. This is not supported, your mileage may vary.


The <code>kexec</code> method above works well, but bear in mind it only works with the 'virtual' class of servers, as they run under a hypervisor which attaches the disks before the kernel boots. The 'bare-metal' servers rely on a special Linux kernel booting to attach network <code>/dev/nbdX</code> drives which works only with Scaleway supplied images.
<!--T:26-->
* [[NixOS_Installation_Guide/Unetbootin|Using Unetbootin]]
* [[NixOS_Installation_Guide/Manual USB Creation|Manual USB Creation]]
* [[NixOS_Installation_Guide/multibootusb|multibootusb]]


==== <your vps provider here> ====
<!--T:27-->
== Booting the installation media ==
{{expansion|Troubleshooting steps, and details are lacking.}}


== Special hardware ==
<!--T:28-->
The installation media is hybrid and is capable of booting in both legacy BIOS mode and [[UEFI]] mode.


<!--T:29-->
Whatever mode is used to boot the installation media, your motherboard or computer's configuration may need to be changed to allow booting from a Optical Disk Drive (for CD/DVD) or an external USB drive.
=== Legacy bios boot === <!--T:30-->
<!--T:31-->
This is the only boot possible on machines lacking EFI/UEFI.
=== UEFI boot === <!--T:32-->
<!--T:33-->
The EFI bootloader of the installation media is not signed and is not using a signed shim to boot. This means that Secure Boot will need to be disabled to boot.
== Connecting to the internet == <!--T:34-->
<!--T:35-->
The installation will '''definitely''' need a working internet connection. It is possible to install without one, but the available set of packages is limited.
=== Wired === <!--T:36-->
<!--T:37-->
For network interfaces supported by the kernel, DHCP resolution should already have happened once the shell is available.
==Tethered (Internet Sharing)== <!--T:38-->
<!--T:39-->
If you can not connect to the internet via cable or wifi, you may use smartphone's tethering capability to share internet. Depending on your smartphones capabilities, only stock kernel drivers may be required which can help providing a working network connection.
=== Wireless === <!--T:40-->
<!--T:41-->
[[NetworkManager]] is installed on the graphical ISO, meaning that it is possible to use <code>nmtui</code> on the command line to connect to a network.
<!--T:42-->
Using the "Applications" tab at top
left or the launcher bar at bottom, choose a terminal application and from there launch <code>nmtui</code>. This will allow you to 'activate' a (wireless) connection - your local SSIDs should be visible in the list, else you can add a new connection.  When the wireless connection is active and you have tested it, it is likely the install app which launched on startup has not detected the new connection.  Close down the install app, and reopen it from the launcher bar at the bottom of the screen.  This should then find the new connection and proceed.
<!--T:43-->
On the minimal ISO, or if you are more familiar with [[wpa_supplicant]] then you can also run <code>wpa_passphrase ESSID | sudo tee /etc/wpa_supplicant.conf</code>, then enter your password and <code>systemctl restart wpa_supplicant</code>.
== Partitioning == <!--T:44-->
<!--T:45-->
To partition the persistent storage run <code>sudo fdisk /dev/diskX</code> and follow instructions for MBR or (U)EFI. To determine which mode you are booted into, run:
<syntaxhighlight lang="console">
$ [ -d /sys/firmware/efi/efivars ] && echo "UEFI" || echo "Legacy"
</syntaxhighlight>
A very simple example setup is given here.
=== Legacy Boot (MBR) === <!--T:46-->
<!--T:47-->
* o (dos disk label)
* n new
* p primary (4 primary in total)
* 1 (partition number [1/4])
* 2048 first sector (alignment for performance)
* +500M last sector (boot sector size)
* rm signature (Y), if ex. => warning of overwriting existing system, could use wipefs
* n
* p
* 2
* default (fill up partition)
* default (fill up partition)
* w (write)
=== UEFI === <!--T:48-->
<!--T:49-->
* g (gpt disk label)
* n
* 1 (partition number [1/128])
* 2048 first sector
* +500M last sector (boot sector size)
* t
* 1 (EFI System)
* n
* 2
* default (fill up partition)
* default (fill up partition)
* w (write)
=== Format partitions === <!--T:50-->
<!--T:51-->
The example below uses the [[ext4]] filesystem format. If you wish to use other filesystem formats such as [[Btrfs]] or [[ZFS]]:
* [[Bcachefs#NixOS installation on bcachefs]]
* [[Btrfs#Installation of NixOS on btrfs]]
* [[LVM#Basic Setup]]
* [[ZFS#Simple NixOS ZFS on root installation]]
This is useful for having multiple setups and makes partitions easier to handle<syntaxhighlight lang="console">
$ lsblk # lists current system block devices
# mkfs.fat -F 32 -n boot /dev/sdX1
# mkfs.ext4 /dev/sdX2 -L nixos
# mount /dev/disk/by-label/nixos /mnt
# mkdir -p /mnt/boot
# mount /dev/disk/by-label/boot /mnt/boot
</syntaxhighlight>
<!--T:53-->
== NixOS configuration ==
NixOS is configured through a [[Overview of the NixOS Linux distribution#Declarative Configuration|declarative configuration]] file. To generate a default config file, run [[nixos-generate-config]]:
<syntaxhighlight lang="console">
# nixos-generate-config --root /mnt
# nano /mnt/etc/nixos/configuration.nix
</syntaxhighlight>
For information on working with a system configuration, see [[NixOS system configuration]]. For desktop-specific configurations, see [[NixOS as a desktop]].
Most essential changes:
<!--T:54-->
* keyboard layout, ie <code>[[Keyboard Layout Customization|services.xserver.xkb.layout]]</code>
* [[networking]] (wifi), see below for fix if it breaks
* install [[:Category:Text Editor|editor]] to edit the configuration
<!--T:55-->
The self-documenting NixOS options can be searched with [https://search.nixos.org/options NixOS options search].
<!--T:52-->
=== Swap file ===
For additional methods of configuring swap, see [[Swap]]. The following example demonstrates how to create and enable a [[Swap#Swap file|swap file]]:
{{file|/mnt/etc/nixos/configuration.nix|nix|
<nowiki>
  swapDevices = [{
    device = "/var/lib/swapfile";
    size = 16*1024; # 16 GB
  }];
</nowiki>
}}
=== Bootloader ===
NixOS supports multiple [[Bootloader|bootloaders]] such as [[GNU GRUB]] and [[Systemd/boot]].
Systemd-boot is the recommended bootloader. The following example demonstrates how to enable systemd-boot in your configuration:
{{file|/mnt/etc/nixos/configuration.nix|nix|
<nowiki>
  boot.loader.systemd-boot.enable = true;
</nowiki>
}}
You may also wish to configure [[Secure Boot]].
=== Users ===
For information on creating and managing users, see [[User management]] and the {{NixOS Manual|name=NixOS Manual: Chapter - Package Management|anchor=#sec-user-management}}. See an example below:
{{file|/mnt/etc/nixos/configuration.nix|nix|
<nowiki>
  users.users.alice = {
    isNormalUser = true;
    initialPassword = "pw123";
  };
</nowiki>
}}
== NixOS installation ==
<syntaxhighlight lang="console">
# cd /mnt
# nixos-install
</syntaxhighlight>after installation: Run <code>passwd</code> to change user password.
<!--T:57-->
if internet broke/breaks, try one of the following:<syntaxhighlight lang="console">
# nixos-rebuild switch --option substitute false # no downloads
# nixos-rebuild switch --option binary-caches "" # no downloads
</syntaxhighlight>
* wpa_supplicant flags to connect to wifi
<!--T:58-->
<hr />
== Additional notes for specific hardware == <!--T:59-->
<!--T:60-->
These are collected notes or links for specific hardware issues.
<!--T:61-->
* Blog post how to install NixOS on a [http://grahamc.com/blog/nixos-on-dell-9560 Dell 9560]
* Blog post how to install NixOS on a [http://grahamc.com/blog/nixos-on-dell-9560 Dell 9560]
* for embedded Hardware like the Raspberry Pi2 see [[NixOS-on-ARM]]
* Brand servers may require extra kernel modules be included into initrd (<code>boot.initrd.extraKernelModules</code> in configuration.nix) For example HP Proliant needs "hpsa" module to see the disk drive.
 
<!--T:62-->
[[Category:Guide]]
[[Category:Deployment]]
[[Category:NixOS]]
</translate>
Retrieved from "https://wiki.nixos.org/wiki/NixOS_Installation_Guide"