summaryrefslogtreecommitdiff
path: root/doc/special_remotes
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2012-03-03 18:05:55 -0400
committerGravatar Joey Hess <joey@kitenet.net>2012-03-03 18:05:55 -0400
commit3436aba6de8cad844691ca979ab5825f7011fb7e (patch)
tree0602b1728860611621dbce3f986cf3e8e43e1290 /doc/special_remotes
parent2841d748a49a15080995d6cef7999fe6a38c866a (diff)
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.
Diffstat (limited to 'doc/special_remotes')
-rw-r--r--doc/special_remotes/directory.mdwn19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/special_remotes/directory.mdwn b/doc/special_remotes/directory.mdwn
index 0a38c763c..100e06878 100644
--- a/doc/special_remotes/directory.mdwn
+++ b/doc/special_remotes/directory.mdwn
@@ -5,6 +5,25 @@ 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.
+## configuration
+
+These parameters can be passed to `git annex initremote` to configure the
+remote:
+
+* `encryption` - Required. Either "none" to disable encryption of content
+ stored in the directory,
+ or a value that can be looked up (using gpg -k) to find a gpg encryption
+ key that will be given access to the remote. Note that additional gpg
+ keys can be given access to a remote by rerunning initremote with
+ the new key id. See [[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.
+ Note that changing the chunk size of an existing remote is
+ not recommended.
+ The value can use specified using any commonly used units.
+ Example: `chunksize=100 megabytes`
+
Setup example:
# git annex initremote usbdrive type=directory directory=/media/usbdrive/ encryption=none