Skip to content

Commit 733ca7b

Browse files
committed
reformat with prettier
1 parent 15df821 commit 733ca7b

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
<img src="https://raw.githubusercontent.com/numtide/nixos-anywhere/5bdd3f3c442b923813e301b319290305353a3e7a/docs/logo.png" width="256" height="256">
44

5-
nixos-anywhere (formally known as nixos-remote) makes it possible to install nixos from Linux machines reachable via ssh.
6-
Under the hood uses a [kexec image](https://github.com/nix-community/nixos-images#kexec-tarballs) to boot
7-
into a NixOS installer from a running Linux system.
8-
It then uses [disko](https://github.com/nix-community/disko) to partition and
9-
format the disks on the target system before it installs the user provided nixos
5+
nixos-anywhere (formally known as nixos-remote) makes it possible to install
6+
nixos from Linux machines reachable via ssh. Under the hood uses a
7+
[kexec image](https://github.com/nix-community/nixos-images#kexec-tarballs) to
8+
boot into a NixOS installer from a running Linux system. It then uses
9+
[disko](https://github.com/nix-community/disko) to partition and format the
10+
disks on the target system before it installs the user provided nixos
1011
configuration.
1112

1213
## Requirements
@@ -20,16 +21,21 @@ If your system is not booted into a nixos installer than the following
2021
requirements apply for kexec to succeed:
2122

2223
- x86_64 Linux system with kexec support (most x86_64 machine do have kexec
23-
support) or you have to provide your own [image](https://github.com/numtide/nixos-anywhere#using-your-own-kexec-image)
24+
support) or you have to provide your own
25+
[image](https://github.com/numtide/nixos-anywhere#using-your-own-kexec-image)
2426
- At least 2.5GB RAM (swap does not count). If you do not have enough RAM you
2527
will see failures unpacking the initrd), this is because kexec needs to load
2628
the whole nixos into memory.
2729

2830
## Usage
29-
Needs a repo with your configurations with flakes. For a minimal example checkout https://github.com/numtide/nixos-anywhere-examples.
3031

31-
Your NixOS configuration will also need a [disko](https://github.com/nix-community/disko) configuration as we can see in
32-
our [example](https://github.com/numtide/nixos-anywhere-examples/blob/9768e438b1467ec55d42e096860e7199bd1ef43d/flake.nix#L15-L19)
32+
Needs a repo with your configurations with flakes. For a minimal example
33+
checkout https://github.com/numtide/nixos-anywhere-examples.
34+
35+
Your NixOS configuration will also need a
36+
[disko](https://github.com/nix-community/disko) configuration as we can see in
37+
our
38+
[example](https://github.com/numtide/nixos-anywhere-examples/blob/9768e438b1467ec55d42e096860e7199bd1ef43d/flake.nix#L15-L19)
3339

3440
Afterwards you can just run:
3541

@@ -41,7 +47,8 @@ The parameter passed to `--flake` should point to your nixos configuration
4147
exposed in your flake (`nixosConfigurations.your-system` in the example above).
4248

4349
`nixos-anywhere --help`
44-
``` shell
50+
51+
```shell
4552
Usage: nixos-anywhere [options] ssh-host
4653

4754
Options:
@@ -76,21 +83,23 @@ Options:
7683
7784
## Using your own kexec image
7885
79-
By default `nixos-anywhere` will download the kexec image from [here](https://github.com/nix-community/nixos-images#kexec-tarballs).
80-
It is also possible to provide your own by providing a file to `--kexec`. The image will than uploaded prior to executing.
86+
By default `nixos-anywhere` will download the kexec image from
87+
[here](https://github.com/nix-community/nixos-images#kexec-tarballs). It is also
88+
possible to provide your own by providing a file to `--kexec`. The image will
89+
than uploaded prior to executing.
8190
82-
``` shell
91+
```shell
8392
nixos-anywhere \
8493
--kexec "$(nix build --print-out-paths github:nix-community/nixos-images#packages.x86_64-linux.kexec-installer-nixos-unstable)/nixos-kexec-installer-x86_64-linux.tar.gz" \
8594
--flake 'github:your-user/your-repo#your-system' \
8695
root@yourip
8796
```
8897
8998
`--kexec` can be useful for example for aarch64-linux, where there is no
90-
pre-build image. The following example assumes that your local machine can
91-
build for aarch64-linux either natively or through a remote builder
99+
pre-build image. The following example assumes that your local machine can build
100+
for aarch64-linux either natively or through a remote builder
92101
93-
``` shell
102+
```shell
94103
nixos-anywhere \
95104
--kexec "$(nix build --print-out-paths github:nix-community/nixos-images#packages.aarch64-linux.kexec-installer-nixos-unstable)/nixos-kexec-installer-aarch64-linux.tar.gz" \
96105
--flake 'your-flake#your-system' \

0 commit comments

Comments
 (0)