gaul/s3proxy: Redaktioneller README-Leitfaden

gaul/s3proxy beschreibt sich im README als „Access other storage backends via the S3 API". Dieser Text bleibt bei Fakten, die im Repository überprüfbar sind. Sterne, Forks und Badges zeigen Aufmerksamkeit, aber keine Qualität. Unter „S3Proxy" steht: S3Proxy implements the S3 API and proxies requests, enabling several use cases:. Das beschreibt den vorgesehenen Umfang, nicht einen Produktionstest.

Der Abschnitt „S3Proxy" zeigt, für welches Problem das Projekt gedacht ist: testing without Amazon by using the local filesystem. Passt dieses Problem nicht zu deinem Fall, ist Popularität kein ausreichender Grund. Namen, Befehle und Komponenten bleiben unverändert, damit Leser die Primärquelle ohne neue Begriffe vergleichen können. Ein weiterer überprüfbarer README-Punkt lautet: translation from S3 to Backblaze B2, EMC Atmos, Google Cloud, Microsoft Azure, and OpenStack Swift. Er hilft beim ersten Test, ersetzt aber keinen Test in der vorgesehenen Umgebung.

Die Betriebsweise verteilt sich auf Abschnitte wie „Usage without Docker". Die Quelle nennt: Users can download releases from GitHub. Developers can build the project by running mvn package which produces a binary at target/s3proxy. S3Proxy requires Java 17 or newer to run.. Fehlende Angaben zu Architektur, Leistung oder Sicherheit werden nicht ergänzt. Vor einem echten Einsatz müssen Repository-Struktur, Konfigurationsdateien und Release-Verlauf geprüft werden.

Beginne die Installation am dokumentierten README-Einstieg. Ein überprüfbarer Befehl ist: $ curl --request PUT http://localhost:8080/testbucket $ curl http://localhost:8080/ <?xml version="1.0" ?><ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Owner><ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID><DisplayName>CustomersName@amazon.com</DisplayName></Owner><Buckets><Bucket><Name>testbucket</Name><CreationDate>2015-08-05T22:16:24.000Z</CreationDate></Bucket></Buckets></ListAllMyBucketsResult> Wenn kein ausführbarer Befehl vorhanden ist, wird hier keiner erfunden. Prüfe den Abschnitt „Usage with Docker" auf Abhängigkeiten, Standardports und die Einrichtung beim ersten Start.