diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cheatsheet.mdwn | 1 | ||||
| -rw-r--r-- | doc/index.mdwn | 2 | ||||
| -rw-r--r-- | doc/special_remotes.mdwn | 2 | ||||
| -rw-r--r-- | doc/special_remotes/S3.mdwn (renamed from doc/special_remotes/Amazon_S3.mdwn) | 0 | ||||
| -rw-r--r-- | doc/walkthrough/Internet_Archive_via_S3.mdwn | 48 | ||||
| -rw-r--r-- | doc/walkthrough/using_Amazon_S3.mdwn | 2 |
6 files changed, 52 insertions, 3 deletions
diff --git a/doc/cheatsheet.mdwn b/doc/cheatsheet.mdwn index 4287756a6..3f5960972 100644 --- a/doc/cheatsheet.mdwn +++ b/doc/cheatsheet.mdwn @@ -11,4 +11,5 @@ A suppliment to the [[walkthrough]]. walkthrough/untrusted_repositories walkthrough/what_to_do_when_you_lose_a_repository walkthrough/recover_data_from_lost+found + walkthrough/Internet_Archive_via_S3 """]] diff --git a/doc/index.mdwn b/doc/index.mdwn index eb6307f32..8975c82de 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -43,7 +43,7 @@ files with git. * [[git-annex man page|git-annex]] * [[key-value backends|backends]] for data storage -* [[special_remotes]] (including [[special_remotes/Amazon_S3]] and [[special_remotes/bup]]) +* [[special_remotes]] (including [[special_remotes/S3]] and [[special_remotes/bup]]) * [[encryption]] * [[bare_repositories]] * [[internals]] diff --git a/doc/special_remotes.mdwn b/doc/special_remotes.mdwn index 13c18122e..dcb6b5063 100644 --- a/doc/special_remotes.mdwn +++ b/doc/special_remotes.mdwn @@ -6,7 +6,7 @@ But, git-annex also extends git's concept of remotes, with these special types of remotes. These can be used just like any normal remote by git-annex. They cannot be used by other git commands though. -* [[Amazon_S3]] +* [[S3]] (Amazon S3, and other compatible services) * [[bup]] * [[directory]] * [[rsync]] diff --git a/doc/special_remotes/Amazon_S3.mdwn b/doc/special_remotes/S3.mdwn index 35397dc2a..35397dc2a 100644 --- a/doc/special_remotes/Amazon_S3.mdwn +++ b/doc/special_remotes/S3.mdwn diff --git a/doc/walkthrough/Internet_Archive_via_S3.mdwn b/doc/walkthrough/Internet_Archive_via_S3.mdwn new file mode 100644 index 000000000..089102d14 --- /dev/null +++ b/doc/walkthrough/Internet_Archive_via_S3.mdwn @@ -0,0 +1,48 @@ +[The Internet Archive](http://www.archive.org/) allows members to upload +collections using an Amazon S3 +[compatible API](http://www.archive.org/help/abouts3.txt), and this can +be used with git-annex's [[special_remotes/S3]] support. + +So, if you're an archivist, you can locally archive things with git-annex, +and define remotes that correspond to "items" at the Internet Archive, +and use git-annex to upload your files to there. +Of course, your use of the Internet Archive must comply with their +[terms of service](http://www.archive.org/about/terms.php). + +## step 0 + +Sign up for an account, and get your access keys here: +<http://www.archive.org/account/s3.php> + + # export AWS_ACCESS_KEY_ID=blahblah + # export AWS_SECRET_ACCESS_KEY=xxxxxxx + +Now go to <http://www.archive.org/create/> and create the item. +This allows you to fill in metadata which git-annex cannot provide to the +Internet Archive. (It also works around a bug with bucket creation.) + +(Note that there seems to be a bug in either hS3 or the archive that +breaks authentication when the item name contains spaces or upper-case +letters.. use all lowercase and no spaces.) + +Specify `host=s3.us.archive.org` when doing initremote to set up +a remote at the Archive. It does not make sense to use encryption. +For the bucket name, specify the item name created in step 1. + + # git annex initremote panama type=S3 encryption=none host=s3.us.archive.org bucket=panama-canal-lock-blueprints + initremote archive-panama (checking bucket) (creating bucket in US) ok + # git annex describe archive-panama "Internet Archive item for my grandfather's Panama Canal lock design blueprints" + describe archive-panama ok + +Then you can annex files and copy them to the remote as usual: + + # git annex add photo1.jpeg + add photo1.jpeg ok + # git annex copy photo1.jpeg --to archive-panama + copy (checking archive-panama...) (to archive-panama...) ok + +Note that it probably makes the most sense to use the WORM backend +for files, since that exposes the original filename in the key stored +in the Archive, which allows its special processing for sound files, +movies, etc to be done. Also, the Internet Archive has restrictions +on what is allowed in a filename; particularly no spaces are allowed. diff --git a/doc/walkthrough/using_Amazon_S3.mdwn b/doc/walkthrough/using_Amazon_S3.mdwn index 6b0f49639..7f972afe1 100644 --- a/doc/walkthrough/using_Amazon_S3.mdwn +++ b/doc/walkthrough/using_Amazon_S3.mdwn @@ -34,4 +34,4 @@ Now the remote can be used like any other remote. # git annex move video/hackity_hack_and_kaxxt.mov --to cloud move video/hackity_hack_and_kaxxt.mov (checking cloud...) (to cloud...) ok -See [[special_remotes/Amazon_S3]] for details. +See [[special_remotes/S3]] for details. |