adrian
/
GitCrypt
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Compare commits

base: adrian:b6d11f7b4ec4ef734a461d52202c685e1927b4c1
Branches Tags
adrian:master
..
compare: adrian:6384c7bceab3e2403c9f58e71ae5b1495b003eed
Branches Tags
adrian:master

1 Commits
b6d11f7b4e ... 6384c7bcea

Author SHA1 Message Date
Adrian 6384c7bcea Simplify structure, update Readme 2015-10-30 14:33:02 +01:00
1 changed files with 5 additions and 2 deletions
Show Stats Expand all files Collapse all files

7
README.md
View File

@ -13,19 +13,22 @@ which served as a starting point.
# Installation # Installation
1. **Before using GitCrypt the first time, register the filters:** 1. Before using GitCrypt the first time, register the filters:
git config --global filter.gitcrypt.smudge .gitcrypt/dec git config --global filter.gitcrypt.smudge .gitcrypt/dec
git config --global filter.gitcrypt.clean .gitcrypt/enc git config --global filter.gitcrypt.clean .gitcrypt/enc
git config --global diff.gitcrypt.textconv .gitcrypt/diff git config --global diff.gitcrypt.textconv .gitcrypt/diff
If this step is omitted, files get added unencrypted silently. **If this step is omitted, files get added unencrypted silently.**
However, it is not needed, if GitCrypt has been used before. However, it is not needed, if GitCrypt has been used before.
2. Imagine a repository password. 2. Imagine a repository password.
It is either expected in the environment variable `$GITCRYPT_PASS`, It is either expected in the environment variable `$GITCRYPT_PASS`,
or in the file `.git/pass` (which is ignored by Git). or in the file `.git/pass` (which is ignored by Git).
**Hint:** You can enter the password safely by using the command:
`read -s GITCRYPT_PASS`
3. After that, generate a salt: 3. After that, generate a salt:
.gitcrypt/gensalt .gitcrypt/gensalt