Files
git-crypt/INSTALL.md
Andrew Ayer 0a2e633d7f Recommend Git 1.8.5 or newer for best performance
Since older versions of Git have to spawn a separate
check-attr process for every file in the repository,
which is slow.
2015-05-25 15:26:32 -07:00

60 lines
1.7 KiB
Markdown

### Dependencies
To build git-crypt, you need:
| Debian/Ubuntu package | RHEL/CentOS package
---------------------------|-----------------------|------------------------
Make | make | make
A C++ compiler (e.g. gcc) | g++ | gcc-c++
OpenSSL development files | libssl-dev | openssl-devel
To use git-crypt, you need:
| Debian/Ubuntu package | RHEL/CentOS package
---------------------------|-----------------------|------------------------
Git 1.7.2 or newer | git | git
OpenSSL | openssl | openssl
Note: Git 1.8.5 or newer is recommended for best performance.
### Building git-crypt
Run:
make
make install
To install to a specific location:
make install PREFIX=/usr/local
Or, just copy the git-crypt binary to wherever is most convenient for you.
### Building A Debian Package
Debian packaging can be found in the 'debian' branch of the project Git
repository. The package is built using git-buildpackage as follows:
git checkout debian
git-buildpackage -uc -us
### Installing On Mac OS X
Using the brew package manager, simply run:
brew install git-crypt
### Experimental Windows Support
git-crypt should build on Windows with MinGW, although the build system
is not yet finalized so you will need to pass your own CXX, CXXFLAGS, and
LDFLAGS variables to make. Additionally, Windows support is less tested
and does not currently create key files with restrictive permissions,
making it unsuitable for use on a multi-user system. Windows support
will mature in a future version of git-crypt. Bug reports and patches
are most welcome!