diff --git a/Providers.md b/Providers.md new file mode 100644 index 0000000..553fe2d --- /dev/null +++ b/Providers.md @@ -0,0 +1,10 @@ +## Details + +`repertory` supports 3 different back-end providers: `S3`, `Sia` via `renterd` and `encryption`. + +### S3 + +* The S3 provider utilizes the de facto standard AWS S3 HTTP REST API via `libcurl` +* An access key and secret key are required for operation, configured via `S3Config.AccessKey` and `S3Config.SecretKey` in `config.json` +* A bucket name is required, configured via `S3Config.Bucket` in `config.json` +* Both path-style and virtual hosted-style are supported, configured via the `S3Config.UsePathStyle` setting in `config.json` \ No newline at end of file