From cdb1a3301fcb9d839e67fd5932d922085e1fc001 Mon Sep 17 00:00:00 2001 From: John-Mark Gurney Date: Wed, 28 Oct 2020 09:02:12 -0700 Subject: [PATCH] talk about using it to verify snapshots and releases.. --- README.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1c55e77..d0f61d8 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,19 @@ snapaid ======= This is a utility that will make it easier to find and download the -correct snapshot. It will also fetch and verify the GPG signature -and hash of the snapshot to ensure that you are getting the correct -file. +correct snapshot or release. It will also fetch and verify the GPG +signature and hash of the snapshot to ensure that you are getting the +correct file. ![Screen shot of snapaid.sh find](images/snapaid.find.png?raw=true) Quick Start -------------- +----------- -The only file needed for this is the snapaid.sh script. The other files -are used for generating the index. +The only file needed is the snapaid.sh script. The other files in the +repo are used for generating the index. +Setting up and finding a snapshot: ``` $wget https://www.funkthat.com/gitea/jmg/snapaid/raw/branch/master/snapaid.sh $chmod 755 snapaid.sh @@ -32,6 +33,23 @@ Each term between `find` and `1` refines the search, and the `1` selects the first image. The list is sorted by date, then by release, where the latest is shown first. +Verifying +--------- + +If you've already installed and setup snapaid.sh previously, you can skip +the first two lines. + +Setting up and verifying a snapshot or release: +``` +$wget https://www.funkthat.com/gitea/jmg/snapaid/raw/branch/master/snapaid.sh +$chmod 755 snapaid.sh +$./snapaid.sh verify FreeBSD-12.2-RELEASE-amd64-mini-memstick.img.xz +``` + +Note that the provided filename MUST match exactly the released name so +that it can be found in the index. It could be possible in the future +to find it via shasum, but that is not implemented yet. + Notes -----