Skip to content

Commit e29a100

Browse files
committed
imrpoved docs, bumped versions
Signed-off-by: Zen <[email protected]>
1 parent 784c968 commit e29a100

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

readme.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ The original goal of this project was to create an initramfs suitable for decryp
1212
* GPG encrypted LUKS keyfiles
1313
* LUKS with detatched headers
1414
* BTRFS subvolumes and RAID
15+
* Cryptsetup re-attempts and alternative unlock methods
16+
- Allows for late insertion of a smartcard
17+
- Can fail back to plain password entry
1518
* Key entry over serial
1619
* Automatic CPIO generation
1720

@@ -25,6 +28,14 @@ Once installed, either set the config file in `/etc/ugrd/config.toml`, or pass i
2528

2629
> Debug mode can be enabled with `-d` or verbose debugging with `-dd`
2730
31+
## Runtime usage
32+
33+
`ugrd` runs the `init` script generated in the build dir. In cases where `agetty` is needed, most of the work is done in `init_main.sh`.
34+
35+
If some portion of the script fails, it will generally drop to a bash shell, where you are expected to perform whatever tasks failed, then exit.
36+
37+
The script will resume after the `bash` statement you got shell access with, and if you performed the required action, the script will cotinue as normal.
38+
2839
## Output
2940

3041
Unless the `ugrd.base.cpio` module is included, an initramfs environment will be generated at `build_dir` which defaults to `/tmp/initramfs/`.

ugrd/crypto/cryptsetup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
__author__ = 'desultory'
22

3-
__version__ = '0.7.2'
3+
__version__ = '0.8.0'
44

55

66
CRYPTSETUP_PARAMETERS = ['key_type', 'partuuid', 'uuid', 'key_file', 'header_file', 'retries', 'key_command', 'reset_command', 'try_nokey']

ugrd/initramfs_generator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
__author__ = "desultory"
3-
__version__ = "0.7.6"
3+
__version__ = "0.7.7"
44

55
from tomllib import load
66
from pathlib import Path

0 commit comments

Comments
 (0)