readme stuff

perryflynn · Apr 28, 2024 · e5cd785 · e5cd785
1 parent 4850afc
commit e5cd785
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -8,11 +8,13 @@ This project installs and configures Arch Linux or Debian operating systems full
 
 Features:
 
-- Uses `ansible-pull` for apply configurations by hostname
-- Build the installer ISO image
-- Install a minimal Arch Linux OS
-- Install a minimal Debian OS
-- Configure the Arch Linux OS with a graphical environment
+- 💿 Build the installer ISO image in a Docker environment
+- 💡 Read hostname and OS type from UEFI variables
+- 🔨 Install a minimal Arch Linux OS or Debian OS
+- ❓ Decide target disk for installation, etc by hostname
+- 🔐 Setup root password, SSH keys and user accounts
+- 🚀 Autostart OS configuration at first boot
+- 💻 Autostart Desktop configuration at first Desktop logon
 
 ## archiso
 
@@ -30,7 +32,7 @@ correct ansible inventory variables.
 Set hostname in UEFI variable:
 
 ```sh
-echo -n wuseldusel > efi-hostname
+echo -n myhostname > efi-hostname
 efivar --name ed38a5bf-1135-4b0f-aa72-49d30b05dfd4-PerryHostname -w -f efi-hostname
 ```
 
@@ -40,6 +42,9 @@ Get the hostname from UEFI variable:
 cat /sys/firmware/efi/efivars/PerryHostname-ed38a5bf-1135-4b0f-aa72-49d30b05dfd4
 ```
 
+In addition the variable `PerryFlavor-ed38a5bf-1135-4b0f-aa72-49d30b05dfd4` can be used to
+set the flavor (`debian` or `archlinux`).
+
 ## How to install a OS
 
 - Build the Arch Linux ISO image
@@ -58,5 +63,13 @@ It pulls automatically the correct playbook from this repo by the hostname of th
 
 ## TODO
 
+- [x] Bluetooth
+- [x] NetworkManager
+- [x] NFTables
+- [x] Pulseaudio
 - [x] Swap File
+- [x] Unix Account
+- [x] X11
+- [x] XFCE
+- [ ] SSH Daemon config
 - [ ] Disk Encryption
diff --git a/roles/bluetoothsetup/README.md b/roles/bluetoothsetup/README.md
@@ -0,0 +1,3 @@
+# bluetoothsetup
+
+Installs and configures bluetooth daemon and programs.
diff --git a/roles/networkmanagersetup/README.md b/roles/networkmanagersetup/README.md
@@ -0,0 +1,3 @@
+# networkmanagersetup
+
+Installs and configures networkmanager daemon and programs.
diff --git a/roles/nftablesrules/README.md b/roles/nftablesrules/README.md
@@ -0,0 +1,3 @@
+# nftablesrules
+
+Installs nftables with a basic port-based whitelist firewall ruleset.
diff --git a/roles/swapfilesetup/README.md b/roles/swapfilesetup/README.md
@@ -0,0 +1,3 @@
+# swapfilesetup
+
+Creates and configures a swapfile on the root partition.
diff --git a/roles/useraccount/README.md b/roles/useraccount/README.md
@@ -0,0 +1,5 @@
+# useraccount
+
+Creates a unix account with sudo permissions.
+
+Returns infos about the account as facts.
diff --git a/roles/xfceconfig/README.md b/roles/xfceconfig/README.md
@@ -0,0 +1,3 @@
+# xfceconfig
+
+Apply configuration to XFCE.
diff --git a/roles/xfcestatus/README.md b/roles/xfcestatus/README.md
@@ -0,0 +1,3 @@
+# xfcestatus
+
+Detects if a xfce is running and exposes it's status as facts.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# bluetoothsetup

		Installs and configures bluetooth daemon and programs.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# networkmanagersetup

		Installs and configures networkmanager daemon and programs.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# nftablesrules

		Installs nftables with a basic port-based whitelist firewall ruleset.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# swapfilesetup

		Creates and configures a swapfile on the root partition.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# xfcestatus

		Detects if a xfce is running and exposes it's status as facts.