kkyy
/
xmnt
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update readme

This commit is contained in:
Yiyang Kang 2022-10-07 02:25:07 +08:00
parent 7e5ba94235
commit 884ba3d82d
Signed by: kkyy
GPG Key ID: 80FD317ECAF06CC3
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -4,11 +4,11 @@ A tool for mounting encrypted partitions.
## Use case ## Use case
I have encrypted partitions that I need to mount them from time to time. I have encrypted partitions that I need to mount and unmount from time to time.
I use GPG to encrypt the decryption keys for each partition, save them as `${uuid}.key` I use GPG to encrypt the keys for each partition, save them as `${uuid}.key`
With this tool, I can mount and unmount them with one command. With this tool, I can mount and unmount these partitions with one command.
## Usage ## Usage
@ -22,12 +22,19 @@ path: /dev/nvme0n1p2
mountpoint: /boot mountpoint: /boot
``` ```
Then when you run `xmnt boot`, the tool will decrypt `/dev/nvme0n1p2` and mount it on `/boot`. Then when you run `xmnt boot`, the tool will look for encryption key according
to the UUID of `/dev/nvme0n1p2`, read the key, call `gpg --decrypt` to decrypt
the key when necessary, then use the key to open `/dev/nvme0n1p2`, and mount it
on `/boot`.
Directories for storing encryption keys are defined in
`$XDG_CONFIG_HOME/xmnt/xmnt.yml`. The tool will recursively search these
directories for keys.
You can also use it without defining presets. See `--help` for detailed usage. You can also use it without defining presets. See `--help` for detailed usage.
## Supported partition types ## Supported partition types
- luks encrypted partitions (e.g. ext4) - luks encrypted partitions (e.g. ext4). "plain" format is not supported.
- regular unencrypted partitions - regular unencrypted partitions
- zfs datasets - zfs datasets