NetBox-Docker Okta & Google SSO Environment Additions #1475
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue: #1139
New Behavior
Adds native support for SSO configuration through environment variables and Docker secrets for OKTA OpenID Connect and Google OAuth2 providers. Users can now configure SSO authentication without needing to modify the
configuration.py
file directly.Contrast to Current Behavior
Previously, users had to manually edit the
configuration.py
file to add SSO provider configurations. Now, SSO can be configured using standard environment variables and Docker secrets, following the same patterns used for other NetBox configuration options like database and Redis settings.Discussion: Benefits and Drawbacks
Benefits:
Drawbacks:
Backwards Compatibility:
Changes to the Wiki
The Wiki should be updated to document the new SSO environment variables:
Suggested Wiki additions:
env/netbox.env
anddocker-compose.override.yml.example
filesProposed Release Note Entry
Added SSO environment variable support: OKTA OpenID Connect and Google OAuth2 can now be configured using environment variables and Docker secrets without modifying configuration.py. New variables:
SOCIAL_AUTH_OKTA_OPENIDCONNECT_KEY/SECRET/API_URL
andSOCIAL_AUTH_GOOGLE_OAUTH2_KEY/SECRET
. Secrets support Docker secrets namedokta_openidconnect_secret
andgoogle_oauth2_secret
.Double Check
develop
branch.