alex/crypt-mounts
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Alexandre CATTEAU 2023-07-27 16:31:59 +02:00
parent ee7849be8f
commit cc21a48a05
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -6,14 +6,17 @@ crypt-mounts' purpose is to reduce to one the commands needed to mount punctuall
One defines their mounts in `mounts.conf`, giving for each: One defines their mounts in `mounts.conf`, giving for each:
* the mapper name (usually defined in `/etc/crypttab`); * the mapper name (usually defined in `/etc/crypttab`);
* the mount target path; * the mount target path;
* the file system type;
* a friendly name for the mount (optional); * a friendly name for the mount (optional);
* a boolean for enabling auto-locking (i.e. closing encrypted volume when unmounted) or not. * a boolean for enabling auto-locking (i.e. closing encrypted volume when unmounted) or not;
* a boolean for enabling mount timeout (useful to prevent hanging at boot).
The install script then generates a Systemd mount file for each mount, with the required bindings. The install script then generates a Systemd mount file for each mount, with the required bindings.
### Files ### Files
* `template.mount` is a template for Systemd mount units. * `template.mount` is a template for Systemd mount units.
* `close-vault.conf.template` is a Systemd drop-in template, for auto-locking. * `close-vault.conf.template` is a Systemd drop-in template, for auto-locking.
* `timeout.conf` is a Systemd drop-in for mount timeout.
#### Installation #### Installation
* `mounts.conf.template` contains a mount definition example, and should be copied locally in `mounts.conf.d` * `mounts.conf.template` contains a mount definition example, and should be copied locally in `mounts.conf.d`
as `<something>.conf`, for each of your mounts. as `<something>.conf`, for each of your mounts.