Configuration options for your
.. envvar:: ALLOW_BAKERY_AUTO_PUBLISHING Decides whether the `AutoPublishingBuildableModel` is allowed to run the `publish` management command as part of its background task. True by default.
# So if you are in your dev environment and want to prevent # the task from publishing to s3, do this. ALLOW_BAKERY_AUTO_PUBLISHING = False
.. envvar:: BUILD_DIR The location on the filesystem where you want the flat files to be built.
BUILD_DIR = '/home/you/code/your-site/build/' # I like something a little snappier like... import os BUILD_DIR = os.path.join(__file__, 'build')
.. envvar:: BAKERY_FILESYSTEM Files are built using `PyFilesystem <https://docs.pyfilesystem.org/en/latest/index.html>`_, a module that provides a common interface to a variety of filesystem backends. The default setting is the `OS filesystem <https://docs.pyfilesystem.org/en/latest/reference/osfs.html>`_ backend that saves files to the local directory structure. If you don't set the variable, it will operates as follows: .. code-block:: python BAKERY_FILESYSTEM = 'osfs:///' Here's how you could change to an `in-memory backend <https://docs.pyfilesystem.org/en/latest/reference/memoryfs.html>`_ instead. The complete list of alternatives are documented `here <https://docs.pyfilesystem.org/en/latest/builtin.html>`_. .. code-block:: python BAKERY_FILESYSTEM = 'mem://'
.. envvar:: BAKERY_VIEWS The list of views you want to be built out as flat files when the ``build`` :doc:`management command </managementcommands>` is executed.
BAKERY_VIEWS = ( 'myapp.views.ExampleListView', 'myapp.views.ExampleDetailView', 'myapp.views.MyRSSView', 'myapp.views.MySitemapView', )
.. envvar:: AWS_BUCKET_NAME The name of the `Amazon S3 "bucket" <http://aws.amazon.com/s3/>`_ on the Internet were you want to publish the flat files in your local ``BUILD_DIR``.
AWS_BUCKET_NAME = 'your-bucket'
.. envvar:: AWS_ACCESS_KEY_ID A part of your secret Amazon Web Services credentials. Necessary to upload files to S3.
AWS_ACCESS_KEY_ID = 'your-key'
.. envvar:: AWS_SECRET_ACCESS_KEY A part of your secret Amazon Web Services credentials. Necessary to upload files to S3.
AWS_SECRET_ACCESS_KEY = 'your-secret-key'
.. envvar:: AWS_REGION The name of the Amazon Web Services' region where the S3 bucket is stored. Results depend on the endpoint and region, but if you are not using the default ``us-east-1`` region you may need to set this variable.
AWS_REGION = 'us-west-2'
.. envvar:: AWS_S3_ENDPOINT The URL to use when connecting with Amazon Web Services' S3 system. If the setting is not provided the boto package's default is used.
# Substitute in Amazon's accelerated upload service AWS_S3_ENDPOINT = 'https://s3-accelerate.amazonaws.com' # Specify the region of the bucket to work around bugs with S3 in certain version of boto AWS_S3_ENDPOINT = 'https://s3-%s.amazonaws.com' % AWS_REGION
.. envvar:: BAKERY_GZIP Opt in to automatic gzipping of your files in the build method and addition of the required headers when deploying to Amazon S3. Defaults to ``False``.
BAKERY_GZIP = True
.. envvar:: DEFAULT_ACL Set the access control level of the files uploaded. Defaults to 'public-read'
# defaults to 'public-read', DEFAULT_ACL = 'public-read'
.. envvar:: BAKERY_CACHE_CONTROL Set cache-control headers based on content type. Headers are set using the ``max-age=`` format so the passed values should be in seconds (``'text/html': 900`` would result in a ``Cache-Control: max-age=900`` header for all ``text/html`` files). By default, none are set.