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.

Sign up for GitHub

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

Jump to bottom

Replace references to files.gpg with archive #337

Open
wants to merge 3 commits into
base: dev-pages
Choose a base branch
from
Open

Replace references to files.gpg with archive #337

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3cc3388
Fix obsolete references to files.gpg
rasa May 1, 2021
b084025
Fix section header location
rasa May 1, 2021
e33cbbd
Update FAQ to consistently use ~/
rasa May 1, 2021
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
29 changes: 15 additions & 14 deletions _docs/110_faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down