Merge pull request #7 from nixbitcoin/documentation
Add own hardware tutorial to README.md
This commit is contained in:
Jonas Nick
GitHub
commit
63a58657e4
222
README.md
222
README.md
@ -185,3 +185,225 @@ Open VirtualBox
|
|||||||
File -> Host Network Manager -> Create
|
File -> Host Network Manager -> Create
|
||||||
This should create a hostadapter named vboxnet0
|
This should create a hostadapter named vboxnet0
|
||||||
```
|
```
|
||||||
|
Tutorial: install and configure NixOS for nix-bitcoin on your own hardware
|
||||||
|
---
|
||||||
|
## 1. NixOS installation
|
||||||
|
|
||||||
|
This is borrowed from the [NixOS manual](https://nixos.org/nixos/manual/index.html#ch-installation). Look there for more information.
|
||||||
|
|
||||||
|
1. Obtain latest NixOS. For example:
|
||||||
|
|
||||||
|
```
|
||||||
|
wget https://releases.nixos.org/nixos/18.09/nixos-18.09.2257.235487585ed/nixos-graphical-18.09.2257.235487585ed-x86_64-linux.iso
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Write NixOS iso to install media (USB/CD). For example:
|
||||||
|
|
||||||
|
```
|
||||||
|
dd if=nixos-graphical-18.09.2257.235487585ed-x86_64-linux.iso of=/dev/sdX
|
||||||
|
```
|
||||||
|
Replace /dev/sdX with the correct device name. You can find this using `sudo fdisk -l`
|
||||||
|
|
||||||
|
3. Boot the system
|
||||||
|
|
||||||
|
You will have to find out if your hardware uses UEFI or Legacy Boot for the next step.
|
||||||
|
|
||||||
|
4. Option 1: Partition and format for UEFI
|
||||||
|
|
||||||
|
```
|
||||||
|
parted /dev/sda -- mklabel gpt
|
||||||
|
parted /dev/sda -- mkpart primary 512MiB -8GiB
|
||||||
|
parted /dev/sda -- mkpart primary linux-swap -8GiB 100%
|
||||||
|
parted /dev/sda -- mkpart ESP fat32 1MiB 512MiB
|
||||||
|
parted /dev/sda -- set 3 boot on
|
||||||
|
mkfs.ext4 -L nixos /dev/sda1
|
||||||
|
mkswap -L swap /dev/sda2
|
||||||
|
mkfs.fat -F 32 -n boot /dev/sda3
|
||||||
|
mount /dev/disk/by-label/nixos /mnt
|
||||||
|
mkdir -p /mnt/boot
|
||||||
|
mount /dev/disk/by-label/boot /mnt/boot
|
||||||
|
swapon /dev/sda2
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Option 2: Partition and format for Legacy Boot (MBR)
|
||||||
|
|
||||||
|
```
|
||||||
|
parted /dev/sda -- mklabel msdos
|
||||||
|
parted /dev/sda -- mkpart primary 1MiB -8GiB
|
||||||
|
parted /dev/sda -- mkpart primary linux-swap -8GiB 100%
|
||||||
|
mkfs.ext4 -L nixos /dev/sda1
|
||||||
|
mkswap -L swap /dev/sda2
|
||||||
|
mount /dev/disk/by-label/nixos /mnt
|
||||||
|
swapon /dev/sda2
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Generate NixOS config
|
||||||
|
|
||||||
|
```
|
||||||
|
nixos-generate-config --root /mnt
|
||||||
|
nano /mnt/etc/nixos/configuration.nix
|
||||||
|
```
|
||||||
|
|
||||||
|
Option 1: Edit NixOS configuration for UEFI
|
||||||
|
|
||||||
|
```
|
||||||
|
{ config, pkgs, ... }: {
|
||||||
|
imports = [
|
||||||
|
# Include the results of the hardware scan.
|
||||||
|
./hardware-configuration.nix
|
||||||
|
];
|
||||||
|
|
||||||
|
boot.loader.systemd-boot.enable = true;
|
||||||
|
|
||||||
|
# Note: setting fileSystems is generally not
|
||||||
|
# necessary, since nixos-generate-config figures them out
|
||||||
|
# automatically in hardware-configuration.nix.
|
||||||
|
#fileSystems."/".device = "/dev/disk/by-label/nixos";
|
||||||
|
|
||||||
|
# Enable the OpenSSH server.
|
||||||
|
services.openssh = {
|
||||||
|
enable = true;
|
||||||
|
permitRootLogin = "yes";
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Option 2: Edit NixOS configuration for Legacy Boot (MBR)
|
||||||
|
|
||||||
|
```
|
||||||
|
{ config, pkgs, ... }: {
|
||||||
|
imports = [
|
||||||
|
# Include the results of the hardware scan.
|
||||||
|
./hardware-configuration.nix
|
||||||
|
];
|
||||||
|
|
||||||
|
boot.loader.grub.device = "/dev/sda";
|
||||||
|
|
||||||
|
# Note: setting fileSystems is generally not
|
||||||
|
# necessary, since nixos-generate-config figures them out
|
||||||
|
# automatically in hardware-configuration.nix.
|
||||||
|
#fileSystems."/".device = "/dev/disk/by-label/nixos";
|
||||||
|
|
||||||
|
# Enable the OpenSSH server.
|
||||||
|
services.openssh = {
|
||||||
|
enable = true;
|
||||||
|
permitRootLogin = "yes";
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
6. Do the installation
|
||||||
|
|
||||||
|
```
|
||||||
|
nixos-install
|
||||||
|
```
|
||||||
|
Set root password
|
||||||
|
```
|
||||||
|
setting root password...
|
||||||
|
Enter new UNIX password:
|
||||||
|
Retype new UNIX password:
|
||||||
|
```
|
||||||
|
|
||||||
|
7. If everything went well
|
||||||
|
|
||||||
|
```
|
||||||
|
reboot
|
||||||
|
```
|
||||||
|
|
||||||
|
## 2. nix-bitcoin installation
|
||||||
|
|
||||||
|
On the machine you are deploying from:
|
||||||
|
|
||||||
|
1. Install Dependencies (Debian 9 stretch)
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo apt-get install curl git gnupg2 dirmngr
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Install Latest Nix with GPG Verification
|
||||||
|
|
||||||
|
```
|
||||||
|
curl -o install-nix-2.1.3 https://nixos.org/nix/install
|
||||||
|
curl -o install-nix-2.1.3.sig https://nixos.org/nix/install.sig
|
||||||
|
gpg2 --recv-keys B541D55301270E0BCF15CA5D8170B4726D7198DE
|
||||||
|
gpg2 --verify ./install-nix-2.1.3.sig
|
||||||
|
sh ./install-nix-2.1.3
|
||||||
|
. /home/user/.nix-profile/etc/profile.d/nix.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Clone this project
|
||||||
|
|
||||||
|
```
|
||||||
|
cd
|
||||||
|
git clone https://github.com/jonasnick/nix-bitcoin
|
||||||
|
cd ~/nix-bitcoin
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Create network file
|
||||||
|
|
||||||
|
```
|
||||||
|
nano network-nixos.nix
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
bitcoin-node =
|
||||||
|
{ config, pkgs, ... }:
|
||||||
|
{ deployment.targetHost = 1.2.3.4;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace 1.2.3.4 with NixOS machine's IP address.
|
||||||
|
|
||||||
|
5. Edit `configuration.nix`
|
||||||
|
|
||||||
|
```
|
||||||
|
nano configuration.nix
|
||||||
|
```
|
||||||
|
|
||||||
|
Uncomment `./hardware-configuration.nix` line by removing #.
|
||||||
|
|
||||||
|
6. Create `hardware-configuration.nix`
|
||||||
|
|
||||||
|
```
|
||||||
|
nano hardware-configuration.nix
|
||||||
|
```
|
||||||
|
Copy contents of NixOS machine's `hardware-configuration.nix` to file.
|
||||||
|
|
||||||
|
7. Add boot option to `hardware-configuration.nix`
|
||||||
|
|
||||||
|
Option 1: Enable systemd boot for UEFI
|
||||||
|
```
|
||||||
|
boot.loader.grub.device = "/dev/sda";
|
||||||
|
```
|
||||||
|
Option 2: Set grub device for Legacy Boot (MBR)
|
||||||
|
```
|
||||||
|
boot.loader.grub.device = "/dev/sda":
|
||||||
|
```
|
||||||
|
|
||||||
|
8. Setup environment
|
||||||
|
```
|
||||||
|
nix-shell
|
||||||
|
```
|
||||||
|
|
||||||
|
9. Create nixops deployment in nix-shell.
|
||||||
|
```
|
||||||
|
nixops create network.nix network-nixos.nix -d bitcoin-node
|
||||||
|
```
|
||||||
|
|
||||||
|
10. Adjust configuration by opening configuration.nix and removing FIXMEs.
|
||||||
|
|
||||||
|
11. Deploy Nixops in nix-shell
|
||||||
|
|
||||||
|
```
|
||||||
|
nixops deploy -d bitcoin-node
|
||||||
|
```
|
||||||
|
This will now create a nix-bitcoin node on the target machine.
|
||||||
|
|
||||||
|
12. Nixops automatically creates an ssh key for use with `nixops ssh`. Access `bitcoin-node` through ssh in nix-shell with
|
||||||
|
|
||||||
|
```
|
||||||
|
nixops ssh operator@bitcoin-node
|
||||||
|
```
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user