git-annex/doc/special_remotes/web.mdwn
Joey Hess 6fa166e1fc
web: Add urlinclude and urlexclude configuration settings
Sponsored-by: Dartmouth College's DANDI project
2023-01-09 17:16:53 -04:00

27 lines
1.2 KiB
Markdown

git-annex can use the web as a special remote, associating an url with an
annexed file, and downloading the file content from the web.
See [[tips/using_the_web_as_a_special_remote]] for usage examples.
The web special remote is always enabled, without any manual setup being
needed. Its name is "web".
This special remote can only be used for downloading content,
not uploading content, or removing content from the web.
This special remote uses urls on the web as the source for content.
There are several other ways http can be used to download annexed objects,
including a git remote accessible by http, S3 with a `publicurl` configured,
and the [[httpalso]] special remote.
## configuration
These parameters can be passed to `git annex initremote` or
`git-annex enableremote` to configure a web remote:
* `urlinclude` - Only use urls that match the specified glob.
For example, `urlinclude="https://s3.amazonaws.com/*"`
Note: Globs are matched case-insensitively.
* `urlexclude` - Don't use urls that match the specified glob.
For example, to prohibit http urls, but allow https,
use `urlexclude="http:*"`
Note: Globs are matched case-insensitively.