aboutsummaryrefslogtreecommitdiff
path: root/test/s3/compatibility/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/s3/compatibility/README.md')
-rw-r--r--test/s3/compatibility/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/test/s3/compatibility/README.md b/test/s3/compatibility/README.md
new file mode 100644
index 000000000..de1b6e9ec
--- /dev/null
+++ b/test/s3/compatibility/README.md
@@ -0,0 +1,13 @@
+# Running S3 Compatibility tests against SeaweedFS
+
+This is using [the tests from CephFS](https://github.com/ceph/s3-tests).
+
+## Prerequisites
+
+- have Docker installed
+- this has been executed on Mac. On Linux, the hostname in `s3tests.conf` needs to be adjusted.
+
+## Running tests
+
+- `./prepare.sh` to build the docker image
+- `./run.sh` to execute all tests