psi-jack/yadm
1
0
Fork 0
mirror of synced 2024-12-04 14:45:36 -05:00
Code Issues Releases Wiki Activity

Replace references to files.gpg with archive (#337)

Browse source
This commit is contained in:
Erik Flodin 2024-11-24 16:38:09 +01:00
commit fad957958f
No known key found for this signature in database
GPG key ID: 420A7C865EE3F85F
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
### 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?
### 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.
### 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
`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.
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.
### Why do I get the error `Inappropriate ioctl for device` when encrypting.