Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,12 @@ of these settings or provide values to mandatory fields.
- **Type:** `integer`
- **Default:** `900`

- **`SS_SILENCED_SYSTEM_CHECKS`**:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think of dropping SS_ prefix? We are not really consistent but most of the Django related variables don't have it. Also could we move this documentation bit after the SECRET_KEY variable?

- **Description:** comma-separated list of ignored system checks.
e.g. mysql.W002,models.W042
Comment on lines +227 to +228
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a link to https://docs.djangoproject.com/en/4.2/ref/settings/#silenced-system-checks here. See examples in TIME_ZONE or SECRET_KEY above.

- **Type:** `string`
- **Default:** `None`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Default:** `None`
- **Default:** `""`


The configuration of the database is also declared via environment variables.
Storage Service looks up the `SS_DB_URL` environment string. If defined, its
value is expected to follow the form described in the [dj-database-url docs],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -754,3 +754,5 @@ def _get_email(email):
)
INSTALLED_APPS = INSTALLED_APPS + ["django_prometheus"]
LOGIN_EXEMPT_URLS.append(r"^metrics$")

SILENCED_SYSTEM_CHECKS = environ.get("SS_SILENCED_SYSTEM_CHECKS", "[]")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're expecting the user to set a comma separated list it needs to be converted to a list here:

Suggested change
SILENCED_SYSTEM_CHECKS = environ.get("SS_SILENCED_SYSTEM_CHECKS", "[]")
SILENCED_SYSTEM_CHECKS = environ.get("SS_SILENCED_SYSTEM_CHECKS", "").split(",")