git-annex/doc/special_remotes/directory.mdwn

This special remote type stores file contents in directory.

One use case for this would be if you have a removable drive that
you want to use it to sneakernet files between systems (possibly with
[[encrypted|encryption]] contents). Just set up both systems to use
the drive's mountpoint as a directory remote.

If you just want two copies of your repository with the files "visible"
in the tree in both, the directory special remote is not what you want.
Instead, you should use a regular `git clone` of your git-annex repository.

## configuration

These parameters can be passed to `git annex initremote` to configure the
remote:

* `encryption` - One of "none", "hybrid", "shared", or "pubkey".
  See [[encryption]].

* `keyid` - Specifies the gpg key to use for [[encryption]].

* `chunksize` - Avoid storing files larger than the specified size in the
  directory. For use on directories on mount points that have file size
  limitations. The default is to never chunk files.  
  The value can use specified using any commonly used units.
  Example: `chunksize=100 megabytes`  
  Note that enabling chunking on an existing remote with non-chunked
  files is not recommended.

Setup example:

	# git annex initremote usbdrive type=directory directory=/media/usbdrive/ encryption=none
	# git annex describe usbdrive "usb drive on /media/usbdrive/"
tweak 2011-03-30 19:32:34 +00:00			`This special remote type stores file contents in directory.`
add Remote.Directory 2011-03-30 17:18:46 +00:00
document encryption 2011-04-16 23:30:31 +00:00			`One use case for this would be if you have a removable drive that`
			`you want to use it to sneakernet files between systems (possibly with`
			`[[encrypted\|encryption]] contents). Just set up both systems to use`
add Remote.Directory 2011-03-30 17:18:46 +00:00			`the drive's mountpoint as a directory remote.`

add note that this is not what's wanted if two trees with files visible is the desired use case 2013-08-11 12:20:22 +00:00			`If you just want two copies of your repository with the files "visible"`
			`in the tree in both, the directory special remote is not what you want.`
			Instead, you should use a regular `git clone` of your git-annex repository.

Directory special remotes now support chunking files written to them Avoiding writing files larger than a specified size is useful on certian things. For example, box.com has a file size limit of 100 mb. Could also be useful on really crappy removable media. 2012-03-03 22:05:55 +00:00			`## configuration`

			These parameters can be passed to `git annex initremote` to configure the
			`remote:`

update docs for changed initremote encryption syntax 2013-09-05 03:46:50 +00:00			* `encryption` - One of "none", "hybrid", "shared", or "pubkey".
			`See [[encryption]].`
Allow controlling whether login credentials for S3 and webdav are committed to the repository, by setting embedcreds=yes\|no when running initremote. 2012-11-19 21:32:58 +00:00
update docs for changed initremote encryption syntax 2013-09-05 03:46:50 +00:00			* `keyid` - Specifies the gpg key to use for [[encryption]].
Allow controlling whether login credentials for S3 and webdav are committed to the repository, by setting embedcreds=yes\|no when running initremote. 2012-11-19 21:32:58 +00:00
Directory special remotes now support chunking files written to them Avoiding writing files larger than a specified size is useful on certian things. For example, box.com has a file size limit of 100 mb. Could also be useful on really crappy removable media. 2012-03-03 22:05:55 +00:00			* `chunksize` - Avoid storing files larger than the specified size in the
			`directory. For use on directories on mount points that have file size`
clarification 2012-03-04 14:51:25 +00:00			`limitations. The default is to never chunk files.`
Directory special remotes now support chunking files written to them Avoiding writing files larger than a specified size is useful on certian things. For example, box.com has a file size limit of 100 mb. Could also be useful on really crappy removable media. 2012-03-03 22:05:55 +00:00			`The value can use specified using any commonly used units.`
clarification 2012-03-04 14:51:25 +00:00			Example: `chunksize=100 megabytes`
			`Note that enabling chunking on an existing remote with non-chunked`
			`files is not recommended.`
Directory special remotes now support chunking files written to them Avoiding writing files larger than a specified size is useful on certian things. For example, box.com has a file size limit of 100 mb. Could also be useful on really crappy removable media. 2012-03-03 22:05:55 +00:00
add Remote.Directory 2011-03-30 17:18:46 +00:00			`Setup example:`

rsync special remote Fully tested and working, including resuming and encryption. (Though not resuming when sending with encryption; gpg doesn't produce identical output each time.) Uses same layout as the directory special remote and the .git/annex/objects/ directory. 2011-04-28 00:06:07 +00:00			`# git annex initremote usbdrive type=directory directory=/media/usbdrive/ encryption=none`
add git annex describe to special remote setup examples 2011-04-29 15:16:54 +00:00			`# git annex describe usbdrive "usb drive on /media/usbdrive/"`