diff options
| author | Craig Jennings <c@cjennings.net> | 2026-02-23 06:08:43 -0600 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-02-23 06:08:43 -0600 |
| commit | 4811ced2c222db1e80dbd3594f6e2bb50ed7218b (patch) | |
| tree | 800cbdc4c2bb595633e7fcb9cc398c5c6b72d47a | |
| parent | dcab77f58bc0d7eb6dc79d8fda97cb08a1894411 (diff) | |
| download | archangel-4811ced2c222db1e80dbd3594f6e2bb50ed7218b.tar.gz archangel-4811ced2c222db1e80dbd3594f6e2bb50ed7218b.zip | |
docs: update archangel.conf.example for btrfs support
Remove outdated "btrfs coming soon" note, add LUKS_PASSPHRASE option
for btrfs installs, and simplify encryption skip documentation to
cover both filesystem types.
| -rw-r--r-- | custom/archangel.conf.example | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/custom/archangel.conf.example b/custom/archangel.conf.example index dacf340..c3c1877 100644 --- a/custom/archangel.conf.example +++ b/custom/archangel.conf.example @@ -5,6 +5,7 @@ # # Required fields: HOSTNAME, TIMEZONE, DISKS, ROOT_PASSWORD # For ZFS: also need ZFS_PASSPHRASE or NO_ENCRYPT=yes +# For Btrfs: also need LUKS_PASSPHRASE or NO_ENCRYPT=yes # All other fields have sensible defaults. ############################# @@ -13,7 +14,6 @@ # Filesystem type (optional, default: zfs) # Options: zfs, btrfs -# Note: btrfs support coming soon FILESYSTEM=zfs ############################# @@ -52,16 +52,16 @@ RAID_LEVEL= # Security ############################# -# ZFS encryption passphrase (required unless NO_ENCRYPT=yes) +# ZFS encryption passphrase (required for ZFS unless NO_ENCRYPT=yes) # This will be required at every boot to unlock the pool ZFS_PASSPHRASE=changeme -# Skip ZFS encryption (optional, default: no) -# Set to "yes" to create an unencrypted pool -# Use cases: -# - VMs or test environments -# - Systems with hardware encryption (SED drives) -# - Data that doesn't require encryption +# LUKS encryption passphrase (required for Btrfs unless NO_ENCRYPT=yes) +# This will be required at every boot to unlock the disk +#LUKS_PASSPHRASE=changeme + +# Skip encryption (optional, default: no) +# Set to "yes" to skip ZFS native encryption or LUKS # WARNING: Without encryption, anyone with physical access can read your data #NO_ENCRYPT=no |