configuration_example.py has inaccurate STORAGE_BACKEND examples #11242

New Issue

adam · 2025-12-29T21:42:23+01:00

adam commented

2025-12-29 21:42:23 +01:00

Originally created by @gizmonicus on GitHub (May 30, 2025).

Originally assigned to: @gizmonicus on GitHub.

Change Type

Correction

Area

Configuration

Proposed Changes

Now that STORAGES is the preferred configuration directive, the example configuration file (configuration_example.py) should be updated to reflect the change.

Something like this maybe?

# Within the STORAGES dictionary, "default" is used for image uploads,
# "staticfiles" is for static files and "scripts" is used for custom scripts.
# See django-storages and django-storage-swift libraries for more details.
# By default the following configuration is used:
# STORAGES = {
#     "default": {
#         "BACKEND": "django.core.files.storage.FileSystemStorage",
#     },
#     "staticfiles": {
#         "BACKEND": "django.contrib.staticfiles.storage.StaticFilesStorage",
#     },
#     "scripts": {
#         "BACKEND": "extras.storage.ScriptFileSystemStorage",
#     },
# }

Originally created by @gizmonicus on GitHub (May 30, 2025). Originally assigned to: @gizmonicus on GitHub. ### Change Type Correction ### Area Configuration ### Proposed Changes Now that STORAGES is the preferred configuration directive, the example configuration file (configuration_example.py) should be updated to reflect the change. Something like this maybe? ``` # Within the STORAGES dictionary, "default" is used for image uploads, # "staticfiles" is for static files and "scripts" is used for custom scripts. # See django-storages and django-storage-swift libraries for more details. # By default the following configuration is used: # STORAGES = { # "default": { # "BACKEND": "django.core.files.storage.FileSystemStorage", # }, # "staticfiles": { # "BACKEND": "django.contrib.staticfiles.storage.StaticFilesStorage", # }, # "scripts": { # "BACKEND": "extras.storage.ScriptFileSystemStorage", # }, # } ```

adam added the status: accepted type: documentation labels 2025-12-29 21:42:23 +01:00

adam closed this issue

2025-12-29 21:42:23 +01:00

adam commented

2025-12-29 21:42:24 +01:00

@jnovinger commented on GitHub (Jun 4, 2025):

Is this something you'd like to contribute, @gizmonicus ?

@jnovinger commented on GitHub (Jun 4, 2025): Is this something you'd like to contribute, @gizmonicus ?

adam commented

2025-12-29 21:42:24 +01:00

@gizmonicus commented on GitHub (Jun 4, 2025):

Is this something you'd like to contribute, @gizmonicus

Sure. I'll have to figure out how to do a pull request but I'm happy to do that. I'll read the contributing guide and give it a go.

@gizmonicus commented on GitHub (Jun 4, 2025): > Is this something you'd like to contribute, [@gizmonicus](https://github.com/gizmonicus) Sure. I'll have to figure out how to do a pull request but I'm happy to do that. I'll read the contributing guide and give it a go.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#11242