[docs/scaleway] Create Scaleway docs (#1419)

jschneier · Jul 6, 2024 · 6c494a0 · 6c494a0
1 parent efe5b2a
commit 6c494a0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/backends/s3_compatible/index.rst b/docs/backends/s3_compatible/index.rst
@@ -13,3 +13,4 @@ backend for some of the most popular.
    cloudflare-r2
    digital-ocean-spaces
    oracle-cloud
+   scaleway
diff --git a/docs/backends/s3_compatible/scaleway.rst b/docs/backends/s3_compatible/scaleway.rst
@@ -0,0 +1,15 @@
+Scaleway
+========
+
+`Scaleway Object Storage <https://www.scaleway.com/en/docs/storage/object/>`_ implements the S3 protocol. To use it follow the instructions in the :doc:`Amazon S3 docs <../amazon-S3>` with the important caveats that you must:
+
+- Set ``AWS_BUCKET_NAME`` to the Bucket you want write to (such as ``my-chosen-bucket``)
+- Set ``AWS_S3_REGION_NAME`` to your Scaleway region (such as ``nl-ams`` or ``fr-par``)
+- Set ``AWS_S3_ENDPOINT_URL`` to the value of ``https://s3.${AWS_S3_REGION_NAME}.scw.cloud``
+- Set ``AWS_ACCESS_KEY_ID`` to the value of your Access Key ID (i.e. ``SCW3XXXXXXXXXXXXXXXX``)
+- Set ``AWS_SECRET_ACCESS_KEY`` to the value of your Secret Key (i.e. ``abcdef10-ab12-cd34-ef56-acbdef123456``)
+
+With the settings above in place, saving a file with a name such as "my_chosen_file.txt" would be written to the following addresses:
+
+``https://s3.nl-ams.scw.cloud/my-chosen-bucket/my_chosen_file.txt``
+``https://my-chosen-bucket.s3.nl-ams.scw.cloud/my_chosen_file.txt``