Skip to content

Scrapy, a fast high-level web crawling & scraping framework for Python.

Document S3 capabilities in FilesPipeline and ImagesPipeline

Jesús Losadac6a2ca4e933a
diff --git a/docs/topics/media-pipeline.rst b/docs/topics/media-pipeline.rst
index f18789ab0..7f0cb1ba6 100644
--- a/docs/topics/media-pipeline.rst
+++ b/docs/topics/media-pipeline.rst
@@ -117,7 +117,7 @@ Supported Storage
=================
File system is currently the only officially supported storage, but there is
-also (undocumented) support for storing files in `Amazon S3`_.
+also support for storing files in `Amazon S3`_.
.. _Amazon S3: https://aws.amazon.com/s3/
@@ -146,6 +146,23 @@ Where:
* ``full`` is a sub-directory to separate full images from thumbnails (if
used). For more info see :ref:`topics-images-thumbnails`.
+Amazon S3 storage
+-----------------
+
+.. setting:: FILES_STORE_S3_ACL
+.. setting:: IMAGES_STORE_S3_ACL
+
+:setting:`FILES_STORE` and :setting:`IMAGES_STORE` can represent an Amazon S3
+bucket. Scrapy will automatically upload the files to the bucket.
+
+For example, this is a valid :setting:`IMAGES_STORE` value::
+
+ IMAGES_STORE = 's3://bucket/images'
+
+You can modify the Access Control List (ACL) policy used for the stored files,
+which is defined by the :setting:`FILES_STORE_S3_ACL` and
+:setting:`IMAGES_STORE_S3_ACL` settings. By default, the ACL is set to
+``private``.
Usage example
=============
diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst
index c845c59b9..b8d87bbe4 100644
--- a/docs/topics/settings.rst
+++ b/docs/topics/settings.rst
@@ -689,15 +689,6 @@ temporary files before uploading with :ref:`FTP feed storage <topics-feed-storag
:ref:`Amazon S3 <topics-feed-storage-s3>`.
-.. setting:: FILES_STORE_S3_ACL
-
-FILES_STORE_S3_ACL
-------------------
-
-Default: ``'private'``
-
-S3-specific access control policy (ACL) for S3 files store.
-
.. setting:: ITEM_PIPELINES
ITEM_PIPELINES