mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

documentation for git-lfs special remote

Browse source
This commit is contained in:
Joey Hess 2019-08-04 13:15:33 -04:00
parent 408cb0af39
commit c5ed11bc3f
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 88 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

23
doc/tips/storing_data_in_git-lfs.mdwn Normal file
View file

@ -0,0 +1,23 @@
git-annex can store data in [git-lfs](https://git-lfs.github.com/)
repositories, using the [[git-lfs special remote|special_remotes/git-lfs]].
Here's how to initialize a git-lfs special remote on Github.
git annex initremote lfs type=git-lfs encryption=none url=git@github.com:yourname/yourrepo.git
If you want git-annex to encrypt the objects it stores in the remote,
change the encryption= parameter. But be sure to read the
[[git-lfs special remote|special_remotes/git-lfs]] page's
**encryption notes** first!
To enable the same remote in another clone of the repository,
you'll need to provide an url to it again. It's ok to provide a different
url as long as it points to the same git-lfs repository.
git annex enableremote lfs url=https://github.com/yourname/yourrepo.git
Note that http urls currently only allow read access to the git-lfs
repository.
A git-lfs special remote also functions as a regular git remote. You can
use things like `git push` and `git pull` with it.