Fix references to files.gpg in FAQ

Fixes #334, #335
This commit is contained in:
Ross Smith II 2021-05-01 08:10:05 -07:00 committed by GitHub
parent 5b3e5de331
commit 8abae122fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 12 deletions

View File

@ -99,11 +99,11 @@ clone your repository. Read [bootstrap](bootstrap) for more details.
## Encryption
### Can I use yadm without gpg?
### Can I use yadm without gpg, openssl, transcrypt or git-crypt?
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. Files you want encrypted should be added to the text file
`.config/yadm/encrypt`. Then, use the `yadm encrypt` command to encrypt the listed
files, and add them to `~/.local/share/yadm/archive`.
Then `~/.local/share/yadm/archive` should be added to the yadm repository. This way,
only encrypted versions of those files are added to the repository. After
cloning or updating your repository, you can use `yadm decrypt` to extract the
encrypted files in `~/.local/share/yadm/archive`. 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.