psi-jack
/
yadm
mirror of
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge e33cbbda4c into 21a95d05e0

This commit is contained in:
Ross Smith II 2023-10-20 23:57:41 -06:00 committed by GitHub
parent 21a95d05e0 e33cbbda4c
commit d8bbd138b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
_docs/110_faq.md
View File

@ -99,32 +99,33 @@ clone your repository. Read [bootstrap](bootstrap) for more details.
## Encryption ## 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 Of course. You only need `gpg`, `openssl`, `transcrypt` or `git-crypt` installed
encrypt/decrypt features. yadm will tell you if it is missing a dependency if you plan on using the encrypt/decrypt features. yadm will tell you if it is
for any command. 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 Yes! This way your configuration for what files should be encrypted will follow
you when you clone your repository. you when you clone your repository.
### Should I `yadm add` encrypted files to repository? ### Should I `yadm add` encrypted files to repository?
No, you should not. Files you want encrypted should be added to the file No, you should not. Instead, add the names (or wildcard patterns) of the files you want
`.config/yadm/files.gpg` using the `yadm encrypt` command. Then encrypted to `~/.config/yadm/encrypt`. Then, use the `yadm encrypt` command to encrypt the
`.config/yadm/files.gpg` should be added to the yadm repository. This way, only matched files which then adds them to `~/.local/share/yadm/archive`. Then, use
an encrypted collection of those files are put into the repository. After `yadm add ~/.local/share/yadm/archive` to add this file to the yadm repository.
cloning or updating your repository, you can use `yadm decrypt` to extract those This way, only encrypted versions of those files will be in the repository. After
files from `.config/yadm/files.gpg`. See the 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. [encryption help](encryption) for more details.
### I modified an encrypted file, but yadm doesn't show any modifications. Why? ### 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 `.config/yadm/files.gpg`. re-run `yadm encrypt` to generate a new version of `~/.local/share/yadm/archive`.
Then `.config/yadm/files.gpg` can be added to a new commit. Then `~/.local/share/yadm/archive` can be added to a new commit.
### Why do I get the error `Inappropriate ioctl for device` when encrypting. ### Why do I get the error `Inappropriate ioctl for device` when encrypting.