psi-jack/yadm
1
0
Fork 0
mirror of synced 2024-12-22 14:41:07 -05:00
Code Issues Releases Wiki Activity

Add documentation for transcrypt

Browse source
This commit is contained in:
Tim Byrne 2020-08-08 21:09:13 -05:00
parent b76caca64d
commit 3245041496
No known key found for this signature in database
GPG key ID: 14DB4FC2465A4B12
2 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
_docs/080_encryption.md
View file

@ -39,13 +39,16 @@ be enabled using the `yadm.gpg-recipient` configuration. To do so, run:
For this to work, `<recipient-address>` must exist in your gpg keyrings.
## git-crypt
## transcrypt & git-crypt
git-crypt is a tool that enables transparent encryption and decryption of files
in a Git repository. If git-crypt is installed, you can use it with your yadm
repository.
transcrypt & git-crypt are tools that enable transparent encryption and
decryption of files in a Git repository. If installed, you can use either of
these tools with your yadm repository.
Simply use it normally, prefacing the `git-crypt` commands with `yadm`.
Simply use it normally, prefacing the `transcrypt` or `git-crypt` commands with
`yadm`.
You can learn more about [git-crypt](https://github.com/AGWA/git-crypt) at this
[website](https://www.agwa.name/projects/git-crypt/).
Learn more about these tools here:
* [transcrypt](https://github.com/elasticdog/transcrypt)
* [git-crypt](https://github.com/AGWA/git-crypt)

5
_docs/110_faq.md
View file

@ -149,9 +149,10 @@ this variable to your shell in your login scripts.
export GPG_TTY=$(tty)
```
### Can I use yadm and git-crypt?
### Can I use yadm with transcrypt or git-crypt?
Yes, yadm now supports git-crypt. Read more [here](/docs/encryption#git-crypt).
Yes, yadm now supports both transcrypt and git-crypt.
Read more [here](/docs/encryption#transcrypt--git-crypt).
## Directory Creation