configs: reword help documentation
This commit is contained in:
parent
f0ec460729
commit
4a7857af55
|
@ -1,11 +1,15 @@
|
||||||
help() {
|
help() {
|
||||||
cat <<EOF
|
cat <<EOF
|
||||||
|
|
||||||
Airgap Arch Linux with Keyfork is best used with a removable SD card to store
|
Airgap Arch Linux with Keyfork is best used with a removable SD card to store
|
||||||
shard files and other persistent media. After inserting an SD card, run:
|
shard files and other persistent media. After inserting an SD card, run the
|
||||||
|
following command to mount any unmounted SD cards and find any Shard files:
|
||||||
|
|
||||||
# discover-and-mount-sdcard
|
# discover-and-mount-sdcard
|
||||||
|
|
||||||
|
This guide will assume the discovered Shard file is listed as:
|
||||||
|
/media/mmcblk0p1/shards.pgp
|
||||||
|
If an alternative Shard file is found, that file should be used instead.
|
||||||
|
|
||||||
Keyfork can be used to set up a Shard-secured secret with an M-of-N scheme,
|
Keyfork can be used to set up a Shard-secured secret with an M-of-N scheme,
|
||||||
where M is the minimum amount of users required to recreate the secret and N is
|
where M is the minimum amount of users required to recreate the secret and N is
|
||||||
is the total amount of shardholders. An additional value, K, will be used to
|
is the total amount of shardholders. An additional value, K, will be used to
|
||||||
|
@ -24,15 +28,14 @@ Or
|
||||||
|
|
||||||
# keyfork recover remote-shard
|
# keyfork recover remote-shard
|
||||||
|
|
||||||
Keyfork shards can be transported to a system performing the \`remote-shard\`
|
If performing a "Remote Shard" operation, Keyfork shards can be transported to
|
||||||
operation by running:
|
the system performing the operation by running the following command:
|
||||||
|
|
||||||
# keyfork shard transport /media/mmcblk0p1/shards.pgp
|
# keyfork shard transport /media/mmcblk0p1/shards.pgp
|
||||||
|
|
||||||
For more information, run:
|
For more information, run:
|
||||||
|
|
||||||
# keyfork help
|
# keyfork help
|
||||||
|
|
||||||
EOF
|
EOF
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -50,6 +53,8 @@ discover-and-mount-sdcard() {
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
|
echo
|
||||||
help
|
help
|
||||||
|
echo
|
||||||
discover-and-mount-sdcard
|
discover-and-mount-sdcard
|
||||||
echo
|
echo
|
||||||
|
|
Loading…
Reference in New Issue