nextcloud / nextcloud/documentation
(admin manual) Document S3 compatibility requirements
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 628
- Forks
- 2.5k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 135
Description
We should try to document the knowable requirements we have for S3 in a generic manner.
We should perhaps mention what we test again (i.e. MinIO).
Then also consider including specifics for some of the more common platforms/providers (to be added to over time).
Some platforms and providers are not compliant enough with AWS S3 to work with NC. Others are compatible, but only if certain changes are made to their default configuration. Others work fine but sometimes use different terminology.
This is becoming an issue as people experiment with using the S3 support with more platforms.
- B2 S3 mode seems to work as-is (these days)
- GCS requires switching from what they call "Uniform" mode to ACL mode
- etc.
Various related Issues:
(to be added)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the admin manual's existing S3 support documentation and reviewing the linked server issue 35364. Compare the documented behavior for MinIO, B2 S3 mode, and GCS, then add the knowable compatibility requirements and provider-specific configuration notes; done means users can determine whether a platform works and what changes it needs.
Written by the indexing model from the issue text.
Assessment
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100