1
0
mirror of https://github.com/immich-app/immich.git synced 2025-02-02 18:25:38 +02:00

feat(web,server): external domain setting (#6146)

* feat: external domain setting

* chore: open api

* mobile: handle serverconfig-externalDomain

---------

Co-authored-by: shenlong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>
This commit is contained in:
Jason Rasmussen 2024-01-03 21:54:48 -05:00 committed by GitHub
parent 1e503c3212
commit 317adc5c28
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
35 changed files with 433 additions and 23 deletions

View File

@ -3007,6 +3007,12 @@ export interface SearchResponseDto {
* @interface ServerConfigDto
*/
export interface ServerConfigDto {
/**
*
* @type {string}
* @memberof ServerConfigDto
*/
'externalDomain': string;
/**
*
* @type {boolean}
@ -3590,6 +3596,12 @@ export interface SystemConfigDto {
* @memberof SystemConfigDto
*/
'reverseGeocoding': SystemConfigReverseGeocodingDto;
/**
*
* @type {SystemConfigServerDto}
* @memberof SystemConfigDto
*/
'server': SystemConfigServerDto;
/**
*
* @type {SystemConfigStorageTemplateDto}
@ -4014,6 +4026,19 @@ export interface SystemConfigReverseGeocodingDto {
*/
'enabled': boolean;
}
/**
*
* @export
* @interface SystemConfigServerDto
*/
export interface SystemConfigServerDto {
/**
*
* @type {string}
* @memberof SystemConfigServerDto
*/
'externalDomain': string;
}
/**
*
* @export

View File

@ -9,6 +9,7 @@ import 'package:immich_mobile/modules/search/ui/thumbnail_with_info.dart';
import 'package:immich_mobile/modules/shared_link/models/shared_link.dart';
import 'package:immich_mobile/modules/shared_link/providers/shared_link.provider.dart';
import 'package:immich_mobile/routing/router.dart';
import 'package:immich_mobile/shared/providers/server_info.provider.dart';
import 'package:immich_mobile/shared/ui/confirm_dialog.dart';
import 'package:immich_mobile/shared/ui/immich_toast.dart';
import 'package:immich_mobile/utils/image_url_builder.dart';
@ -71,7 +72,11 @@ class SharedLinkItem extends ConsumerWidget {
final imageSize = math.min(context.width / 4, 100.0);
void copyShareLinkToClipboard() {
final serverUrl = getServerUrl();
final externalDomain = ref.read(
serverInfoProvider.select((s) => s.serverConfig.externalDomain),
);
final serverUrl =
externalDomain.isNotEmpty ? externalDomain : getServerUrl();
if (serverUrl == null) {
ImmichToast.show(
context: context,

View File

@ -8,6 +8,7 @@ import 'package:immich_mobile/extensions/build_context_extensions.dart';
import 'package:immich_mobile/modules/shared_link/models/shared_link.dart';
import 'package:immich_mobile/modules/shared_link/providers/shared_link.provider.dart';
import 'package:immich_mobile/modules/shared_link/services/shared_link.service.dart';
import 'package:immich_mobile/shared/providers/server_info.provider.dart';
import 'package:immich_mobile/shared/ui/immich_toast.dart';
import 'package:immich_mobile/utils/url_helper.dart';
@ -353,7 +354,11 @@ class SharedLinkEditPage extends HookConsumerWidget {
expiresAt: expiryAfter.value == 0 ? null : calculateExpiry(),
);
ref.invalidate(sharedLinksStateProvider);
final serverUrl = getServerUrl();
final externalDomain = ref.read(
serverInfoProvider.select((s) => s.serverConfig.externalDomain),
);
final serverUrl =
externalDomain.isNotEmpty ? externalDomain : getServerUrl();
if (newLink != null && serverUrl != null) {
newShareLink.value = "$serverUrl/share/${newLink.key}";
copyLinkToClipboard();

View File

@ -2,35 +2,40 @@ import 'package:openapi/api.dart';
class ServerConfig {
final int trashDays;
final String externalDomain;
const ServerConfig({
required this.trashDays,
required this.externalDomain,
});
ServerConfig copyWith({
int? trashDays,
String? externalDomain,
}) {
return ServerConfig(
trashDays: trashDays ?? this.trashDays,
externalDomain: externalDomain ?? this.externalDomain,
);
}
@override
String toString() {
return 'ServerConfig(trashDays: $trashDays)';
}
String toString() =>
'ServerConfig(trashDays: $trashDays, externalDomain: $externalDomain)';
ServerConfig.fromDto(ServerConfigDto dto) : trashDays = dto.trashDays;
ServerConfig.fromDto(ServerConfigDto dto)
: trashDays = dto.trashDays,
externalDomain = dto.externalDomain;
@override
bool operator ==(Object other) {
if (identical(this, other)) return true;
return other is ServerConfig && other.trashDays == trashDays;
return other is ServerConfig &&
other.trashDays == trashDays &&
other.externalDomain == externalDomain;
}
@override
int get hashCode {
return trashDays.hashCode;
}
int get hashCode => trashDays.hashCode ^ externalDomain.hashCode;
}

View File

@ -29,6 +29,7 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
),
serverConfig: const ServerConfig(
trashDays: 30,
externalDomain: '',
),
serverDiskInfo: const ServerDiskInfo(
diskAvailable: "0",
@ -74,7 +75,8 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
if (appVersion["major"]! > serverVersion.major) {
state = state.copyWith(
isVersionMismatch: true,
versionMismatchErrorMessage: "profile_drawer_server_out_of_date_major".tr(),
versionMismatchErrorMessage:
"profile_drawer_server_out_of_date_major".tr(),
);
return;
}
@ -82,7 +84,8 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
if (appVersion["major"]! < serverVersion.major) {
state = state.copyWith(
isVersionMismatch: true,
versionMismatchErrorMessage: "profile_drawer_client_out_of_date_major".tr(),
versionMismatchErrorMessage:
"profile_drawer_client_out_of_date_major".tr(),
);
return;
}
@ -90,7 +93,8 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
if (appVersion["minor"]! > serverVersion.minor) {
state = state.copyWith(
isVersionMismatch: true,
versionMismatchErrorMessage: "profile_drawer_server_out_of_date_minor".tr(),
versionMismatchErrorMessage:
"profile_drawer_server_out_of_date_minor".tr(),
);
return;
}
@ -98,7 +102,8 @@ class ServerInfoNotifier extends StateNotifier<ServerInfo> {
if (appVersion["minor"]! < serverVersion.minor) {
state = state.copyWith(
isVersionMismatch: true,
versionMismatchErrorMessage: "profile_drawer_client_out_of_date_minor".tr(),
versionMismatchErrorMessage:
"profile_drawer_client_out_of_date_minor".tr(),
);
return;
}

View File

@ -149,6 +149,7 @@ doc/SystemConfigNewVersionCheckDto.md
doc/SystemConfigOAuthDto.md
doc/SystemConfigPasswordLoginDto.md
doc/SystemConfigReverseGeocodingDto.md
doc/SystemConfigServerDto.md
doc/SystemConfigStorageTemplateDto.md
doc/SystemConfigTemplateStorageOptionDto.md
doc/SystemConfigThemeDto.md
@ -335,6 +336,7 @@ lib/model/system_config_new_version_check_dto.dart
lib/model/system_config_o_auth_dto.dart
lib/model/system_config_password_login_dto.dart
lib/model/system_config_reverse_geocoding_dto.dart
lib/model/system_config_server_dto.dart
lib/model/system_config_storage_template_dto.dart
lib/model/system_config_template_storage_option_dto.dart
lib/model/system_config_theme_dto.dart
@ -508,6 +510,7 @@ test/system_config_new_version_check_dto_test.dart
test/system_config_o_auth_dto_test.dart
test/system_config_password_login_dto_test.dart
test/system_config_reverse_geocoding_dto_test.dart
test/system_config_server_dto_test.dart
test/system_config_storage_template_dto_test.dart
test/system_config_template_storage_option_dto_test.dart
test/system_config_theme_dto_test.dart

View File

@ -341,6 +341,7 @@ Class | Method | HTTP request | Description
- [SystemConfigOAuthDto](doc//SystemConfigOAuthDto.md)
- [SystemConfigPasswordLoginDto](doc//SystemConfigPasswordLoginDto.md)
- [SystemConfigReverseGeocodingDto](doc//SystemConfigReverseGeocodingDto.md)
- [SystemConfigServerDto](doc//SystemConfigServerDto.md)
- [SystemConfigStorageTemplateDto](doc//SystemConfigStorageTemplateDto.md)
- [SystemConfigTemplateStorageOptionDto](doc//SystemConfigTemplateStorageOptionDto.md)
- [SystemConfigThemeDto](doc//SystemConfigThemeDto.md)

View File

@ -8,6 +8,7 @@ import 'package:openapi/api.dart';
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**externalDomain** | **String** | |
**isInitialized** | **bool** | |
**loginPageMessage** | **String** | |
**oauthButtonText** | **String** | |

View File

@ -18,6 +18,7 @@ Name | Type | Description | Notes
**oauth** | [**SystemConfigOAuthDto**](SystemConfigOAuthDto.md) | |
**passwordLogin** | [**SystemConfigPasswordLoginDto**](SystemConfigPasswordLoginDto.md) | |
**reverseGeocoding** | [**SystemConfigReverseGeocodingDto**](SystemConfigReverseGeocodingDto.md) | |
**server** | [**SystemConfigServerDto**](SystemConfigServerDto.md) | |
**storageTemplate** | [**SystemConfigStorageTemplateDto**](SystemConfigStorageTemplateDto.md) | |
**theme** | [**SystemConfigThemeDto**](SystemConfigThemeDto.md) | |
**thumbnail** | [**SystemConfigThumbnailDto**](SystemConfigThumbnailDto.md) | |

View File

@ -0,0 +1,15 @@
# openapi.model.SystemConfigServerDto
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**externalDomain** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -177,6 +177,7 @@ part 'model/system_config_new_version_check_dto.dart';
part 'model/system_config_o_auth_dto.dart';
part 'model/system_config_password_login_dto.dart';
part 'model/system_config_reverse_geocoding_dto.dart';
part 'model/system_config_server_dto.dart';
part 'model/system_config_storage_template_dto.dart';
part 'model/system_config_template_storage_option_dto.dart';
part 'model/system_config_theme_dto.dart';

View File

@ -441,6 +441,8 @@ class ApiClient {
return SystemConfigPasswordLoginDto.fromJson(value);
case 'SystemConfigReverseGeocodingDto':
return SystemConfigReverseGeocodingDto.fromJson(value);
case 'SystemConfigServerDto':
return SystemConfigServerDto.fromJson(value);
case 'SystemConfigStorageTemplateDto':
return SystemConfigStorageTemplateDto.fromJson(value);
case 'SystemConfigTemplateStorageOptionDto':

View File

@ -13,12 +13,15 @@ part of openapi.api;
class ServerConfigDto {
/// Returns a new [ServerConfigDto] instance.
ServerConfigDto({
required this.externalDomain,
required this.isInitialized,
required this.loginPageMessage,
required this.oauthButtonText,
required this.trashDays,
});
String externalDomain;
bool isInitialized;
String loginPageMessage;
@ -29,6 +32,7 @@ class ServerConfigDto {
@override
bool operator ==(Object other) => identical(this, other) || other is ServerConfigDto &&
other.externalDomain == externalDomain &&
other.isInitialized == isInitialized &&
other.loginPageMessage == loginPageMessage &&
other.oauthButtonText == oauthButtonText &&
@ -37,16 +41,18 @@ class ServerConfigDto {
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(externalDomain.hashCode) +
(isInitialized.hashCode) +
(loginPageMessage.hashCode) +
(oauthButtonText.hashCode) +
(trashDays.hashCode);
@override
String toString() => 'ServerConfigDto[isInitialized=$isInitialized, loginPageMessage=$loginPageMessage, oauthButtonText=$oauthButtonText, trashDays=$trashDays]';
String toString() => 'ServerConfigDto[externalDomain=$externalDomain, isInitialized=$isInitialized, loginPageMessage=$loginPageMessage, oauthButtonText=$oauthButtonText, trashDays=$trashDays]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'externalDomain'] = this.externalDomain;
json[r'isInitialized'] = this.isInitialized;
json[r'loginPageMessage'] = this.loginPageMessage;
json[r'oauthButtonText'] = this.oauthButtonText;
@ -62,6 +68,7 @@ class ServerConfigDto {
final json = value.cast<String, dynamic>();
return ServerConfigDto(
externalDomain: mapValueOfType<String>(json, r'externalDomain')!,
isInitialized: mapValueOfType<bool>(json, r'isInitialized')!,
loginPageMessage: mapValueOfType<String>(json, r'loginPageMessage')!,
oauthButtonText: mapValueOfType<String>(json, r'oauthButtonText')!,
@ -113,6 +120,7 @@ class ServerConfigDto {
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'externalDomain',
'isInitialized',
'loginPageMessage',
'oauthButtonText',

View File

@ -23,6 +23,7 @@ class SystemConfigDto {
required this.oauth,
required this.passwordLogin,
required this.reverseGeocoding,
required this.server,
required this.storageTemplate,
required this.theme,
required this.thumbnail,
@ -49,6 +50,8 @@ class SystemConfigDto {
SystemConfigReverseGeocodingDto reverseGeocoding;
SystemConfigServerDto server;
SystemConfigStorageTemplateDto storageTemplate;
SystemConfigThemeDto theme;
@ -69,6 +72,7 @@ class SystemConfigDto {
other.oauth == oauth &&
other.passwordLogin == passwordLogin &&
other.reverseGeocoding == reverseGeocoding &&
other.server == server &&
other.storageTemplate == storageTemplate &&
other.theme == theme &&
other.thumbnail == thumbnail &&
@ -87,13 +91,14 @@ class SystemConfigDto {
(oauth.hashCode) +
(passwordLogin.hashCode) +
(reverseGeocoding.hashCode) +
(server.hashCode) +
(storageTemplate.hashCode) +
(theme.hashCode) +
(thumbnail.hashCode) +
(trash.hashCode);
@override
String toString() => 'SystemConfigDto[ffmpeg=$ffmpeg, job=$job, library_=$library_, logging=$logging, machineLearning=$machineLearning, map=$map, newVersionCheck=$newVersionCheck, oauth=$oauth, passwordLogin=$passwordLogin, reverseGeocoding=$reverseGeocoding, storageTemplate=$storageTemplate, theme=$theme, thumbnail=$thumbnail, trash=$trash]';
String toString() => 'SystemConfigDto[ffmpeg=$ffmpeg, job=$job, library_=$library_, logging=$logging, machineLearning=$machineLearning, map=$map, newVersionCheck=$newVersionCheck, oauth=$oauth, passwordLogin=$passwordLogin, reverseGeocoding=$reverseGeocoding, server=$server, storageTemplate=$storageTemplate, theme=$theme, thumbnail=$thumbnail, trash=$trash]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
@ -107,6 +112,7 @@ class SystemConfigDto {
json[r'oauth'] = this.oauth;
json[r'passwordLogin'] = this.passwordLogin;
json[r'reverseGeocoding'] = this.reverseGeocoding;
json[r'server'] = this.server;
json[r'storageTemplate'] = this.storageTemplate;
json[r'theme'] = this.theme;
json[r'thumbnail'] = this.thumbnail;
@ -132,6 +138,7 @@ class SystemConfigDto {
oauth: SystemConfigOAuthDto.fromJson(json[r'oauth'])!,
passwordLogin: SystemConfigPasswordLoginDto.fromJson(json[r'passwordLogin'])!,
reverseGeocoding: SystemConfigReverseGeocodingDto.fromJson(json[r'reverseGeocoding'])!,
server: SystemConfigServerDto.fromJson(json[r'server'])!,
storageTemplate: SystemConfigStorageTemplateDto.fromJson(json[r'storageTemplate'])!,
theme: SystemConfigThemeDto.fromJson(json[r'theme'])!,
thumbnail: SystemConfigThumbnailDto.fromJson(json[r'thumbnail'])!,
@ -193,6 +200,7 @@ class SystemConfigDto {
'oauth',
'passwordLogin',
'reverseGeocoding',
'server',
'storageTemplate',
'theme',
'thumbnail',

View File

@ -0,0 +1,98 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.12
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class SystemConfigServerDto {
/// Returns a new [SystemConfigServerDto] instance.
SystemConfigServerDto({
required this.externalDomain,
});
String externalDomain;
@override
bool operator ==(Object other) => identical(this, other) || other is SystemConfigServerDto &&
other.externalDomain == externalDomain;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(externalDomain.hashCode);
@override
String toString() => 'SystemConfigServerDto[externalDomain=$externalDomain]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'externalDomain'] = this.externalDomain;
return json;
}
/// Returns a new [SystemConfigServerDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SystemConfigServerDto? fromJson(dynamic value) {
if (value is Map) {
final json = value.cast<String, dynamic>();
return SystemConfigServerDto(
externalDomain: mapValueOfType<String>(json, r'externalDomain')!,
);
}
return null;
}
static List<SystemConfigServerDto> listFromJson(dynamic json, {bool growable = false,}) {
final result = <SystemConfigServerDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SystemConfigServerDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SystemConfigServerDto> mapFromJson(dynamic json) {
final map = <String, SystemConfigServerDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SystemConfigServerDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SystemConfigServerDto-objects as value to a dart map
static Map<String, List<SystemConfigServerDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SystemConfigServerDto>>{};
if (json is Map && json.isNotEmpty) {
// ignore: parameter_assignments
json = json.cast<String, dynamic>();
for (final entry in json.entries) {
map[entry.key] = SystemConfigServerDto.listFromJson(entry.value, growable: growable,);
}
}
return map;
}
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'externalDomain',
};
}

View File

@ -16,6 +16,11 @@ void main() {
// final instance = ServerConfigDto();
group('test ServerConfigDto', () {
// String externalDomain
test('to test the property `externalDomain`', () async {
// TODO
});
// bool isInitialized
test('to test the property `isInitialized`', () async {
// TODO

View File

@ -66,6 +66,11 @@ void main() {
// TODO
});
// SystemConfigServerDto server
test('to test the property `server`', () async {
// TODO
});
// SystemConfigStorageTemplateDto storageTemplate
test('to test the property `storageTemplate`', () async {
// TODO

View File

@ -0,0 +1,27 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.12
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
import 'package:openapi/api.dart';
import 'package:test/test.dart';
// tests for SystemConfigServerDto
void main() {
// final instance = SystemConfigServerDto();
group('test SystemConfigServerDto', () {
// String externalDomain
test('to test the property `externalDomain`', () async {
// TODO
});
});
}

View File

@ -8593,6 +8593,9 @@
},
"ServerConfigDto": {
"properties": {
"externalDomain": {
"type": "string"
},
"isInitialized": {
"type": "boolean"
},
@ -8610,7 +8613,8 @@
"trashDays",
"oauthButtonText",
"loginPageMessage",
"isInitialized"
"isInitialized",
"externalDomain"
],
"type": "object"
},
@ -9039,6 +9043,9 @@
"reverseGeocoding": {
"$ref": "#/components/schemas/SystemConfigReverseGeocodingDto"
},
"server": {
"$ref": "#/components/schemas/SystemConfigServerDto"
},
"storageTemplate": {
"$ref": "#/components/schemas/SystemConfigStorageTemplateDto"
},
@ -9066,7 +9073,8 @@
"thumbnail",
"trash",
"theme",
"library"
"library",
"server"
],
"type": "object"
},
@ -9359,6 +9367,17 @@
],
"type": "object"
},
"SystemConfigServerDto": {
"properties": {
"externalDomain": {
"type": "string"
}
},
"required": [
"externalDomain"
],
"type": "object"
},
"SystemConfigStorageTemplateDto": {
"properties": {
"enabled": {

View File

@ -86,6 +86,7 @@ export class ServerConfigDto {
@ApiProperty({ type: 'integer' })
trashDays!: number;
isInitialized!: boolean;
externalDomain!: string;
}
export class ServerFeaturesDto implements FeatureFlags {

View File

@ -184,6 +184,7 @@ describe(ServerInfoService.name, () => {
loginPageMessage: '',
oauthButtonText: 'Login with OAuth',
trashDays: 30,
externalDomain: '',
});
expect(configMock.load).toHaveBeenCalled();
});

View File

@ -89,6 +89,7 @@ export class ServerInfoService {
trashDays: config.trash.days,
oauthButtonText: config.oauth.buttonText,
isInitialized,
externalDomain: config.server.externalDomain,
};
}

View File

@ -0,0 +1,6 @@
import { IsString } from 'class-validator';
export class SystemConfigServerDto {
@IsString()
externalDomain!: string;
}

View File

@ -11,6 +11,7 @@ import { SystemConfigNewVersionCheckDto } from './system-config-new-version-chec
import { SystemConfigOAuthDto } from './system-config-oauth.dto';
import { SystemConfigPasswordLoginDto } from './system-config-password-login.dto';
import { SystemConfigReverseGeocodingDto } from './system-config-reverse-geocoding.dto';
import { SystemConfigServerDto } from './system-config-server.dto';
import { SystemConfigStorageTemplateDto } from './system-config-storage-template.dto';
import { SystemConfigThemeDto } from './system-config-theme.dto';
import { SystemConfigThumbnailDto } from './system-config-thumbnail.dto';
@ -86,6 +87,11 @@ export class SystemConfigDto implements SystemConfig {
@ValidateNested()
@IsObject()
library!: SystemConfigLibraryDto;
@Type(() => SystemConfigServerDto)
@ValidateNested()
@IsObject()
server!: SystemConfigServerDto;
}
export function mapConfig(config: SystemConfig): SystemConfigDto {

View File

@ -127,6 +127,9 @@ export const defaults = Object.freeze<SystemConfig>({
cronExpression: CronExpression.EVERY_DAY_AT_MIDNIGHT,
},
},
server: {
externalDomain: '',
},
});
export enum FeatureFlag {

View File

@ -100,6 +100,9 @@ const updatedConfig = Object.freeze<SystemConfig>({
passwordLogin: {
enabled: true,
},
server: {
externalDomain: '',
},
storageTemplate: {
enabled: false,
hashVerificationEnabled: true,

View File

@ -84,6 +84,8 @@ export enum SystemConfigKey {
PASSWORD_LOGIN_ENABLED = 'passwordLogin.enabled',
SERVER_EXTERNAL_DOMAIN = 'server.externalDomain',
STORAGE_TEMPLATE_ENABLED = 'storageTemplate.enabled',
STORAGE_TEMPLATE_HASH_VERIFICATION_ENABLED = 'storageTemplate.hashVerificationEnabled',
STORAGE_TEMPLATE = 'storageTemplate.template',
@ -244,4 +246,7 @@ export interface SystemConfig {
cronExpression: string;
};
};
server: {
externalDomain: string;
};
}

View File

@ -97,6 +97,7 @@ describe(`${ServerInfoController.name} (e2e)`, () => {
oauthButtonText: 'Login with OAuth',
trashDays: 30,
isInitialized: true,
externalDomain: '',
});
});
});

View File

@ -3007,6 +3007,12 @@ export interface SearchResponseDto {
* @interface ServerConfigDto
*/
export interface ServerConfigDto {
/**
*
* @type {string}
* @memberof ServerConfigDto
*/
'externalDomain': string;
/**
*
* @type {boolean}
@ -3590,6 +3596,12 @@ export interface SystemConfigDto {
* @memberof SystemConfigDto
*/
'reverseGeocoding': SystemConfigReverseGeocodingDto;
/**
*
* @type {SystemConfigServerDto}
* @memberof SystemConfigDto
*/
'server': SystemConfigServerDto;
/**
*
* @type {SystemConfigStorageTemplateDto}
@ -4014,6 +4026,19 @@ export interface SystemConfigReverseGeocodingDto {
*/
'enabled': boolean;
}
/**
*
* @export
* @interface SystemConfigServerDto
*/
export interface SystemConfigServerDto {
/**
*
* @type {string}
* @memberof SystemConfigServerDto
*/
'externalDomain': string;
}
/**
*
* @export

View File

@ -19,6 +19,10 @@ export const copyToClipboard = async (secret: string) => {
}
};
export const makeSharedLinkUrl = (externalDomain: string, key: string) => {
return `${externalDomain || window.location.origin}/share/${key}`;
};
export const oauth = {
isCallback: (location: Location) => {
const search = location.search;

View File

@ -0,0 +1,107 @@
<script lang="ts">
import SettingButtonsRow from '$lib/components/admin-page/settings/setting-buttons-row.svelte';
import {
notificationController,
NotificationType,
} from '$lib/components/shared-components/notification/notification';
import type { ResetOptions } from '$lib/utils/dipatch';
import { handleError } from '$lib/utils/handle-error';
import { api, SystemConfigServerDto } from '@api';
import { isEqual } from 'lodash-es';
import { fade } from 'svelte/transition';
import SettingInputField, { SettingInputFieldType } from '../setting-input-field.svelte';
export let serverConfig: SystemConfigServerDto; // this is the config that is being edited
export let disabled = false;
let savedConfig: SystemConfigServerDto;
let defaultConfig: SystemConfigServerDto;
const handleReset = (detail: ResetOptions) => {
if (detail.default) {
resetToDefault();
} else {
reset();
}
};
async function getConfigs() {
[savedConfig, defaultConfig] = await Promise.all([
api.systemConfigApi.getConfig().then((res) => res.data.server),
api.systemConfigApi.getConfigDefaults().then((res) => res.data.server),
]);
}
async function reset() {
const { data: resetConfig } = await api.systemConfigApi.getConfig();
serverConfig = { ...resetConfig.server };
savedConfig = { ...resetConfig.server };
notificationController.show({
message: 'Reset server settings to the recent saved settings',
type: NotificationType.Info,
});
}
async function resetToDefault() {
const { data: configs } = await api.systemConfigApi.getConfigDefaults();
serverConfig = { ...configs.server };
defaultConfig = { ...configs.server };
notificationController.show({
message: 'Reset server settings to default',
type: NotificationType.Info,
});
}
async function saveSetting() {
try {
const { data: configs } = await api.systemConfigApi.getConfig();
const result = await api.systemConfigApi.updateConfig({
systemConfigDto: {
...configs,
server: serverConfig,
},
});
serverConfig = { ...result.data.server };
savedConfig = { ...result.data.server };
notificationController.show({
message: 'Server settings saved',
type: NotificationType.Info,
});
} catch (e) {
handleError(e, 'Unable to save settings');
}
}
</script>
<div>
{#await getConfigs() then}
<div in:fade={{ duration: 500 }}>
<form autocomplete="off" on:submit|preventDefault>
<div class="mt-2">
<SettingInputField
inputType={SettingInputFieldType.TEXT}
label="EXTERNAL DOMAIN"
desc="Domain for public shared links, including http(s)://"
bind:value={serverConfig.externalDomain}
isEdited={serverConfig.externalDomain !== savedConfig.externalDomain}
/>
<div class="ml-4">
<SettingButtonsRow
on:reset={({ detail }) => handleReset(detail)}
on:save={saveSetting}
showResetToDefault={!isEqual(savedConfig, defaultConfig)}
{disabled}
/>
</div>
</div>
</form>
</div>
{/await}
</div>

View File

@ -5,7 +5,7 @@
import SettingSwitch from '$lib/components/admin-page/settings/setting-switch.svelte';
import Button from '$lib/components/elements/buttons/button.svelte';
import { handleError } from '$lib/utils/handle-error';
import { api, copyToClipboard, SharedLinkResponseDto, SharedLinkType } from '@api';
import { api, copyToClipboard, makeSharedLinkUrl, SharedLinkResponseDto, SharedLinkType } from '@api';
import { createEventDispatcher, onMount } from 'svelte';
import Icon from '$lib/components/elements/icon.svelte';
import BaseModal from '../base-modal.svelte';
@ -13,6 +13,7 @@
import DropdownButton from '../dropdown-button.svelte';
import { notificationController, NotificationType } from '../notification/notification';
import { mdiLink } from '@mdi/js';
import { serverConfig } from '$lib/stores/server-config.store';
export let albumId: string | undefined = undefined;
export let assetIds: string[] = [];
@ -82,7 +83,7 @@
showMetadata,
},
});
sharedLink = `${window.location.origin}/share/${data.key}`;
sharedLink = makeSharedLinkUrl($serverConfig.externalDomain, data.key);
} catch (e) {
handleError(e, 'Failed to create shared link');
}
@ -182,7 +183,7 @@
{:else}
<div class="text-sm">
Individual shared | <span class="text-immich-primary dark:text-immich-dark-primary"
>{editingLink.description}</span
>{editingLink.description || ''}</span
>
</div>
{/if}

View File

@ -26,6 +26,7 @@ export const serverConfig = writable<ServerConfig>({
loginPageMessage: '',
trashDays: 30,
isInitialized: false,
externalDomain: '',
});
export const loadConfig = async () => {

View File

@ -1,6 +1,6 @@
<script lang="ts">
import ControlAppBar from '$lib/components/shared-components/control-app-bar.svelte';
import { api, copyToClipboard, SharedLinkResponseDto } from '@api';
import { api, copyToClipboard, makeSharedLinkUrl, SharedLinkResponseDto } from '@api';
import { goto } from '$app/navigation';
import SharedLinkCard from '$lib/components/sharedlinks-page/shared-link-card.svelte';
import {
@ -13,6 +13,7 @@
import { handleError } from '$lib/utils/handle-error';
import { AppRoute } from '$lib/constants';
import { mdiArrowLeft } from '@mdi/js';
import { serverConfig } from '$lib/stores/server-config.store';
let sharedLinks: SharedLinkResponseDto[] = [];
let editSharedLink: SharedLinkResponseDto | null = null;
@ -49,7 +50,7 @@
};
const handleCopyLink = async (key: string) => {
await copyToClipboard(`${window.location.origin}/share/${key}`);
await copyToClipboard(makeSharedLinkUrl($serverConfig.externalDomain, key));
};
</script>

View File

@ -9,6 +9,7 @@
import SettingAccordion from '$lib/components/admin-page/settings/setting-accordion.svelte';
import StorageTemplateSettings from '$lib/components/admin-page/settings/storage-template/storage-template-settings.svelte';
import ThumbnailSettings from '$lib/components/admin-page/settings/thumbnail/thumbnail-settings.svelte';
import ServerSettings from '$lib/components/admin-page/settings/server/server-settings.svelte';
import TrashSettings from '$lib/components/admin-page/settings/trash-settings/trash-settings.svelte';
import ThemeSettings from '$lib/components/admin-page/settings/theme/theme-settings.svelte';
import LinkButton from '$lib/components/elements/buttons/link-button.svelte';
@ -95,6 +96,10 @@
<PasswordLoginSettings disabled={$featureFlags.configFile} passwordLoginConfig={configs.passwordLogin} />
</SettingAccordion>
<SettingAccordion title="Server Settings" subtitle="Manage server settings">
<ServerSettings disabled={$featureFlags.configFile} serverConfig={configs.server} />
</SettingAccordion>
<SettingAccordion
title="Storage Template"
subtitle="Manage the folder structure and file name of the upload asset"