For local web development
coltrane uses an
.env file in the base directory for potentially sensitive settings. When deployed to production, those settings would be retrieved from environment variables (following the 12-factor app method).
Whether the server is in debug mode or not. Error tracebacks, context, and sensitive information is displayed on the error page when this is set to
True, so it should always be set to
False when the app is deployed to production. Defaults to
True for local development purposes.
Used to determine if the current request is internal or not. Must be set for the
debug template variable to be populated (more information in the Django documentation). Defaults to
127.0.0.1. If more than one IP is required, separate them by commas.
A random string of letters, numbers, and characters. (More information in the Django documentation. Generated automatically when the
.env file is created. Required.
The acceptable host or domain names when the site is deployed to production. Required when
DEBUG is set to
False. Defaults to
"". If more than one host name is required, separate them by commas.
The hosting domain’s scheme and domain. Required.
The title of the website. Required for generating
The description of the website. Required for generating
COLTRANE_DESCRIPTION=A simple content site framework that harnesses the power of Django without the hassle.
coltrane that it is served securely, i.e. with SSL with an
https protocol. This needs to be set to
True if SSL is provided by a proxy server (for example, Cloudflare). If the site is only served by
https and you see errors like “403 forbidden CSRF origin didn’t match” set this to
True. Defaults to
The directory that should be used for
markdown content. Relative to the base directory. Defaults to “content”.
The directory that should be used for data. Relative to the base directory. Defaults to “data”.
Whether or not data files should be parsed as JSON5. Also requires installing with the
json5 extras (e.g.
poetry add coltrane -E json5 or
pip install coltrane[json5]). Defaults to
To prevent wildcard templates from being served, set this to
True. Defaults to
redis options require
CACHE_LOCATION to also be set.
The location of the cache. Required for
redis cache options. The
filesystem cache requires an absolute path. The
redis cache options include multiple cache servers in a commma-delimited list.