Permit loading settings from a designated external module #9670

Closed
opened 2025-12-29 21:20:40 +01:00 by adam · 0 comments
Owner

Originally created by @jeremystretch on GitHub (May 14, 2024).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v4.0.1

Feature type

New functionality

Proposed functionality

Extend settings.py to load arbitrary settings from a designated external module (local_settings.py), if it exists, and set settings._UNSUPPORTED_SETTINGS to true, indicating the use of unsupported settings.

Use case

This will permit an administrator to extend or override NetBox's core settings without needing to modify the core code base.

As we (the maintainers) cannot predict what changes may be made by an external module, modification to the core settings is entirely unsupported. If in use, users will need to remove local_settings.py and re-test for any suspect behavior prior to submitting a bug report.

Database changes

None

External dependencies

None

Originally created by @jeremystretch on GitHub (May 14, 2024). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v4.0.1 ### Feature type New functionality ### Proposed functionality Extend `settings.py` to load arbitrary settings from a designated external module (`local_settings.py`), if it exists, and set `settings._UNSUPPORTED_SETTINGS` to true, indicating the use of unsupported settings. ### Use case This will permit an administrator to extend or override NetBox's core settings without needing to modify the core code base. As we (the maintainers) cannot predict what changes may be made by an external module, **modification to the core settings is entirely unsupported.** If in use, users will need to remove `local_settings.py` and re-test for any suspect behavior prior to submitting a bug report. ### Database changes None ### External dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 21:20:40 +01:00
adam closed this issue 2025-12-29 21:20:41 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#9670