this repo has no description
docs: update description
+20
-11
+20
-11
README.md
+20
-11
README.md
···
1
1
# Nixie
2
2
3
-
> [!CAUTION]
4
-
> This project is still a work in progress and will not be ready for use until
5
-
> most of the [features](#features) below are completed.
3
+
Open-source bare metal provisioning engine for NixOS. Nixie enables zero-touch
4
+
deployment of NixOS to multiple machines over the network, turning blank hard
5
+
drives into fully configured systems in minutes.
6
+
7
+
> [!WARNING]
8
+
> Basic [features](#features) are functional and you can try them out, but some
9
+
> parts are still missing and there are known issues.
6
10
7
-
Easy NixOS PXE boot install.
11
+
Nixie is a simpler, stateless alternative to [Foreman](https://theforeman.org),
12
+
[MAAS](https://canonical.com/maas), [OpenStack
13
+
Ironic](https://docs.openstack.org/ironic),
14
+
[Tinkerbell](https://tinkerbell.org), etc., focusing on NixOS deployments on
15
+
bare metal (though it can also be used in virtualized environments).
8
16
9
17
## Features
10
18
···
18
26
- [ ] Host status check with IP discovery
19
27
- [x] Stateless and ephemeral [^1]
20
28
- [x] Fast, under 2 minutes to install NixOS from empty hard drives [^2]
29
+
- [ ] Support IPv6 single-stack
21
30
22
31
[^1]: No pre-configured PXE server is required to install other machines - you
23
32
only need to run Nixie on your laptop or workstation. This solves the
···
107
116
108
117
## Acknowledgements
109
118
110
-
This project is a rewrite of my previous ephemeral PXE server implementation in
111
-
my [khuedoan/homelab](https://github.com/khuedoan/homelab) repository, which
112
-
used a stateless PXE server in Docker with Ansible templating and targeted
113
-
generic Linux distributions. It has been rebuilt from the ground up for NixOS,
114
-
offering a more integrated and robust experience in this project. All credits
115
-
from the previous implementation are also referenced here, as similar knowledge
116
-
and concepts apply.
119
+
> This project is a rewrite of my previous ephemeral PXE server implementation
120
+
> in my [khuedoan/homelab](https://github.com/khuedoan/homelab) repository,
121
+
> which used a stateless PXE server in Docker with Ansible templating and
122
+
> targeted generic Linux distributions. It has been rebuilt from the ground up
123
+
> for NixOS, offering a more integrated and robust experience in this project.
124
+
> All credits from the previous implementation are also referenced here, as
125
+
> similar knowledge and concepts apply.
117
126
118
127
- Ephemeral PXE server [^1] inspired by [Minimal First Machine in the DC](https://speakerdeck.com/amcguign/minimal-first-machine-in-the-dc)
119
128
- [NixOS netboot with pixiecore](https://nixos.wiki/wiki/Netboot)