feat(server): Add config option to disable admin registration

pull/24539/head
provokateurin 2025-12-12 19:03:01 +01:00
parent 33cdea88aa
commit 60edd06233
No known key found for this signature in database
8 changed files with 24 additions and 3 deletions

View File

@ -201,7 +201,8 @@ The default configuration looks like this:
"storageLabelClaim": "preferred_username",
"storageQuotaClaim": "immich_quota",
"timeout": 30000,
"tokenEndpointAuthMethod": "client_secret_post"
"tokenEndpointAuthMethod": "client_secret_post",
"disableAdminRegistration": false
},
"passwordLogin": {
"enabled": true

View File

@ -19,6 +19,7 @@ class SystemConfigOAuthDto {
required this.clientId,
required this.clientSecret,
required this.defaultStorageQuota,
required this.disableAdminRegistration,
required this.enabled,
required this.issuerUrl,
required this.mobileOverrideEnabled,
@ -46,6 +47,8 @@ class SystemConfigOAuthDto {
/// Minimum value: 0
int? defaultStorageQuota;
bool disableAdminRegistration;
bool enabled;
String issuerUrl;
@ -79,6 +82,7 @@ class SystemConfigOAuthDto {
other.clientId == clientId &&
other.clientSecret == clientSecret &&
other.defaultStorageQuota == defaultStorageQuota &&
other.disableAdminRegistration == disableAdminRegistration &&
other.enabled == enabled &&
other.issuerUrl == issuerUrl &&
other.mobileOverrideEnabled == mobileOverrideEnabled &&
@ -101,6 +105,7 @@ class SystemConfigOAuthDto {
(clientId.hashCode) +
(clientSecret.hashCode) +
(defaultStorageQuota == null ? 0 : defaultStorageQuota!.hashCode) +
(disableAdminRegistration.hashCode) +
(enabled.hashCode) +
(issuerUrl.hashCode) +
(mobileOverrideEnabled.hashCode) +
@ -115,7 +120,7 @@ class SystemConfigOAuthDto {
(tokenEndpointAuthMethod.hashCode);
@override
String toString() => 'SystemConfigOAuthDto[autoLaunch=$autoLaunch, autoRegister=$autoRegister, buttonText=$buttonText, clientId=$clientId, clientSecret=$clientSecret, defaultStorageQuota=$defaultStorageQuota, enabled=$enabled, issuerUrl=$issuerUrl, mobileOverrideEnabled=$mobileOverrideEnabled, mobileRedirectUri=$mobileRedirectUri, profileSigningAlgorithm=$profileSigningAlgorithm, roleClaim=$roleClaim, scope=$scope, signingAlgorithm=$signingAlgorithm, storageLabelClaim=$storageLabelClaim, storageQuotaClaim=$storageQuotaClaim, timeout=$timeout, tokenEndpointAuthMethod=$tokenEndpointAuthMethod]';
String toString() => 'SystemConfigOAuthDto[autoLaunch=$autoLaunch, autoRegister=$autoRegister, buttonText=$buttonText, clientId=$clientId, clientSecret=$clientSecret, defaultStorageQuota=$defaultStorageQuota, disableAdminRegistration=$disableAdminRegistration, enabled=$enabled, issuerUrl=$issuerUrl, mobileOverrideEnabled=$mobileOverrideEnabled, mobileRedirectUri=$mobileRedirectUri, profileSigningAlgorithm=$profileSigningAlgorithm, roleClaim=$roleClaim, scope=$scope, signingAlgorithm=$signingAlgorithm, storageLabelClaim=$storageLabelClaim, storageQuotaClaim=$storageQuotaClaim, timeout=$timeout, tokenEndpointAuthMethod=$tokenEndpointAuthMethod]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
@ -129,6 +134,7 @@ class SystemConfigOAuthDto {
} else {
// json[r'defaultStorageQuota'] = null;
}
json[r'disableAdminRegistration'] = this.disableAdminRegistration;
json[r'enabled'] = this.enabled;
json[r'issuerUrl'] = this.issuerUrl;
json[r'mobileOverrideEnabled'] = this.mobileOverrideEnabled;
@ -159,6 +165,7 @@ class SystemConfigOAuthDto {
clientId: mapValueOfType<String>(json, r'clientId')!,
clientSecret: mapValueOfType<String>(json, r'clientSecret')!,
defaultStorageQuota: mapValueOfType<int>(json, r'defaultStorageQuota'),
disableAdminRegistration: mapValueOfType<bool>(json, r'disableAdminRegistration')!,
enabled: mapValueOfType<bool>(json, r'enabled')!,
issuerUrl: mapValueOfType<String>(json, r'issuerUrl')!,
mobileOverrideEnabled: mapValueOfType<bool>(json, r'mobileOverrideEnabled')!,
@ -224,6 +231,7 @@ class SystemConfigOAuthDto {
'clientId',
'clientSecret',
'defaultStorageQuota',
'disableAdminRegistration',
'enabled',
'issuerUrl',
'mobileOverrideEnabled',

View File

@ -21804,6 +21804,9 @@
"nullable": true,
"type": "integer"
},
"disableAdminRegistration": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
@ -21854,6 +21857,7 @@
"clientId",
"clientSecret",
"defaultStorageQuota",
"disableAdminRegistration",
"enabled",
"issuerUrl",
"mobileOverrideEnabled",

View File

@ -1555,6 +1555,7 @@ export type SystemConfigOAuthDto = {
clientId: string;
clientSecret: string;
defaultStorageQuota: number | null;
disableAdminRegistration: boolean;
enabled: boolean;
issuerUrl: string;
mobileOverrideEnabled: boolean;

View File

@ -114,6 +114,7 @@ export interface SystemConfig {
storageLabelClaim: string;
storageQuotaClaim: string;
roleClaim: string;
disableAdminRegistration: boolean;
};
passwordLogin: {
enabled: boolean;
@ -304,6 +305,7 @@ export const defaults = Object.freeze<SystemConfig>({
roleClaim: 'immich_role',
tokenEndpointAuthMethod: OAuthTokenEndpointAuthMethod.ClientSecretPost,
timeout: 30_000,
disableAdminRegistration: false,
},
passwordLogin: {
enabled: true,

View File

@ -431,6 +431,9 @@ class SystemConfigOAuthDto {
@IsString()
roleClaim!: string;
@ValidateBoolean()
disableAdminRegistration!: boolean;
}
class SystemConfigPasswordLoginDto {

View File

@ -116,7 +116,8 @@ export class ServerService extends BaseService {
async getSystemConfig(): Promise<ServerConfigDto> {
const config = await this.getConfig({ withCache: false });
const isInitialized = await this.userRepository.hasAdmin();
const isInitialized =
(config.oauth.enabled && config.oauth.disableAdminRegistration) || (await this.userRepository.hasAdmin());
const onboarding = await this.systemMetadataRepository.get(SystemMetadataKey.AdminOnboarding);
return {

View File

@ -147,6 +147,7 @@ const updatedConfig = Object.freeze<SystemConfig>({
storageLabelClaim: 'preferred_username',
storageQuotaClaim: 'immich_quota',
roleClaim: 'immich_role',
disableAdminRegistration: false,
},
passwordLogin: {
enabled: true,