From 8e9d504db2f1207a09fb34c1c13d58894534aebd Mon Sep 17 00:00:00 2001 From: Elliott Balsley <3991046+llamafilm@users.noreply.github.com> Date: Sun, 10 Mar 2024 12:28:25 -0700 Subject: [PATCH] add REMOTE_AUTH_DISPLAYNAME setting --- docs/configuration/remote-authentication.md | 8 ++++++++ netbox/netbox/authentication.py | 2 ++ netbox/netbox/settings.py | 1 + 3 files changed, 11 insertions(+) diff --git a/docs/configuration/remote-authentication.md b/docs/configuration/remote-authentication.md index e7fe56a09..46601fabd 100644 --- a/docs/configuration/remote-authentication.md +++ b/docs/configuration/remote-authentication.md @@ -47,6 +47,14 @@ A mapping of permissions to assign a new user account when created using remote --- +# REMOTE_AUTH_DISPLAYNAME + +Default: None + +An optional string to override the auth provider display name on the login page. + +--- + ## REMOTE_AUTH_ENABLED Default: `False` diff --git a/netbox/netbox/authentication.py b/netbox/netbox/authentication.py index 10555b373..14e47a79a 100644 --- a/netbox/netbox/authentication.py +++ b/netbox/netbox/authentication.py @@ -55,6 +55,8 @@ def get_auth_backend_display(name): Return the user-friendly name and icon name for a remote authentication backend, if known. Defaults to the raw backend name and no icon. """ + if settings.REMOTE_AUTH_DISPLAYNAME: + return settings.REMOTE_AUTH_DISPLAYNAME, AUTH_BACKEND_ATTRS.get(name, (name, None))[1] return AUTH_BACKEND_ATTRS.get(name, (name, None)) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 52b085b33..369dafe9c 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -142,6 +142,7 @@ REMOTE_AUTH_AUTO_CREATE_GROUPS = getattr(configuration, 'REMOTE_AUTH_AUTO_CREATE REMOTE_AUTH_BACKEND = getattr(configuration, 'REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend') REMOTE_AUTH_DEFAULT_GROUPS = getattr(configuration, 'REMOTE_AUTH_DEFAULT_GROUPS', []) REMOTE_AUTH_DEFAULT_PERMISSIONS = getattr(configuration, 'REMOTE_AUTH_DEFAULT_PERMISSIONS', {}) +REMOTE_AUTH_DISPLAYNAME = getattr(configuration, 'REMOTE_AUTH_DISPLAYNAME', None) REMOTE_AUTH_ENABLED = getattr(configuration, 'REMOTE_AUTH_ENABLED', False) REMOTE_AUTH_HEADER = getattr(configuration, 'REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER') REMOTE_AUTH_USER_FIRST_NAME = getattr(configuration, 'REMOTE_AUTH_USER_FIRST_NAME', 'HTTP_REMOTE_USER_FIRST_NAME')