garagehq.deuxfleurs.fr/content/documentation/reference-manual/s3_compatibility.md

+++
title = "S3 Compatibility status"
weight = 20
+++


## Global S3 features

Implemented:

- path-style URLs (`garage.tld/bucket/key`)
- vhost-style URLs (`bucket.garage.tld/key`)
- putting and getting objects in buckets
- multipart uploads
- listing objects
- access control on a per-key-per-bucket basis

Not implemented:

- object-level ACL
- [object versioning](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/166)
- encryption
- most `x-amz-` headers


## Endpoint implementation

All APIs that are not mentionned are not implemented and will return a 501 Not Implemented.

| Endpoint                     | Status                           |
|------------------------------|----------------------------------|
| AbortMultipartUpload         | Implemented                      |
| CompleteMultipartUpload      | Implemented                      |
| CopyObject                   | Implemented                      |
| CreateBucket                 | Implemented                      |
| CreateMultipartUpload        | Implemented                      |
| DeleteBucket                 | Implemented                      |
| DeleteBucketWebsite          | Implemented                      |
| DeleteObject                 | Implemented                      |
| DeleteObjects                | Implemented                      |
| GetBucketLocation            | Implemented                      |
| GetBucketVersioning          | Stub (see below)                 |
| GetBucketWebsite             | Implemented                      |
| GetObject                    | Implemented                      |
| HeadBucket                   | Implemented                      |
| HeadObject                   | Implemented                      |
| ListBuckets                  | Implemented                      |
| ListObjects                  | Implemented, bugs? (see below)   |
| ListObjectsV2                | Implemented                      |
| ListMultipartUpload          | Implemented                      |
| ListParts                    | Implemented                      |
| PutObject                    | Implemented                      |
| PutBucketWebsite             | Partially implemented (see below)|
| UploadPart                   | Implemented                      |
| UploadPartCopy               | Implemented                      |


- **GetBucketVersioning:** Stub implementation (Garage does not yet support versionning so this always returns
"versionning not enabled").

- **ListObjects:** Implemented, but there isn't a very good specification of what `encoding-type=url` covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2.

- **PutBucketWebsite:** Implemented, but only stores the index document suffix and the error document path. Redirects are not supported.
Added markdown fake metadata to doc content 2022-01-24 20:08:34 +00:00			`+++`
Organized doc md with metadata & draft for doc template 2022-01-25 14:27:39 +00:00			`title = "S3 Compatibility status"`
			`weight = 20`
Added markdown fake metadata to doc content 2022-01-24 20:08:34 +00:00			`+++`

Added doc book 2022-01-24 19:58:36 +00:00
			`## Global S3 features`

			`Implemented:`

			- path-style URLs (`garage.tld/bucket/key`)
			- vhost-style URLs (`bucket.garage.tld/key`)
			`- putting and getting objects in buckets`
			`- multipart uploads`
			`- listing objects`
			`- access control on a per-key-per-bucket basis`

			`Not implemented:`

			`- object-level ACL`
			`- [object versioning](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/166)`
			`- encryption`
			- most `x-amz-` headers


			`## Endpoint implementation`

			`All APIs that are not mentionned are not implemented and will return a 501 Not Implemented.`

			`\| Endpoint \| Status \|`
			`\|------------------------------\|----------------------------------\|`
			`\| AbortMultipartUpload \| Implemented \|`
			`\| CompleteMultipartUpload \| Implemented \|`
			`\| CopyObject \| Implemented \|`
			`\| CreateBucket \| Implemented \|`
			`\| CreateMultipartUpload \| Implemented \|`
			`\| DeleteBucket \| Implemented \|`
			`\| DeleteBucketWebsite \| Implemented \|`
			`\| DeleteObject \| Implemented \|`
			`\| DeleteObjects \| Implemented \|`
			`\| GetBucketLocation \| Implemented \|`
			`\| GetBucketVersioning \| Stub (see below) \|`
			`\| GetBucketWebsite \| Implemented \|`
			`\| GetObject \| Implemented \|`
			`\| HeadBucket \| Implemented \|`
			`\| HeadObject \| Implemented \|`
			`\| ListBuckets \| Implemented \|`
			`\| ListObjects \| Implemented, bugs? (see below) \|`
			`\| ListObjectsV2 \| Implemented \|`
			`\| ListMultipartUpload \| Implemented \|`
			`\| ListParts \| Implemented \|`
			`\| PutObject \| Implemented \|`
			`\| PutBucketWebsite \| Partially implemented (see below)\|`
			`\| UploadPart \| Implemented \|`
			`\| UploadPartCopy \| Implemented \|`


			`- GetBucketVersioning: Stub implementation (Garage does not yet support versionning so this always returns`
			`"versionning not enabled").`

			- ListObjects: Implemented, but there isn't a very good specification of what `encoding-type=url` covers so there might be some encoding bugs. In our implementation the url-encoded fields are in the same in ListObjects as they are in ListObjectsV2.

			`- PutBucketWebsite: Implemented, but only stores the index document suffix and the error document path. Redirects are not supported.`