Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/instantos/instantnix
instantOS tools packaged for the Nix package manager (and NixOS)
https://github.com/instantos/instantnix
instantos nix nixpkgs nur
Last synced: 4 months ago
JSON representation
instantOS tools packaged for the Nix package manager (and NixOS)
- Host: GitHub
- URL: https://github.com/instantos/instantnix
- Owner: instantOS
- License: mit
- Created: 2020-07-09T12:07:05.000Z (over 4 years ago)
- Default Branch: dev
- Last Pushed: 2024-01-11T16:23:54.000Z (about 1 year ago)
- Last Synced: 2024-04-14T09:58:45.672Z (10 months ago)
- Topics: instantos, nix, nixpkgs, nur
- Language: Nix
- Homepage:
- Size: 510 KB
- Stars: 30
- Watchers: 4
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Currently, instantNIX is [not actively maintained](https://github.com/instantOS/instantNIX/issues/32) and based on an outdated version of [nixpkgs](https://github.com/NixOS/nixpkgs).
Pull-requests, however, are welcome and likely to be reviewed.**
instantNIX
instantOS port to Nix
-------
[](https://github.com/instantOS/instantNIX/actions/workflows/ci.yml)
[](https://instantos.cachix.org)
[InstantOS](https://instantos.github.io/) window manager and tools packaged for Nix and NixOS.
[Nix](https://nixos.org/explore.html) is your friendly, reproducible package manager and build tool for the experienced user.
Nix, and therefore **instantNIX,** too, works on most Linux distributions and some versions of macOS.
[](http://www.youtube.com/watch?v=zqcEv3bdIAM)
**InstantNix** is a sub-repository to the [Nix User Repository (NUR)](https://github.com/nix-community/NUR),
a community-maintained meta-repository.
InstantNIX is **not** part of [Nixpkgs](https://github.com/nixos/nixpkgs) (yet).
Please note, that our parent project instantOS is still in beta phase,
and we are even more so.
We also struggle to keep things anywhere near up to date.
Not everything will work out of the box and some extra setup might be required.
That being said, we've never had a change that broke startup and basic functionality.
Knock on wood!
Nix itself is not for the faint of heart or people adverse to tinkering and learning
or those who are hard-pressed for time.
Do not expect a polished, well-kept end-product.
We will strive to get InstantNIX into [Nixpkgs](https://github.com/nixos/nixpkgs),
the official Nix package repository, soon after instantOS releases its version 1.0.
Then, NUR-acrobatics will no longer be required.
# Usage
Detailed instructions on how to install and use instantOS tools with Nix or
on NixOS can be found in the [instantNix Wiki](https://github.com/instantOS/instantNIX/wiki).
We even have a section on [Installing instantNIX on a Raspberry Pi](https://github.com/instantOS/instantNIX/wiki/instantNIX-on-a-Raspberry-Pi-4B).
In this Readme we only give you a very quick overview.
Currently, there are two approaches:
- cloning the repo
- installing from the Nix User Repository (NUR)
In both cases, first [install Nix](https://nixos.org/nix/manual/#chap-installation)
on your system if not already installed:
```console
curl -L https://nixos.org/nix/install | sh
```
Currently, you will have the least manual configuration to do if you use NixOS as a base
(the Nix universal package manager and build system works on many Linux Distributions and MacOS).
# Installation from Clone
Clone this repository and change directory into it.
From there, run:
```nix
nix-env -iA instantnix -f default.nix --arg pkgs 'import {}'
```
The last part, starting at "`--arg`" is recommended.
It causes the build to run from your version of
[nixpkgs](https://github.com/nixos/nixpkgs)
rather than the fixed commit of the last tagged stable version,
which can be up to six month old.
After installation, you can run `instantwm`,
just as you would run [dwm](https://dwm.suckless.org) on your system.
For many people that means putting `startinstantos` in your `~/.xinitrc`.
See an example in `./utils/xinitrc`.
Some related resources:
- [dwm on ubuntu](https://cannibalcandy.wordpress.com/2012/04/26/installing-and-configuring-dwm-under-ubuntu/)
- [dwm on lightdm](https://blkct.wordpress.com/2017/06/16/how-to-start-dwm-from-lightdm/)
Note: Some additional configuration steps such as installing optional software
or setting the correct UID for instantLOCK might be required for everything to
work.
Permissions are an issue on some systems.
# Installation via NUR
Accessing NUR can be done easily.
Just add the following to `~/.config/nixpkgs/config.nix`:
```nix
{
packageOverrides = pkgs: {
# For nixos' `configuration.nix`, replace above line by:
#nixpkgs.config.packageOverrides = pkgs: {
nur = import (builtins.fetchTarball "https://github.com/nix-community/NUR/archive/master.tar.gz") {
inherit pkgs;
};
};
}
```
Then you can add `nur.repos.instantos.PACKAGE_NAME` to your `configuration.nix`
or install **InstantOs** packages via:
```console
$ nix-env -f '' -iA nur.repos.instantos.PACKAGE_NAME # "nur.repos.instantos.instantnix" for all the instantOS packages
```
# Faster installation with cachix
You may want to install cachix and take advantage of the build artefact caching with:
```console
$ nix-env -iA cachix -f https://cachix.org/api/v1/install
$ cachix use instantos
```
That way Nix does not compile as much from source and rather uses pre-compiled
packages from [cachix](https://cachix.org).