Skip to content

Modern Docker Management, Designed for Everyone

feat: allow defining oidc provider name and logo (#1579)

Kyle Mendell0c7cd17acaac
diff --git a/backend/internal/config/config.go b/backend/internal/config/config.go
index 68ec5159d..b66c3f7fd 100644
--- a/backend/internal/config/config.go
+++ b/backend/internal/config/config.go
@@ -40,6 +40,8 @@ type Config struct {
OidcAdminValue string `env:"OIDC_ADMIN_VALUE" default:""`
OidcSkipTlsVerify bool `env:"OIDC_SKIP_TLS_VERIFY" default:"false"`
OidcAutoRedirectToProvider bool `env:"OIDC_AUTO_REDIRECT_TO_PROVIDER" default:"false"`
+ OidcProviderName string `env:"OIDC_PROVIDER_NAME" default:""`
+ OidcProviderLogoUrl string `env:"OIDC_PROVIDER_LOGO_URL" default:""`
DockerHost string `env:"DOCKER_HOST" default:"unix:///var/run/docker.sock"`
ProjectsDirectory string `env:"PROJECTS_DIRECTORY" default:"/app/data/projects"`
diff --git a/backend/internal/models/settings.go b/backend/internal/models/settings.go
index 98b2a7684..c0eb72761 100644
--- a/backend/internal/models/settings.go
+++ b/backend/internal/models/settings.go
@@ -91,6 +91,8 @@ type Settings struct {
OidcSkipTlsVerify SettingVariable `key:"oidcSkipTlsVerify,public,envOverride" meta:"label=OIDC Skip TLS Verify;type=boolean;keywords=oidc,tls,verify,skip,insecure;category=security;description=Skip TLS verification for OIDC provider"`
OidcAutoRedirectToProvider SettingVariable `key:"oidcAutoRedirectToProvider,public,envOverride" meta:"label=OIDC Auto Redirect;type=boolean;keywords=oidc,auto,redirect,automatic,login,provider,sso;category=security;description=Automatically redirect to OIDC provider on login page"`
OidcMergeAccounts SettingVariable `key:"oidcMergeAccounts,public,envOverride" meta:"label=OIDC Account Merging;type=boolean;keywords=oidc,merge,link,accounts,email,match,existing,users,combine;category=security;description=Allow OIDC logins to merge with existing accounts by email"`
+ OidcProviderName SettingVariable `key:"oidcProviderName,public,envOverride" meta:"label=OIDC Provider Name;type=text;keywords=oidc,provider,name,display,label,sso;category=security;description=Custom name for the OIDC provider (e.g., Authentik, Keycloak)"`
+ OidcProviderLogoUrl SettingVariable `key:"oidcProviderLogoUrl,public,envOverride" meta:"label=OIDC Provider Logo URL;type=text;keywords=oidc,provider,logo,url,image,icon,sso;category=security;description=Custom logo URL for the OIDC provider"`
// Appearance category
MobileNavigationMode SettingVariable `key:"mobileNavigationMode,public,local" meta:"label=Mobile Navigation Mode;type=select;keywords=mode,style,type,floating,docked,position,layout,design,appearance,bottom;category=appearance;description=Choose between floating or docked navigation on mobile" catmeta:"id=appearance;title=Appearance;icon=appearance;url=/settings/appearance;description=Customize navigation, theme, and interface behavior"`
diff --git a/backend/internal/services/auth_service.go b/backend/internal/services/auth_service.go
index 1b9b3c5cc..2e018f848 100644
--- a/backend/internal/services/auth_service.go
+++ b/backend/internal/services/auth_service.go
@@ -110,6 +110,8 @@ func (s *AuthService) getAuthSettings(ctx context.Context) (*AuthSettings, error
func (s *AuthService) GetOidcConfigurationStatus(ctx context.Context) (*auth.OidcStatusInfo, error) {
mergeAccounts := false
+ providerName := ""
+ providerLogoUrl := ""
if s.settingsService != nil {
func() {
defer func() {
@@ -118,16 +120,26 @@ func (s *AuthService) GetOidcConfigurationStatus(ctx context.Context) (*auth.Oid
}()
if settings, err := s.settingsService.GetSettings(ctx); err == nil {
mergeAccounts = settings.OidcMergeAccounts.IsTrue()
+ providerName = settings.OidcProviderName.Value
+ providerLogoUrl = settings.OidcProviderLogoUrl.Value
}
}()
}
status := &auth.OidcStatusInfo{
- EnvForced: s.config.OidcEnabled,
- MergeAccounts: mergeAccounts,
+ EnvForced: s.config.OidcEnabled,
+ MergeAccounts: mergeAccounts,
+ ProviderName: providerName,
+ ProviderLogoUrl: providerLogoUrl,
}
if s.config.OidcEnabled {
status.EnvConfigured = s.config.OidcClientID != "" && s.config.OidcIssuerURL != ""
+ if status.ProviderName == "" {
+ status.ProviderName = s.config.OidcProviderName
+ }
+ if status.ProviderLogoUrl == "" {
+ status.ProviderLogoUrl = s.config.OidcProviderLogoUrl
+ }
}
return status, nil
}
diff --git a/backend/internal/services/settings_service.go b/backend/internal/services/settings_service.go
index f4ca21c62..987f37c49 100644
--- a/backend/internal/services/settings_service.go
+++ b/backend/internal/services/settings_service.go
@@ -123,6 +123,8 @@ func (s *SettingsService) getDefaultSettings() *models.Settings {
OidcSkipTlsVerify: models.SettingVariable{Value: "false"},
OidcAutoRedirectToProvider: models.SettingVariable{Value: "false"},
OidcMergeAccounts: models.SettingVariable{Value: "false"},
+ OidcProviderName: models.SettingVariable{Value: ""},
+ OidcProviderLogoUrl: models.SettingVariable{Value: ""},
MobileNavigationMode: models.SettingVariable{Value: "floating"},
MobileNavigationShowLabels: models.SettingVariable{Value: "true"},
SidebarHoverExpansion: models.SettingVariable{Value: "true"},
diff --git a/frontend/messages/en.json b/frontend/messages/en.json
index 82b595221..bf3c5d776 100644
--- a/frontend/messages/en.json
+++ b/frontend/messages/en.json
@@ -310,6 +310,7 @@
"auth_user_processing_failed": "An error occurred while processing your user account.",
"auth_unexpected_error": "An unexpected error occurred. Please try again.",
"auth_oidc_provider_error": "Authentication was cancelled or failed.",
+ "auth_oidc_signin_with": "Sign in with {provider}",
"auth_oidc_access_denied": "Access was denied. You may have cancelled the login or lack permission.",
"auth_oidc_invalid_request": "Invalid authentication request. Please try again.",
"auth_oidc_auth_failed": "Authentication failed. Please try again.",
@@ -1415,6 +1416,12 @@
"oidc_auto_redirect_description": "Automatically redirect to OIDC provider on login page when enabled.",
"oidc_redirect_uri_title": "Redirect URI Configuration",
"oidc_redirect_uri_description": "Configure this redirect URI in your OIDC provider:",
+ "oidc_provider_name_label": "Provider Display Name",
+ "oidc_provider_name_placeholder": "e.g., Authentik, Keycloak, Okta",
+ "oidc_provider_name_description": "Custom name shown on the login button",
+ "oidc_provider_logo_url_label": "Provider Logo URL",
+ "oidc_provider_logo_url_placeholder": "https://example.com/logo.png",
+ "oidc_provider_logo_url_description": "Custom logo image URL to replace the default OIDC icon on the login button",
"_comment_prune": "=== PRUNE ===",
"prune_confirm_system_title": "Confirm System Prune",
"prune_confirm_description": "Select the resources you want to prune. This action permanently removes unused data and cannot be undone.",
diff --git a/frontend/src/lib/types/settings.type.ts b/frontend/src/lib/types/settings.type.ts
index 71ef3555f..8ac76b451 100644
--- a/frontend/src/lib/types/settings.type.ts
+++ b/frontend/src/lib/types/settings.type.ts
@@ -38,6 +38,8 @@ export type Settings = {
oidcSkipTlsVerify: boolean;
oidcAutoRedirectToProvider: boolean;
oidcMergeAccounts: boolean;
+ oidcProviderName: string;
+ oidcProviderLogoUrl: string;
mobileNavigationMode: 'floating' | 'docked';
mobileNavigationShowLabels: boolean;
@@ -64,4 +66,6 @@ export interface OidcStatusInfo {
envForced: boolean;
envConfigured: boolean;
mergeAccounts: boolean;
+ providerName: string;
+ providerLogoUrl: string;
}
diff --git a/frontend/src/routes/(app)/settings/security/+page.svelte b/frontend/src/routes/(app)/settings/security/+page.svelte
index fe8def6fd..a2cda6972 100644
--- a/frontend/src/routes/(app)/settings/security/+page.svelte
+++ b/frontend/src/routes/(app)/settings/security/+page.svelte
@@ -41,7 +41,9 @@
oidcIssuerUrl: z.string(),
oidcScopes: z.string(),
oidcAdminClaim: z.string(),
- oidcAdminValue: z.string()
+ oidcAdminValue: z.string(),
+ oidcProviderName: z.string(),
+ oidcProviderLogoUrl: z.string()
})
.superRefine((formData, ctx) => {
if (data.oidcStatus.envForced || formData.oidcEnabled) return;
@@ -69,7 +71,9 @@
oidcIssuerUrl: currentSettings.oidcIssuerUrl,
oidcScopes: currentSettings.oidcScopes,
oidcAdminClaim: currentSettings.oidcAdminClaim,
- oidcAdminValue: currentSettings.oidcAdminValue
+ oidcAdminValue: currentSettings.oidcAdminValue,
+ oidcProviderName: currentSettings.oidcProviderName,
+ oidcProviderLogoUrl: currentSettings.oidcProviderLogoUrl
});
// Security page needs custom submit logic for OIDC client secret handling
@@ -90,7 +94,9 @@
oidcIssuerUrl: ($settingsStore || data.settings!).oidcIssuerUrl,
oidcScopes: ($settingsStore || data.settings!).oidcScopes,
oidcAdminClaim: ($settingsStore || data.settings!).oidcAdminClaim,
- oidcAdminValue: ($settingsStore || data.settings!).oidcAdminValue
+ oidcAdminValue: ($settingsStore || data.settings!).oidcAdminValue,
+ oidcProviderName: ($settingsStore || data.settings!).oidcProviderName,
+ oidcProviderLogoUrl: ($settingsStore || data.settings!).oidcProviderLogoUrl
}),
successMessage: m.security_settings_saved()
})
@@ -110,6 +116,8 @@
$formInputs.oidcScopes.value !== currentSettings.oidcScopes ||
$formInputs.oidcAdminClaim.value !== currentSettings.oidcAdminClaim ||
$formInputs.oidcAdminValue.value !== currentSettings.oidcAdminValue ||
+ $formInputs.oidcProviderName.value !== currentSettings.oidcProviderName ||
+ $formInputs.oidcProviderLogoUrl.value !== currentSettings.oidcProviderLogoUrl ||
$formInputs.oidcClientSecret.value !== ''
);
@@ -145,6 +153,8 @@
oidcScopes: formData.oidcScopes,
oidcAdminClaim: formData.oidcAdminClaim,
oidcAdminValue: formData.oidcAdminValue,
+ oidcProviderName: formData.oidcProviderName,
+ oidcProviderLogoUrl: formData.oidcProviderLogoUrl,
...(formData.oidcClientSecret && { oidcClientSecret: formData.oidcClientSecret })
});
$formInputs.oidcClientSecret.value = '';
@@ -319,6 +329,38 @@
{/if}
</div>
+ <div class="space-y-2">
+ <Label for="oidcProviderName" class="text-sm font-medium">{m.oidc_provider_name_label()}</Label>
+ <Input
+ id="oidcProviderName"
+ type="text"
+ placeholder={m.oidc_provider_name_placeholder()}
+ disabled={isOidcEnvForced}
+ bind:value={$formInputs.oidcProviderName.value}
+ class="font-mono text-sm"
+ />
+ <p class="text-muted-foreground text-xs">{m.oidc_provider_name_description()}</p>
+ {#if $formInputs.oidcProviderName.error}
+ <p class="text-destructive text-[0.8rem] font-medium">{$formInputs.oidcProviderName.error}</p>
+ {/if}
+ </div>
+
+ <div class="space-y-2">
+ <Label for="oidcProviderLogoUrl" class="text-sm font-medium">{m.oidc_provider_logo_url_label()}</Label>
+ <Input
+ id="oidcProviderLogoUrl"
+ type="text"
+ placeholder={m.oidc_provider_logo_url_placeholder()}
+ disabled={isOidcEnvForced}
+ bind:value={$formInputs.oidcProviderLogoUrl.value}
+ class="font-mono text-sm"
+ />
+ <p class="text-muted-foreground text-xs">{m.oidc_provider_logo_url_description()}</p>
+ {#if $formInputs.oidcProviderLogoUrl.error}
+ <p class="text-destructive text-[0.8rem] font-medium">{$formInputs.oidcProviderLogoUrl.error}</p>
+ {/if}
+ </div>
+
<div class="space-y-2">
<Label for="oidcScopes" class="text-sm font-medium">{m.oidc_scopes_label()}</Label>
<Input
diff --git a/frontend/src/routes/(auth)/login/+page.svelte b/frontend/src/routes/(auth)/login/+page.svelte
index c4452d033..d3aaada06 100644
--- a/frontend/src/routes/(auth)/login/+page.svelte
+++ b/frontend/src/routes/(auth)/login/+page.svelte
@@ -3,7 +3,7 @@
import * as Card from '$lib/components/ui/card/index.js';
import * as Alert from '$lib/components/ui/alert/index.js';
import * as InputGroup from '$lib/components/ui/input-group/index.js';
- import { AlertIcon, LockIcon, UserIcon, GithubIcon } from '$lib/icons';
+ import { AlertIcon, LockIcon, UserIcon, GithubIcon, OpenIdIcon } from '$lib/icons';
import type { PageData } from './$types';
import { goto } from '$app/navigation';
import userStore from '$lib/stores/user-store';
@@ -34,6 +34,12 @@
const oidcAutoRedirect = $derived(data.settings?.oidcAutoRedirectToProvider === true);
+ const oidcProviderName = $derived(data.settings?.oidcProviderName || '');
+ const oidcProviderLogoUrl = $derived(data.settings?.oidcProviderLogoUrl || '');
+ const oidcButtonLabel = $derived(
+ oidcProviderName ? m.auth_oidc_signin_with({ provider: oidcProviderName }) : m.auth_oidc_signin()
+ );
+
onMount(() => {
if (oidcAutoRedirect && oidcEnabledBySettings && !data.error) {
handleOidcLogin();
@@ -200,7 +206,16 @@
onclick={() => handleOidcLogin()}
loading={isLoading.oidc}
disabled={isLoading.local}
- />
+ icon={null}
+ customLabel=""
+ >
+ {#if oidcProviderLogoUrl}
+ <img src={oidcProviderLogoUrl} alt="" class="size-4 object-contain" />
+ {:else}
+ <OpenIdIcon class="size-4" />
+ {/if}
+ {oidcButtonLabel}
+ </ArcaneButton>
{/if}
{#if showLocalLoginForm}
@@ -270,7 +285,16 @@
onclick={() => handleOidcLogin()}
loading={isLoading.oidc}
disabled={isLoading.local}
- />
+ icon={null}
+ customLabel=""
+ >
+ {#if oidcProviderLogoUrl}
+ <img src={oidcProviderLogoUrl} alt="" class="size-4 object-contain" />
+ {:else}
+ <OpenIdIcon class="size-4" />
+ {/if}
+ {oidcButtonLabel}
+ </ArcaneButton>
{/if}
{/if}
</div>
diff --git a/types/auth/oidc.go b/types/auth/oidc.go
index a42992adf..976a7ce27 100644
--- a/types/auth/oidc.go
+++ b/types/auth/oidc.go
@@ -109,6 +109,16 @@ type OidcStatusInfo struct {
//
// Required: true
MergeAccounts bool `json:"mergeAccounts"`
+
+ // ProviderName is the custom display name for the OIDC provider.
+ //
+ // Required: false
+ ProviderName string `json:"providerName,omitempty"`
+
+ // ProviderLogoUrl is the custom logo URL for the OIDC provider.
+ //
+ // Required: false
+ ProviderLogoUrl string `json:"providerLogoUrl,omitempty"`
}
// OidcAuthUrlRequest is used to request an OIDC authorization URL.
diff --git a/types/settings/settings.go b/types/settings/settings.go
index ea4e12112..38f871ba0 100644
--- a/types/settings/settings.go
+++ b/types/settings/settings.go
@@ -212,6 +212,16 @@ type Update struct {
// Required: false
OidcAutoRedirectToProvider *string `json:"oidcAutoRedirectToProvider,omitempty"`
+ // OidcProviderName is the custom display name for the OIDC provider.
+ //
+ // Required: false
+ OidcProviderName *string `json:"oidcProviderName,omitempty"`
+
+ // OidcProviderLogoUrl is the custom logo URL for the OIDC provider.
+ //
+ // Required: false
+ OidcProviderLogoUrl *string `json:"oidcProviderLogoUrl,omitempty"`
+
// MobileNavigationMode is the navigation mode for mobile devices.
//
// Required: false