aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authormakefu <github@syntax-fehler.de>2018-09-11 20:42:55 +0200
committermakefu <github@syntax-fehler.de>2018-09-11 20:42:55 +0200
commita16b5dfe64929131984e79df9a1825f0413b1865 (patch)
tree46988654b2448da77a05b4188bc0f719df2d5e81 /README.md
parent88f56a0b644dd7bfa8438409bea5377adef6aef4 (diff)
add README,stand-alone example
Diffstat (limited to 'README.md')
-rw-r--r--README.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..70058f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,71 @@
+disko
+=====
+
+nix-powered automatic disk partitioning
+
+Usage
+=====
+
+Master Boot Record
+------------------
+This is how your iso configuation may look like
+
+```nix
+{ pkgs, ... }:
+let
+ disko = (builtins.fetchGit {
+ url = https://cgit.lassul.us/disko/;
+ rev = "88f56a0b644dd7bfa8438409bea5377adef6aef4";
+ }) + "/lib";
+ cfg = builtins.fromJSON ./tsp-disk.json;
+in {
+ imports = [
+ <nixpkgs/nixos/modules/installer/cd-dvd/installation-cd-minimal.nix>
+ ];
+ environment.systemPackages = with pkgs;[
+ (pkgs.writeScriptBin "tsp-create" (disko.mount 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": "/"
+ }
+ }
+ ]
+ }
+ }
+}
+```
+
+GUID Partition Table, LVM and dm-crypt
+--------------------------------------
+See `examples/`