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

S3: fix documentation of publicurl

Browse source 
5f0f063a7a documented it as being
configured automatically, but the code never did that. Rather than try
to hard-code whatever urls amazon  uses for its buckets, it seems better
to ask the user to find the url and set it.
This commit is contained in:
Joey Hess 2018-07-02 12:30:39 -04:00
parent 0a875d81e5
commit ba0745b5c2
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 24 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/special_remotes/S3.mdwn
View file

@ -76,8 +76,9 @@ the S3 remote.
only affect subseqent uploads. only affect subseqent uploads.
* `publicurl` - Configure the URL that is used to download files * `publicurl` - Configure the URL that is used to download files
from the bucket when they are available publically. from the bucket. Using this in combination with public=yes allows
(This is automatically configured for Amazon S3 and the Internet Archive.) git-annex to download files from the S3 remote without needing to
know the S3 credentials.
* `partsize` - Amazon S3 only accepts uploads up to a certian file size, * `partsize` - Amazon S3 only accepts uploads up to a certian file size,
and storing larger files requires a multipart upload process. and storing larger files requires a multipart upload process.

8
doc/tips/public_Amazon_S3_remote.mdwn
View file

@ -20,8 +20,12 @@ Now, create the remote:
# git annex initremote pubs3 type=S3 encryption=none public=yes # git annex initremote pubs3 type=S3 encryption=none public=yes
initremote pubs3 (checking bucket) (creating bucket in US) ok initremote pubs3 (checking bucket) (creating bucket in US) ok
The public=yes is the crtical part; this lets the public read the contents The public=yes makes git-annex set a S3 ACL so the files in the bucket
of the bucket. (This feature needs git-annex 5.20150617 or newer.) are publically readable. For git-annex to be able to download files from
that bucket without needing your AWS credentials, you then need to tell
it the url of the bucket. Find that url, and run:
# git annex enableremote pubs3 publicurl=...
In the above example, no encryption was used, but it will also work In the above example, no encryption was used, but it will also work
if you enable encryption=shared. Then files will be encrypted on S3, and if you enable encryption=shared. Then files will be encrypted on S3, and

15
doc/tips/public_Amazon_S3_remote/comment_2_f155c3aa054a23df1ab057baaa300a62._comment Normal file
View file

@ -0,0 +1,15 @@
[[!comment format=mdwn
username="joey"
subject="""comment 2"""
date="2018-07-02T16:18:37Z"
content="""
It seems to me that you need to tell git-annex the publicurl to use to
download files from this S3 remote. That's the url to the top of the S3
bucket. Run `git annex enableremote publics3 publicurl=...' and push,
and it should then become available in every clone.
The documentation for publicurl says it's enabled by default when
public=yes, but AFAICS it's never actually done that. And I'm not sure I
want to hardcode those urls into git-annex. I've updated the documentation
instead.
"""]]