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

* feat(server): move welcome message to settings * chore: open api
MiguelAraCo · Jan 4, 2024 · f8d64be · f8d64be
1 parent 52e92e9
commit f8d64be
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 18 deletions.
diff --git a/cli/src/api/open-api/api.ts b/cli/src/api/open-api/api.ts
diff --git a/docs/docs/install/environment-variables.md b/docs/docs/install/environment-variables.md
@@ -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
 

diff --git a/mobile/openapi/doc/SystemConfigServerDto.md b/mobile/openapi/doc/SystemConfigServerDto.md
diff --git a/mobile/openapi/lib/model/system_config_server_dto.dart b/mobile/openapi/lib/model/system_config_server_dto.dart
diff --git a/mobile/openapi/test/system_config_server_dto_test.dart b/mobile/openapi/test/system_config_server_dto_test.dart
diff --git a/server/immich-openapi-specs.json b/server/immich-openapi-specs.json
@@ -9371,10 +9371,14 @@
         "properties": {
           "externalDomain": {
             "type": "string"
+          },
+          "loginPageMessage": {
+            "type": "string"
           }
         },
         "required": [
-          "externalDomain"
+          "externalDomain",
+          "loginPageMessage"
         ],
         "type": "object"
       },

diff --git a/server/src/domain/server-info/server-info.service.ts b/server/src/domain/server-info/server-info.service.ts
@@ -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,

diff --git a/server/src/domain/system-config/dto/system-config-server.dto.ts b/server/src/domain/system-config/dto/system-config-server.dto.ts
@@ -3,4 +3,7 @@ import { IsString } from 'class-validator';
 export class SystemConfigServerDto {
   @IsString()
   externalDomain!: string;
+
+  @IsString()
+  loginPageMessage!: string;
 }
diff --git a/server/src/domain/system-config/system-config.core.ts b/server/src/domain/system-config/system-config.core.ts
@@ -129,6 +129,7 @@ export const defaults = Object.freeze<SystemConfig>({
   },
   server: {
     externalDomain: '',
+    loginPageMessage: '',
   },
 });
 

diff --git a/server/src/domain/system-config/system-config.service.spec.ts b/server/src/domain/system-config/system-config.service.spec.ts
@@ -102,6 +102,7 @@ const updatedConfig = Object.freeze<SystemConfig>({
   },
   server: {
     externalDomain: '',
+    loginPageMessage: '',
   },
   storageTemplate: {
     enabled: false,

diff --git a/server/src/infra/entities/system-config.entity.ts b/server/src/infra/entities/system-config.entity.ts
@@ -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;
   };
 }
diff --git a/web/src/api/open-api/api.ts b/web/src/api/open-api/api.ts
diff --git a/web/src/lib/components/admin-page/settings/server/server-settings.svelte b/web/src/lib/components/admin-page/settings/server/server-settings.svelte
@@ -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)}
-Original file line number
+Diff line change
@@ Expand Up / @@ -129,6 +129,7 @@ export const defaults = Object.freeze<SystemConfig>({ @@
       },
       server: {
         externalDomain: '',
+        loginPageMessage: '',
       },
     });
@@ Expand Down @@