Skip to content

Commit 3e02128

Browse files
Update Developer Guide with CRYPTROOT_AUTOUNLOCK info (#836)
* Update Developer Guide with CRYPTROOT_AUTOUNLOCK info Added note about CRYPTROOT_AUTOUNLOCK storing the encryption key. * Update docs/Developer-Guide_Build-Switches.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent d918a4f commit 3e02128

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/Developer-Guide_Build-Switches.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ LUKS (Linux Unified Key Setup) is a specification for block device encryption. I
208208

209209
```title="When enabled, you need to provide additional information:"
210210
CRYPTROOT_PASSPHRASE="MYSECRECTPASS" # Mandatory
211+
CRYPTROOT_AUTOUNLOCK="yes" # Default: no. If set to yes you can omit CRYPTROOT_PASSPHRASE to do unattended unlocking
211212
CRYPTROOT_SSH_UNLOCK="yes" # Default: yes
212213
CRYPTROOT_SSH_UNLOCK_PORT="2222" # Default: 2022
213214
CRYPTROOT_MAPPER=armbian-root` # Default: armbian-root
@@ -221,6 +222,7 @@ CRYPTROOT_PARAMETERS="custom cryptsetup options" # Default: --pbkdf pbkdf2
221222
- This function might not work well with all distributions.
222223
- CRYPTROOT_MAPPER name might affect parallel image building
223224
- CRYPTROOT_PARAMETERS may not contain `=`; separate switches with spaces
225+
- CRYPTROOT_AUTOUNLOCK stores encryption key in the /etc/rootfs.key
224226

225227
<hr>
226228

0 commit comments

Comments
 (0)