lix-project/lix-installer
17
2
Fork 2
Code Issues 11 Code Review (Gerrit) Projects Activity
A fork of the Determinate Nix installer.
149 commits 1 branch 0 tags 2.1 MiB
Rust 88.6%
Nix 6.3%
Shell 3%
Xonsh 1.1%
PowerShell 0.5%
Other 0.5%
Go to file
Ana Hobden c39bf0a510
Flesh out docs and tidy up public API substantially (#67) 
* Make plans versioned

* Delint

* speeeeeeeeling

* remove file that was dead

* Flesh out docs and improve public API

* Speeling

* Fixups

* Fix doctests

* Do a better job with actionstate

* Add some more docs

* Fix doctest

* Make CLI stuff optional

* Touchup

* Speeling
2022-11-28 22:57:35 +00:00
.cargo Use process groups with tokio (also crate bump) (#63) 2022-11-25 08:02:00 -08:00
.github Attempt a cache (#54) 2022-11-16 21:08:42 +00:00
nix Prod at CI with a stick 2022-09-09 12:26:53 -07:00
src Flesh out docs and tidy up public API substantially (#67) 2022-11-28 22:57:35 +00:00
.envrc init 2022-09-02 16:04:02 -07:00
.gitignore Use process groups with tokio (also crate bump) (#63) 2022-11-25 08:02:00 -08:00
Cargo.lock Flesh out docs and tidy up public API substantially (#67) 2022-11-28 22:57:35 +00:00
Cargo.toml Flesh out docs and tidy up public API substantially (#67) 2022-11-28 22:57:35 +00:00
CODE_OF_CONDUCT.md Add some community files 2022-09-09 14:27:03 -07:00
CONTRIBUTING.md Add some community files 2022-09-09 14:27:03 -07:00
flake.lock Update flake/cargo deps (#56) 2022-11-16 21:11:14 +00:00
flake.nix Flesh out docs and tidy up public API substantially (#67) 2022-11-28 22:57:35 +00:00
LICENSE Add some community files 2022-09-09 14:27:03 -07:00
nix-install.sh Fixup lack of default param (#55) 2022-11-16 21:11:38 +00:00
README.md Better note in readme 2022-11-09 08:50:50 -08:00
rustfmt.toml Create all actions 2022-09-15 12:11:46 -07:00

README.md

Harmonic

Harmonic is pre-release and experimental. Don't run it on machines you care about.

Harmonic is an opinionated, experimental Nix installer.

Status

Harmonic is pre-release and experimental. It is not ready for you to use! Please don't use it on a machine you are not planning to obliterate!

Planned support:

  • Multi-user x86_64 Linux with systemd init
  • Multi-user aarch64 Linux with systemd init
  • Multi-user x86_64 MacOS
    • Note: User deletion is currently unimplemented, you need to use a user with a secure token and dscl . -delete /Users/_nixbuild* where * is each user number.
  • Multi-user aarch64 MacOS
    • Note: User deletion is currently unimplemented, you need to use a user with a secure token and dscl . -delete /Users/_nixbuild* where * is each user number.
  • Single-user x86_64 Linux with systemd init
  • Single-user aarch64 Linux with systemd init
  • Others...

Installation Differences

Differing from the current official Nix installer scripts:

  • Nix is installed with the nix-command and flakes features enabled in the nix.conf
  • Harmonic stores an installation receipt (for uninstalling) at /nix/receipt.json

Motivations

The current Nix installer scripts do an excellent job, however they are difficult to maintain. Subtle differences in the shell implementations, and certain characteristics of bash scripts make it difficult to make meaningful changes to the installer.

Our team wishes to experiment with the idea of an installer in a more structured language and see if this is a worthwhile alternative. Along the way, we are also exploring a few other ideas, such as:

  • offering users a chance to review an accurate, calculated install plan
  • keeping an installation receipt for uninstallation
  • offering users with a failing install the chance to revert
  • doing whatever tasks we can in parallel

So far, our explorations have been quite fruitful, so we wanted to share and keep exploring.

Building

Harmonic is pre-release and we do not provide binaries at this time.

Since you'll be using Harmonic to install Nix on systems without Nix, the default build is a static binary.

Build it on a system with Nix:

nix build github:determinatesystems/harmonic

Then copy the result/bin/harmonic to the machine you wish to run it on.

Running

Harmonic must be run as root, as it needs to alter the system and cannot elevate privileges without significant complexity.

Install Nix with default options:

# Linux
./harmonic install linux-multi

# Mac
./harmonic install darwin-multi

To observe verbose logging, either use harmonic -v, this tool also respects the RUST_LOG environment. (Eg RUST_LOG=harmonic=trace harmonic).

Harmonic supports many of the options the current official Nix installer scripts. Review harmonic --help for details.

Uninstalling

You can remove a Harmonic-installed Nix by running

./harmonic uninstall

If you're on Mac and trying to run this over SSH, ensure you enable root by running dsenableroot, running the uninstall, then running dsenableroot -d to disable root again.