git-annex/doc/special_remotes/httpalso.mdwn
2023-06-20 13:35:28 -04:00

38 lines
1.9 KiB
Markdown

This special remote allows downloading annexed objects from other special
remotes that also publish their content by http. Not to be confused with
the [[web]] special remote, or with
[[accessing git-annex repositories over http|tips/setup_a_public_repository_on_a_web_site]],
this is only useful in combination with some other special remote.
Suppose, for example, that you have a [[directory]] special remote. And the
directory happens to be published by a web server. (Or it could be a
[[rsync]] special remote, or many other kinds.) To let git-annex know that
the content of this special remote can also be accessed over http, set up
a httpalso special remote.
git annex initremote --sameas=foo foo-http type=httpalso url=http://example.com/foo
The --sameas parameter tells git-annex what other special remote this httpalso
remote is accessing. (See [[tips/multiple_remotes_accessing_the_same_data_store]].)
Since the httpalso remote is read-only, it can only be used to download
content that is stored in that other remote.
This special remote is compatible with many, but not all, other special
remotes. If the special remote does something unusual with the name
a file is stored under, or with how the data is stored, it might not work.
See [[tips/multiple_remotes_accessing_the_same_data_store]]
for a list of known working combinations.
## configuration
* `url` - The http or https url to where the content is stored by the
other special remote.
* `exporttree` - If the other special remote has `exporttree=yes` set,
it also needs to be set when initializing the httpalso remote.
Setting this does not allow trees to be exported to the httpalso remote,
because it's read-only. But it does let exported files be downloaded
from it.
Configuration of encryption and chunking is inherited from the other
special remote, and does not need to be specified when initializing the
httpalso remote.