Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix references to files.gpg in FAQ #336

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions _docs/110_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand All @@ -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
rasa marked this conversation as resolved.
Show resolved Hide resolved
`.config/yadm/encrypt`. Then, use the `yadm encrypt` command to encrypt the listed
files, and add them to `~/.local/share/yadm/archive`.
rasa marked this conversation as resolved.
Show resolved Hide resolved
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
rasa marked this conversation as resolved.
Show resolved Hide resolved
[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.

Expand Down