feat: build instructions and example
This commit is contained in:
parent
0af8ac86b9
commit
304f412950
5 changed files with 54 additions and 1 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1,4 +1,6 @@
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
*.qcow2
|
||||||
|
result
|
||||||
node_modules
|
node_modules
|
||||||
cache
|
cache
|
||||||
dist
|
dist
|
||||||
|
|
|
@ -36,7 +36,7 @@ export default defineConfig({
|
||||||
{
|
{
|
||||||
text: 'Getting started',
|
text: 'Getting started',
|
||||||
items: [
|
items: [
|
||||||
{ text: 'Generate configuration', link: '/generate' },
|
{ text: 'Local installation', link: '/installation' },
|
||||||
{ text: 'Build virtual machine', link: '/build-virtual-machine' },
|
{ text: 'Build virtual machine', link: '/build-virtual-machine' },
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
10
build-virtual-machine.md
Normal file
10
build-virtual-machine.md
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
# Build a virtual machine based on your generated configurations
|
||||||
|
|
||||||
|
Your Nix configurations are located in the `inventory` folder you can build and run the configuration file you want by running from the NixiN root folder, for example for the demo configuration file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
nix-build '<nixpkgs/nixos>' -A vm -I nixpkgs=channel:nixos-24.05 -I nixos-config=./inventory/demo-configuration.nix
|
||||||
|
./result/bin/run-nixos-vm
|
||||||
|
|
||||||
|
```
|
||||||
|
|
23
installation.md
Normal file
23
installation.md
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
# Installation
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
For now, the NixiN installation process was just tested on a Linux distribution, on a computer with virtualisation capacities.
|
||||||
|
So only requirements are :
|
||||||
|
|
||||||
|
- A Linux system with virtualisation support
|
||||||
|
- With Nix installed <https://nix.dev/manual/nix/stable/installation/installation.html>
|
||||||
|
|
||||||
|
## Grab the code and run locally
|
||||||
|
|
||||||
|
Get the latest version from the official repository
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.distrilab.fr/NixiN/nixin-web
|
||||||
|
```
|
||||||
|
|
||||||
|
Go in the main folder and run the `shell.nix` to install dependencies
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd nixin-web && nix-shell
|
||||||
|
```
|
18
inventory/demo-configuration.nix
Normal file
18
inventory/demo-configuration.nix
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
{ config, pkgs, ... }:
|
||||||
|
{
|
||||||
|
boot.loader.systemd-boot.enable = true;
|
||||||
|
boot.loader.efi.canTouchEfiVariables = true;
|
||||||
|
|
||||||
|
services.xserver.enable = true;
|
||||||
|
|
||||||
|
services.xserver.displayManager.gdm.enable = true;
|
||||||
|
services.xserver.desktopManager.gnome.enable = true;
|
||||||
|
|
||||||
|
users.users.alice = {
|
||||||
|
isNormalUser = true;
|
||||||
|
extraGroups = [ "wheel" ];
|
||||||
|
initialPassword = "test";
|
||||||
|
};
|
||||||
|
|
||||||
|
system.stateVersion = "24.05";
|
||||||
|
}
|
Loading…
Reference in a new issue