mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
git-annex/doc/tips/using_box.com_as_a_special_remote.mdwn

82 lines
3.2 KiB
Text
Raw Normal View History

export to webdav This basically works, but there's a bug when renaming a file that leaves a .git-annex-temp-content-key file in the webdav store, that never gets cleaned up. Also, exporting files with spaces to box.com seems to fail; perhaps it does not support it? This commit was supported by the NSF-funded DataLad project.
2017-09-12 18:08:00 +00:00
[Box.com](http://box.com/) is a file storage service.
instructions for using Box.com as a special remote I was sucked in by the 50 gb free lifetime storage offer. Happily, it was pretty easy to get it to work with git-annex.
2012-03-04 00:06:27 +00:00
2019-02-04 14:40:03 +00:00
** WebDAV access to box.com will be deprecated at some point in the near future (originally was scheduled to be January 31, 2019 - but it has been pushed back to a yet to be defined date). At that point, the method described on this page will no longer work. See [this announcement](https://community.box.com/t5/Box-Product-News/Deprecation-WebDAV-Support/ba-p/55684) for further details. **
Warning about upcoming shutdown of webdav access to box.com
2018-09-22 22:45:45 +00:00
drop webdav compatability with the directory special remote etc The benefit of using a compatable directory structure does not outweigh the cost in complexity of handling the multiple locations content can be stored in directory special remotes. And this also allows doing away with the parent directories, which can't be made unwritable in DAV, so have no benefit there. This will save 2 http calls per file store. But, kept the directory hashing, just in case.
2012-11-16 04:42:33 +00:00
git-annex can use Box as a [[special remote|special_remotes]].
export to webdav This basically works, but there's a bug when renaming a file that leaves a .git-annex-temp-content-key file in the webdav store, that never gets cleaned up. Also, exporting files with spaces to box.com seems to fail; perhaps it does not support it? This commit was supported by the NSF-funded DataLad project.
2017-09-12 18:08:00 +00:00
Recent versions of git-annex make this very easy to set up
and use.
drop webdav compatability with the directory special remote etc The benefit of using a compatable directory structure does not outweigh the cost in complexity of handling the multiple locations content can be stored in directory special remotes. And this also allows doing away with the parent directories, which can't be made unwritable in DAV, so have no benefit there. This will save 2 http calls per file store. But, kept the directory hashing, just in case.
2012-11-16 04:42:33 +00:00
Warning about upcoming shutdown of webdav access to box.com
2018-09-22 22:45:45 +00:00
export to webdav This basically works, but there's a bug when renaming a file that leaves a .git-annex-temp-content-key file in the webdav store, that never gets cleaned up. Also, exporting files with spaces to box.com seems to fail; perhaps it does not support it? This commit was supported by the NSF-funded DataLad project.
2017-09-12 18:08:00 +00:00
## git-annex setup
Create the special remote, in your git-annex repository.
** This example is non-encrypted; fill in your gpg key ID for a securely
encrypted special remote! **
WEBDAV_USERNAME=you@example.com WEBDAV_PASSWORD=xxxxxxx git annex initremote box.com type=webdav url=https://dav.box.com/dav/git-annex chunk=50mb encryption=none
Note the use of [[chunking]]. Box has a limit on the maximum size of file
that can be stored there (currently 256 MB). git-annex can break up large
files into chunks to avoid the size limit. This needs git-annex version
3.20120303 or newer, which adds support for chunking.
Now git-annex can copy files to box.com, get files from it, etc, just like
with any other special remote.
% git annex copy bigfile --to box.com
bigfile (to box.com...) ok
% git annex drop bigfile
bigfile (checking box.com...) ok
% git annex get bigfile
bigfile (from box.com...) ok
## exporting trees
By default, files stored in Box will show up there named
by their git-annex key, not the original filename. If the filenames
are important, you can run `git annex initremote` with an additional
parameter "exporttree=yes", and then use [[git-annex-export]] to publish
a tree of files to Box.
drop webdav compatability with the directory special remote etc The benefit of using a compatable directory structure does not outweigh the cost in complexity of handling the multiple locations content can be stored in directory special remotes. And this also allows doing away with the parent directories, which can't be made unwritable in DAV, so have no benefit there. This will save 2 http calls per file store. But, kept the directory hashing, just in case.
2012-11-16 04:42:33 +00:00
export to webdav This basically works, but there's a bug when renaming a file that leaves a .git-annex-temp-content-key file in the webdav store, that never gets cleaned up. Also, exporting files with spaces to box.com seems to fail; perhaps it does not support it? This commit was supported by the NSF-funded DataLad project.
2017-09-12 18:08:00 +00:00
Note that chunking can't be used when exporting a tree of files,
so Box's 250 mb limit will prevent exporting larger files.
drop webdav compatability with the directory special remote etc The benefit of using a compatable directory structure does not outweigh the cost in complexity of handling the multiple locations content can be stored in directory special remotes. And this also allows doing away with the parent directories, which can't be made unwritable in DAV, so have no benefit there. This will save 2 http calls per file store. But, kept the directory hashing, just in case.
2012-11-16 04:42:33 +00:00
# old davfs2 method
This method is deprecated, but still documented here just in case.
Note that the files stored using this method cannot reliably be retreived
using the webdav special remote.
instructions for using Box.com as a special remote I was sucked in by the 50 gb free lifetime storage offer. Happily, it was pretty easy to get it to work with git-annex.
2012-03-04 00:06:27 +00:00
## davfs2 setup
* First, install
the [davfs2](http://savannah.nongnu.org/projects/davfs2) program,
which can mount Box using WebDAV. On Debian, just `sudo apt-get install davfs2`
* Allow users to mount davfs filesystems, by ensuring that
`/sbin/mount.davfs` is setuid root. On Debian, just `sudo dpkg-reconfigure davfs2`
* Add yourself to the davfs2 group.
Formatting
2012-03-12 11:22:21 +00:00
sudo adduser $(whoami) davfs2
instructions for using Box.com as a special remote I was sucked in by the 50 gb free lifetime storage offer. Happily, it was pretty easy to get it to work with git-annex.
2012-03-04 00:06:27 +00:00
* Edit `/etc/fstab`, and add a line to mount Box using davfs.
Formatting
2012-03-12 11:22:21 +00:00
sudo mkdir -p /media/box.com
update davfs2 method with new box.com dav url
2013-12-18 20:23:44 +00:00
echo "https://dav.box.com/dav/ /media/box.com davfs noauto,user 0 0" | sudo tee -a /etc/fstab
Formatting
2012-03-12 11:22:21 +00:00
tweak davfs2 settings
2012-03-04 15:12:52 +00:00
* Create `~/.davfs2/davfs2.conf` with some important settings:
Formatting
2012-03-12 11:22:21 +00:00
mkdir ~/.davfs2/
fixie
2012-06-07 14:37:06 +00:00
echo use_locks 0 > ~/.davfs2/davfs2.conf
Formatting
2012-03-12 11:22:21 +00:00
echo cache_size 1 >> ~/.davfs2/davfs2.conf
echo delay_upload 0 >> ~/.davfs2/davfs2.conf
instructions for using Box.com as a special remote I was sucked in by the 50 gb free lifetime storage offer. Happily, it was pretty easy to get it to work with git-annex.
2012-03-04 00:06:27 +00:00
* Create `~/.davfs2/secrets`. This file contains your Box.com login and password.
Your login is probably the email address you signed up with.
Formatting
2012-03-12 11:22:21 +00:00
update my email address and homepage url
2015-01-21 16:50:09 +00:00
echo "/media/box.com id@joeyh.name mypassword" > ~/.davfs2/secrets
Formatting
2012-03-12 11:22:21 +00:00
chmod 600 ~/.davfs2/secrets
instructions for using Box.com as a special remote I was sucked in by the 50 gb free lifetime storage offer. Happily, it was pretty easy to get it to work with git-annex.
2012-03-04 00:06:27 +00:00
* Now you should be able to mount Box, as a non-root user:
Formatting
2012-03-12 11:22:21 +00:00
mount /media/box.com
Reference in a new issue Copy permalink