From 3cc3388a3b0e80a6b8047c23b8b4ea5cfff8dfbc Mon Sep 17 00:00:00 2001 From: Ross Smith II Date: Sat, 1 May 2021 09:13:09 -0700 Subject: [PATCH 1/3] Fix obsolete references to files.gpg --- _docs/110_faq.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/_docs/110_faq.md b/_docs/110_faq.md index ef3b812..cb033b1 100644 --- a/_docs/110_faq.md +++ b/_docs/110_faq.md @@ -94,16 +94,16 @@ what works best. ### I've created a bootstrap program. Should I add that to my repository? +## Encryption + Absolutely. That will allow your bootstrap program to be executed each time you clone your repository. Read [bootstrap](bootstrap) for more details. -## Encryption +### Can I use yadm without gpg, openssl, transcrypt or git-crypt? -### Can I use yadm without gpg? - -Of course. You only need `gpg` installed if you plan on using the -encrypt/decrypt features. yadm will tell you if it is missing a dependency -for any command. +Of course. You only need `gpg`, `openssl`, `transcrypt` or `git-crypt` installed +if you plan on using the encrypt/decrypt features. yadm will tell you if it is +missing a dependency for any command. ### Should I `yadm add` my `.config/yadm/encrypt` file? @@ -112,19 +112,20 @@ you when you clone your repository. ### Should I `yadm add` encrypted files to repository? -No, you should not. Files you want encrypted should be added to the file -`.config/yadm/files.gpg` using the `yadm encrypt` command. Then -`.config/yadm/files.gpg` should be added to the yadm repository. This way, only -an encrypted collection of those files are put into the repository. After -cloning or updating your repository, you can use `yadm decrypt` to extract those -files from `.config/yadm/files.gpg`. See the +No, you should not. Instead, add the names (or wildcard patterns) of the files you want +encrypted to `.config/yadm/encrypt`. Then, use the `yadm encrypt` command to encrypt the +matched files which then adds them to `~/.local/share/yadm/archive`. Then, use +`cd ; yadm add .local/share/yadm/archive` to add this file to the yadm repository. +This way, only encrypted versions of those files will be in the repository. After +cloning or updating your repository, you can use `yadm decrypt` to extract the +encrypted files from `~/.local/share/yadm/archive` into your working copy. See the [encryption help](encryption) for more details. ### I modified an encrypted file, but yadm doesn't show any modifications. Why? If you changed files which are matched by `.config/yadm/encrypt`, you must -re-run `yadm encrypt` to generate a new version of `.config/yadm/files.gpg`. -Then `.config/yadm/files.gpg` can be added to a new commit. +re-run `yadm encrypt` to generate a new version of `~/.local/share/yadm/archive`. +Then `~/.local/share/yadm/archive` can be added to a new commit. ### Why do I get the error `Inappropriate ioctl for device` when encrypting. From b08402569df42a51f9e84dfc273d3d910b1f3bfc Mon Sep 17 00:00:00 2001 From: Ross Smith II Date: Sat, 1 May 2021 09:18:24 -0700 Subject: [PATCH 2/3] Fix section header location --- _docs/110_faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/110_faq.md b/_docs/110_faq.md index cb033b1..61ff70e 100644 --- a/_docs/110_faq.md +++ b/_docs/110_faq.md @@ -94,11 +94,11 @@ what works best. ### I've created a bootstrap program. Should I add that to my repository? -## Encryption - Absolutely. That will allow your bootstrap program to be executed each time you clone your repository. Read [bootstrap](bootstrap) for more details. +## Encryption + ### Can I use yadm without gpg, openssl, transcrypt or git-crypt? Of course. You only need `gpg`, `openssl`, `transcrypt` or `git-crypt` installed From e33cbbda4c50d72a31d69e36621444418774feda Mon Sep 17 00:00:00 2001 From: Ross Smith II Date: Sat, 1 May 2021 09:38:11 -0700 Subject: [PATCH 3/3] Update FAQ to consistently use ~/ --- _docs/110_faq.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_docs/110_faq.md b/_docs/110_faq.md index 61ff70e..9e9ff11 100644 --- a/_docs/110_faq.md +++ b/_docs/110_faq.md @@ -105,7 +105,7 @@ Of course. You only need `gpg`, `openssl`, `transcrypt` or `git-crypt` installed if you plan on using the encrypt/decrypt features. yadm will tell you if it is missing a dependency for any command. -### Should I `yadm add` my `.config/yadm/encrypt` file? +### Should I `yadm add` my `~/.config/yadm/encrypt` file? Yes! This way your configuration for what files should be encrypted will follow you when you clone your repository. @@ -113,9 +113,9 @@ you when you clone your repository. ### Should I `yadm add` encrypted files to repository? No, you should not. Instead, add the names (or wildcard patterns) of the files you want -encrypted to `.config/yadm/encrypt`. Then, use the `yadm encrypt` command to encrypt the +encrypted to `~/.config/yadm/encrypt`. Then, use the `yadm encrypt` command to encrypt the matched files which then adds them to `~/.local/share/yadm/archive`. Then, use -`cd ; yadm add .local/share/yadm/archive` to add this file to the yadm repository. +`yadm add ~/.local/share/yadm/archive` to add this file to the yadm repository. This way, only encrypted versions of those files will be in the repository. After cloning or updating your repository, you can use `yadm decrypt` to extract the encrypted files from `~/.local/share/yadm/archive` into your working copy. See the @@ -123,7 +123,7 @@ encrypted files from `~/.local/share/yadm/archive` into your working copy. See t ### I modified an encrypted file, but yadm doesn't show any modifications. Why? -If you changed files which are matched by `.config/yadm/encrypt`, you must +If you changed files which are matched by `~/.config/yadm/encrypt`, you must re-run `yadm encrypt` to generate a new version of `~/.local/share/yadm/archive`. Then `~/.local/share/yadm/archive` can be added to a new commit.