sascha
/
immich
mirror of https://github.com/immich-app/immich.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat(server)!: move welcome message to settings (#6157) 

* feat(server): move welcome message to settings

* chore: open api
pull/6163/head
Jason Rasmussen 2024-01-04 00:00:17 +07:00 committed by GitHub
parent 52e92e9bb4
commit f8d64be13c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 59 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
cli/src/api/open-api/api.ts generated
Unescape Escape View File

@ -4038,6 +4038,12 @@ export interface SystemConfigServerDto {
* @memberof SystemConfigServerDto
*/
'externalDomain': string;
/**
*
* @type {string}
* @memberof SystemConfigServerDto
*/
'loginPageMessage': string;
}
/**
*

17
docs/docs/install/environment-variables.md
Unescape Escape View File

@ -30,15 +30,14 @@ These environment variables are used by the `docker-compose.yml` file and do **N
## General
| Variable | Description | Default | Services |
| :-------------------------- | :------------------------------------------- | :-----------------: | :------------------------------------------- |
| `TZ` | Timezone | | microservices |
| `NODE_ENV` | Environment (production, development) | `production` | server, microservices, machine learning, web |
| `LOG_LEVEL` | Log Level (verbose, debug, log, warn, error) | `log` | server, microservices |
| `IMMICH_MEDIA_LOCATION` | Media Location | `./upload` | server, microservices |
| `PUBLIC_LOGIN_PAGE_MESSAGE` | Public Login Page Message | | web |
| `IMMICH_CONFIG_FILE` | Path to config file | | server |
| `IMMICH_WEB_ROOT` | Path of root index.html | `/usr/src/app/www'` | server |
| Variable | Description | Default | Services |
| :---------------------- | :------------------------------------------- | :-----------------: | :------------------------------------------- |
| `TZ` | Timezone | | microservices |
| `NODE_ENV` | Environment (production, development) | `production` | server, microservices, machine learning, web |
| `LOG_LEVEL` | Log Level (verbose, debug, log, warn, error) | `log` | server, microservices |
| `IMMICH_MEDIA_LOCATION` | Media Location | `./upload` | server, microservices |
| `IMMICH_CONFIG_FILE` | Path to config file | | server |
| `IMMICH_WEB_ROOT` | Path of root index.html | `/usr/src/app/www'` | server |
:::tip

1
mobile/openapi/doc/SystemConfigServerDto.md generated
Unescape Escape View File

@ -9,6 +9,7 @@ import 'package:openapi/api.dart';
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**externalDomain** | **String** | |
**loginPageMessage** | **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)

14
mobile/openapi/lib/model/system_config_server_dto.dart generated
Unescape Escape View File

@ -14,25 +14,31 @@ class SystemConfigServerDto {
/// Returns a new [SystemConfigServerDto] instance.
SystemConfigServerDto({
required this.externalDomain,
required this.loginPageMessage,
});
String externalDomain;
String loginPageMessage;
@override
bool operator ==(Object other) => identical(this, other) || other is SystemConfigServerDto &&
other.externalDomain == externalDomain;
other.externalDomain == externalDomain &&
other.loginPageMessage == loginPageMessage;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(externalDomain.hashCode);
(externalDomain.hashCode) +
(loginPageMessage.hashCode);
@override
String toString() => 'SystemConfigServerDto[externalDomain=$externalDomain]';
String toString() => 'SystemConfigServerDto[externalDomain=$externalDomain, loginPageMessage=$loginPageMessage]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'externalDomain'] = this.externalDomain;
json[r'loginPageMessage'] = this.loginPageMessage;
return json;
}
@ -45,6 +51,7 @@ class SystemConfigServerDto {
return SystemConfigServerDto(
externalDomain: mapValueOfType<String>(json, r'externalDomain')!,
loginPageMessage: mapValueOfType<String>(json, r'loginPageMessage')!,
);
}
return null;
@ -93,6 +100,7 @@ class SystemConfigServerDto {
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'externalDomain',
'loginPageMessage',
};
}

5
mobile/openapi/test/system_config_server_dto_test.dart generated
Unescape Escape View File

@ -21,6 +21,11 @@ void main() {
// TODO
});
// String loginPageMessage
test('to test the property `loginPageMessage`', () async {
// TODO
});
});

6
server/immich-openapi-specs.json
Unescape Escape View File

@ -9371,10 +9371,14 @@
"properties": {
"externalDomain": {
"type": "string"
},
"loginPageMessage": {
"type": "string"
}
},
"required": [
"externalDomain"
"externalDomain",
"loginPageMessage"
],
"type": "object"
},

6
server/src/domain/server-info/server-info.service.ts
Unescape Escape View File

@ -78,14 +78,10 @@ export class ServerInfoService {
async getConfig(): Promise<ServerConfigDto> {
const config = await this.configCore.getConfig();
// TODO move to system config
const loginPageMessage = process.env.PUBLIC_LOGIN_PAGE_MESSAGE || '';
const isInitialized = await this.userRepository.hasAdmin();
return {
loginPageMessage,
loginPageMessage: config.server.loginPageMessage,
trashDays: config.trash.days,
oauthButtonText: config.oauth.buttonText,
isInitialized,

3
server/src/domain/system-config/dto/system-config-server.dto.ts
Unescape Escape View File

@ -3,4 +3,7 @@ import { IsString } from 'class-validator';
export class SystemConfigServerDto {
@IsString()
externalDomain!: string;
@IsString()
loginPageMessage!: string;
}

1
server/src/domain/system-config/system-config.core.ts
Unescape Escape View File

@ -129,6 +129,7 @@ export const defaults = Object.freeze<SystemConfig>({
},
server: {
externalDomain: '',
loginPageMessage: '',
},
});

1
server/src/domain/system-config/system-config.service.spec.ts
Unescape Escape View File

@ -102,6 +102,7 @@ const updatedConfig = Object.freeze<SystemConfig>({
},
server: {
externalDomain: '',
loginPageMessage: '',
},
storageTemplate: {
enabled: false,

2
server/src/infra/entities/system-config.entity.ts
Unescape Escape View File

@ -85,6 +85,7 @@ export enum SystemConfigKey {
PASSWORD_LOGIN_ENABLED = 'passwordLogin.enabled',
SERVER_EXTERNAL_DOMAIN = 'server.externalDomain',
SERVER_LOGIN_PAGE_MESSAGE = 'server.loginPageMessage',
STORAGE_TEMPLATE_ENABLED = 'storageTemplate.enabled',
STORAGE_TEMPLATE_HASH_VERIFICATION_ENABLED = 'storageTemplate.hashVerificationEnabled',
@ -248,5 +249,6 @@ export interface SystemConfig {
};
server: {
externalDomain: string;
loginPageMessage: string;
};
}

6
web/src/api/open-api/api.ts generated
Unescape Escape View File

@ -4038,6 +4038,12 @@ export interface SystemConfigServerDto {
* @memberof SystemConfigServerDto
*/
'externalDomain': string;
/**
*
* @type {string}
* @memberof SystemConfigServerDto
*/
'loginPageMessage': string;
}
/**
*

9
web/src/lib/components/admin-page/settings/server/server-settings.svelte
Unescape Escape View File

@ -92,6 +92,15 @@
bind:value={serverConfig.externalDomain}
isEdited={serverConfig.externalDomain !== savedConfig.externalDomain}
/>
<SettingInputField
inputType={SettingInputFieldType.TEXT}
label="WELCOME MESSAGE"
desc="A message that is displayed on the login page."
bind:value={serverConfig.loginPageMessage}
isEdited={serverConfig.loginPageMessage !== savedConfig.loginPageMessage}
/>
<div class="ml-4">
<SettingButtonsRow
on:reset={({ detail }) => handleReset(detail)}