xmnt/README.md

34 lines
794 B
Markdown
Raw Normal View History

2022-10-07 02:39:35 +09:00
# xMnt
2022-10-07 02:41:53 +09:00
A tool for mounting encrypted partitions.
2022-10-07 02:39:35 +09:00
## Use case
I have encrypted partitions that I need to mount them from time to time.
I use GPG to encrypt the decryption keys for each partition, save them as `${uuid}.key`
2022-10-07 02:41:53 +09:00
With this tool, I can mount and unmount them with one command.
2022-10-07 02:39:35 +09:00
## Usage
2022-10-07 02:41:53 +09:00
Presets are stored in `$XDG_CONFIG_HOME/xmnt/presets`.
2022-10-07 02:39:35 +09:00
For example, save the following content as `boot.yml` in the presets directory:
```yaml
type: blk
path: /dev/nvme0n1p2
mountpoint: /boot
```
Then when you run `xmnt boot`, the tool will decrypt `/dev/nvme0n1p2` and mount it on `/boot`.
You can also use it without defining presets. See `--help` for detailed usage.
## Supported partition types
- luks encrypted partitions (e.g. ext4)
- regular unencrypted partitions
- zfs datasets