diff --git a/docs/backends/scaleway.rst b/docs/backends/scaleway.rst new file mode 100644 index 00000000..4f94cd4b --- /dev/null +++ b/docs/backends/scaleway.rst @@ -0,0 +1,23 @@ +Scaleway +============= + +Scaleway Object storage implements the S3 protocol. To use it follow the instructions in the :doc:`Amazon S3 docs ` 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, with django storages set as DEFAULT_FILE_STORAGE, if you wrote a file like so: + + + from django.core.files.storage import default_storage + file = default_storage.open("my_chosen_file.txt", "w") + file.write("storage contents") + file.close() + +If would be written to the following address: + +https://s3.nl-ams.scw.cloud/my-chosen-bucket/my_chosen_file.txt +