mirror of https://github.com/snachodog/mybuddy.git
Improve and clarify proxy environment variables documentation
This commit is contained in:
Christopher C. Wells
Christopher Charbonneau Wells
parent
c2afa80845
commit
a772f0d691
|
|
@ -7,23 +7,33 @@ take precedence over the contents of an `.env` file.**
|
|||
|
||||
## `ALLOWED_HOSTS`
|
||||
|
||||
*Default: * (any)*
|
||||
*Default:* `*` (any host)
|
||||
|
||||
Set this variable to a single host or comma-separated list of hosts without spaces.
|
||||
This should *always* be set to a specific host or hosts in production deployments.
|
||||
|
||||
See also: [Django's documentation on the ALLOWED_HOSTS setting](https://docs.djangoproject.com/en/4.0/ref/settings/#allowed-hosts)
|
||||
Do not include schemes ("http" or "https") with this setting.
|
||||
|
||||
**Example value**
|
||||
|
||||
baby.example.test,baby.example2.test
|
||||
|
||||
**See also**
|
||||
|
||||
- [Django's documentation on the ALLOWED_HOSTS setting](https://docs.djangoproject.com/en/4.0/ref/settings/#allowed-hosts)
|
||||
- [`CSRF_TRUSTED_ORIGINS`](#csrf_trusted_origins)
|
||||
- [`SECURE_PROXY_SSL_HEADER`](#secure_proxy_ssl_header)
|
||||
|
||||
## `ALLOW_UPLOADS`
|
||||
|
||||
*Default: True*
|
||||
*Default:* `True`
|
||||
|
||||
Whether to allow uploads (e.g., of Child photos). For some deployments (Heroku)
|
||||
this setting will default to False due to the lack of available persistent storage.
|
||||
|
||||
## `AWS_ACCESS_KEY_ID`
|
||||
|
||||
*Default: None*
|
||||
*Default:* `None`
|
||||
|
||||
Required to access your AWS S3 bucket, should be uniquely generated per bucket
|
||||
for security.
|
||||
|
|
@ -32,7 +42,7 @@ See also: [`AWS_STORAGE_BUCKET_NAME`](#aws_storage_bucket_name)
|
|||
|
||||
## `AWS_SECRET_ACCESS_KEY`
|
||||
|
||||
*Default: None*
|
||||
*Default:* `None`
|
||||
|
||||
Required to access your AWS S3 bucket, should be uniquely generated per bucket
|
||||
for security.
|
||||
|
|
@ -41,7 +51,7 @@ See also: [`AWS_STORAGE_BUCKET_NAME`](#aws_storage_bucket_name)
|
|||
|
||||
## `AWS_STORAGE_BUCKET_NAME`
|
||||
|
||||
*Default: None*
|
||||
*Default:* `None`
|
||||
|
||||
If you would like to use AWS S3 for storage on ephemeral storage platforms like
|
||||
Heroku you will need to create a bucket and add its name. See django-storages'
|
||||
|
|
@ -49,18 +59,26 @@ Heroku you will need to create a bucket and add its name. See django-storages'
|
|||
|
||||
## `CSRF_TRUSTED_ORIGINS`
|
||||
|
||||
*Default: None*
|
||||
*Default:* `None`
|
||||
|
||||
If Baby Buddy is behind a proxy, you may need add the domain to this setting for form
|
||||
submission to work correctly.
|
||||
If Baby Buddy is behind a proxy, you may need add all possible origins to this setting
|
||||
for form submission to work correctly. Separate multiple origins with commas.
|
||||
|
||||
See also [Django's documentation on the `CSRF_TRUSTED_ORIGINS` setting](https://docs.djangoproject.com/en/4.0/ref/settings/#std:setting-CSRF_TRUSTED_ORIGINS)
|
||||
and the [`SECURE_PROXY_SSL_HEADER`](#secure_proxy_ssl_header) environment variable.
|
||||
Each entry must contain both the scheme (http, https) and fully-qualified domain name.
|
||||
|
||||
**Example value**
|
||||
|
||||
https://baby.example.test,http://baby.example2.test,http://babybudy
|
||||
|
||||
**See also**
|
||||
|
||||
- [Django's documentation on the `CSRF_TRUSTED_ORIGINS` setting](https://docs.djangoproject.com/en/4.0/ref/settings/#std:setting-CSRF_TRUSTED_ORIGINS)
|
||||
- [`ALLOWED_HOSTS`](#allowed_hosts)
|
||||
- [`SECURE_PROXY_SSL_HEADER`](#secure_proxy_ssl_header)
|
||||
|
||||
## `DB_ENGINE`
|
||||
|
||||
*Default: django.db.backends.postgresql*
|
||||
*Default:* `django.db.backends.postgresql`
|
||||
|
||||
The database engine utilized for the deployment.
|
||||
|
||||
|
|
@ -68,38 +86,38 @@ See also [Django's documentation on the ENGINE setting](https://docs.djangoproje
|
|||
|
||||
## `DB_HOST`
|
||||
|
||||
*Default: db*
|
||||
*Default:* `db`
|
||||
|
||||
The name of the database host for the deployment.
|
||||
|
||||
## `DB_NAME`
|
||||
|
||||
*Default: postgres*
|
||||
*Default:* `postgres`
|
||||
|
||||
The name of the database table utilized for the deployment.
|
||||
|
||||
## `DB_PASSWORD`
|
||||
|
||||
*No Default*
|
||||
*Default:* `None`
|
||||
|
||||
The password for the database user for the deployment. In the default example,
|
||||
this is the root PostgreSQL password.
|
||||
|
||||
## `DB_PORT`
|
||||
|
||||
*Default: 5432*
|
||||
*Default:* `5432`
|
||||
|
||||
The listening port for the database. The default port is 5432 for PostgreSQL.
|
||||
|
||||
## `DB_USER`
|
||||
|
||||
*Default: postgres*
|
||||
*Default:* `postgres`
|
||||
|
||||
The database username utilized for the deployment.
|
||||
|
||||
## `DEBUG`
|
||||
|
||||
*Default: False*
|
||||
*Default:* `False`
|
||||
|
||||
When in debug mode, Baby Buddy will print much more detailed error information
|
||||
for exceptions. This setting should be *False* in production deployments.
|
||||
|
|
@ -108,21 +126,21 @@ See also [Django's documentation on the DEBUG setting](https://docs.djangoprojec
|
|||
|
||||
## `NAP_START_MAX`
|
||||
|
||||
*Default: 18:00*
|
||||
*Default:* `18:00`
|
||||
|
||||
The maximum nap *start* time (in the instance's time zone). Expects the 24-hour
|
||||
format %H:%M.
|
||||
|
||||
## `NAP_START_MIN`
|
||||
|
||||
*Default: 06:00*
|
||||
*Default:* `06:00`
|
||||
|
||||
The minimum nap *start* time (in the instance's time zone). Expects the 24-hour
|
||||
format %H:%M.
|
||||
|
||||
## `SECRET_KEY`
|
||||
|
||||
*Default: None*
|
||||
*Default:* `None`
|
||||
|
||||
A random, unique string must be set as the "secret key" before Baby Buddy can
|
||||
be deployed and run.
|
||||
|
|
@ -131,37 +149,39 @@ See also [Django's documentation on the SECRET_KEY setting](https://docs.djangop
|
|||
|
||||
## `SECURE_PROXY_SSL_HEADER`
|
||||
|
||||
*Default: None*
|
||||
*Default:* `None`
|
||||
|
||||
If Baby Buddy is behind a proxy, you may need to set this to `True` in order to
|
||||
trust the `X-Forwarded-Proto` header that comes from your proxy, and any time
|
||||
its value is "https". This guarantees the request is secure (i.e., it originally
|
||||
came in via HTTPS).
|
||||
|
||||
:warning: Modifying this setting can compromise Baby Buddy’s security. Ensure
|
||||
you fully understand your setup before changing it.
|
||||
**See also**
|
||||
|
||||
See also [Django's documentation on the SECURE_PROXY_SSL_HEADER setting](https://docs.djangoproject.com/en/4.0/ref/settings/#secure-proxy-ssl-header).
|
||||
- [Django's documentation on the SECURE_PROXY_SSL_HEADER setting](https://docs.djangoproject.com/en/4.0/ref/settings/#secure-proxy-ssl-header)
|
||||
- [`ALLOWED_HOSTS`](#allowed_hosts)
|
||||
- [`CSRF_TRUSTED_ORIGINS`](#csrf_trusted_origins)
|
||||
|
||||
## `TIME_ZONE`
|
||||
|
||||
*Default: UTC*
|
||||
*Default:* `UTC`
|
||||
|
||||
The default time zone to use for the instance. See [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||
for all possible values. This value can be overridden per use from the user
|
||||
settings form.
|
||||
The default time zone to use for the instance. This value can be overridden per use from
|
||||
the user settings form.
|
||||
|
||||
**Example value**
|
||||
|
||||
America/Los_Angeles
|
||||
|
||||
**See also**
|
||||
|
||||
[List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||
|
||||
## `USE_24_HOUR_TIME_FORMAT`
|
||||
|
||||
*Default: False*
|
||||
*Default:* `False`
|
||||
|
||||
Whether to force 24-hour time format for locales that do not ordinarily use it
|
||||
(e.g. `en`). Support for this feature must be implemented on a per-locale basis.
|
||||
See format files under [`babybuddy/formats`](https://github.com/babybuddy/babybuddy/tree/master/babybuddy/formats)
|
||||
for supported locales.
|
||||
|
||||
Note: Baby Buddy interprets this value as a boolean from a string
|
||||
using Python's built-in [`strtobool`](https://docs.python.org/3/distutils/apiref.html#distutils.util.strtobool)
|
||||
tool. Only certain strings will work (e.g., "True" for `True` and "False" for
|
||||
`False`), other unrecognized strings will cause a `ValueError` and prevent Baby
|
||||
Buddy from loading.
|
||||
|
|
|
|||
Loading…
Reference in New Issue