Merge pull request #4 from Mic92/docs

Improve documentation
This commit is contained in:
Lassulus 2019-09-16 12:51:00 +02:00 committed by GitHub
commit 1af856886e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -10,6 +10,31 @@ Master Boot Record
------------------
This is how your iso configuation may look like
/etc/nixos/tsp-disk.json (TODO: find the correct disk)
```json
{
"type": "devices",
"content": {
"sda": {
"type": "table",
"format": "msdos",
"partitions": [{
"type": "partition",
"start": "1M",
"end": "100%",
"bootable": true,
"content": {
"type": "filesystem",
"format": "ext4",
"mountpoint": "/"
}
}]
}
}
}
```
/etc/nixos/configuration.nix
```nix
{ pkgs, ... }:
let
@ -23,49 +48,31 @@ in {
<nixpkgs/nixos/modules/installer/cd-dvd/installation-cd-minimal.nix>
];
environment.systemPackages = with pkgs;[
(pkgs.writeScriptBin "tsp-create" (disko.mount cfg))
(pkgs.writeScriptBin "tsp-create" (disko.create cfg))
(pkgs.writeScriptBin "tsp-mount" (disko.mount cfg))
];
# Optional: Automatically creates a service which runs at startup to perform the partitioning
systemd.services.install-to-hd = {
enable = true;
wantedBy = ["multi-user.target"];
after = ["getty@tty1.service" ];
serviceConfig = {
Type = "oneshot";
ExecStart = [ (disko.create cfg) (disk.mount cfg) ];
StandardInput = "null";
StandardOutput = "journal+console";
StandardError = "inherit";
};
};
}
```
tsp-disk.json (TODO: find the correct disk)
```json
{
"type": "devices",
"content": {
"sda": {
"type": "table",
"format": "msdos",
"partitions": [
{ "type": "partition",
"start": "1M",
"end": "100%",
"bootable": true,
"content": {
"type": "filesystem",
"format": "ext4",
"mountpoint": "/"
}
}
]
}
}
## Optional: Automatically creates a service which runs at startup to perform the partitioning
#systemd.services.install-to-hd = {
# enable = true;
# wantedBy = ["multi-user.target"];
# after = ["getty@tty1.service" ];
# serviceConfig = {
# Type = "oneshot";
# ExecStart = [ (disko.create cfg) (disk.mount cfg) ];
# StandardInput = "null";
# StandardOutput = "journal+console";
# StandardError = "inherit";
# };
#};
}
```
After `nixos-rebuild switch` this will add a `tsp-create` and a `tsp-mount`
command:
- **tsp-create**: creates & formats the partitions according to `tsp-disk.json`
- **tsp-mount**: mounts the partitions to `/mnt`
GUID Partition Table, LVM and dm-crypt
--------------------------------------
See `examples/`