gitea-mirror/git-crypt
1
0
Fork 0
mirror of https://github.com/AGWA/git-crypt.git synced 2025-12-25 12:24:20 -08:00
Code Issues Packages Projects Releases Wiki Activity

Document GPG mode in README

Browse Source
This commit is contained in:
Andrew Ayer
2014-09-13 11:25:44 -07:00
parent 0538d111fc
commit 9e340b510d
2 changed files with 58 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
README
View File

@@ -21,14 +21,10 @@ See the INSTALL file.
USING GIT-CRYPT
Generate a secret key:
$ git-crypt keygen /path/to/keyfile
Configure a repository to use encryption:
Configure a repository to use git-crypt:
$ cd repo
$ git-crypt init /path/to/keyfile
$ git-crypt init
Specify files to encrypt by creating a .gitattributes file:
@@ -36,18 +32,36 @@ Specify files to encrypt by creating a .gitattributes file:
*.key filter=git-crypt diff=git-crypt
Like a .gitignore file, it can match wildcards and should be checked into
the repository. See below for more information about .gitattributes
files. Make sure you don't accidentally encrypt the .gitattributes
file itself!
the repository. See below for more information about .gitattributes.
Make sure you don't accidentally encrypt the .gitattributes file itself!
Cloning a repository with encrypted files:
Share the repository with others (or with yourself) using GPG:
$ git clone /path/to/repo
$ cd repo
$ git-crypt init /path/to/keyfile
$ git-crypt add-gpg-key USER_ID
That's all you need to do - after running git-crypt init, you can use
git normally - encryption and decryption happen transparently.
USER_ID can be a key ID, a full fingerprint, an email address, or anything
else that uniquely identifies a key to GPG (see "HOW TO SPECIFY A USER
ID" in the gpg man page). Note: `git-crypt add-gpg-key` will add and
commit a GPG-encrypted key file in the .git-crypt directory of the root
of your repository.
Alternatively, you can export a symmetric secret key, which you must
securely convey to collaborators (GPG is not required, and no files
are added to your repository):
$ git-crypt export-key /path/to/key
After cloning a repository with encrypted files, unlock with with GPG:
$ git-crypt unlock
Or with a symmetric key:
$ git-crypt unlock /path/to/key
That's all you need to do - after git-crypt is set up (either with
`git-crypt init` or `git-crypt unlock`), you can use git normally -
encryption and decryption happen transparently.
CURRENT STATUS

44
README.md
View File

@@ -22,14 +22,10 @@ See the [INSTALL.md](INSTALL.md) file.
Using git-crypt
---------------
Generate a secret key:
git-crypt keygen /path/to/keyfile
Configure a repository to use encryption:
Configure a repository to use git-crypt:
cd repo
git-crypt init /path/to/keyfile
git-crypt init
Specify files to encrypt by creating a .gitattributes file:
@@ -37,18 +33,36 @@ Specify files to encrypt by creating a .gitattributes file:
*.key filter=git-crypt diff=git-crypt
Like a .gitignore file, it can match wildcards and should be checked into
the repository. See below for more information about .gitattributes
files. Make sure you don't accidentally encrypt the .gitattributes
file itself!
the repository. See below for more information about .gitattributes.
Make sure you don't accidentally encrypt the .gitattributes file itself!
Cloning a repository with encrypted files:
Share the repository with others (or with yourself) using GPG:
git clone /path/to/repo
cd repo
git-crypt init /path/to/keyfile
git-crypt add-gpg-key USER_ID
That's all you need to do - after running `git-crypt init`, you can use
git normally - encryption and decryption happen transparently.
`USER_ID` can be a key ID, a full fingerprint, an email address, or anything
else that uniquely identifies a key to GPG (see "HOW TO SPECIFY A USER
ID" in the gpg man page). Note: `git-crypt add-gpg-key` will add and
commit a GPG-encrypted key file in the .git-crypt directory of the root
of your repository.
Alternatively, you can export a symmetric secret key, which you must
securely convey to collaborators (GPG is not required, and no files
are added to your repository):
git-crypt export-key /path/to/key
After cloning a repository with encrypted files, unlock with with GPG:
git-crypt unlock
Or with a symmetric key:
git-crypt unlock /path/to/key
That's all you need to do - after git-crypt is set up (either with
`git-crypt init` or `git-crypt unlock`), you can use git normally -
encryption and decryption happen transparently.
Current Status
--------------