feat(server,web): system config for admin (#959)

* feat: add admin config module for user configured config, uses it for ffmpeg

* feat: add api endpoint to retrieve admin config settings and values

* feat: add settings panel to admin page on web (wip)

* feat: add api endpoint to update the admin config

* chore: re-generate openapi spec after rebase

* refactor: move from admin config to system config naming

* chore: move away from UseGuards to new @Authenticated decorator

* style: dark mode styling for lists and fix conflicting colors

* wip: 2 column design, no edit button

* refactor: system config

* chore: generate open api

* chore: rm broken test

* chore: cleanup types

* refactor: config module names

Co-authored-by: Zack Pollard <zackpollard@ymail.com>
Co-authored-by: Zack Pollard <zack.pollard@moonpig.com>

server/apps/immich/src/api-v1/system-config/dto/update-system-config.ts

@@ -0,0 +1,20 @@
+import { SystemConfigKey, SystemConfigValue } from '@app/database/entities/system-config.entity';
+import { ApiProperty } from '@nestjs/swagger';
+import { IsEnum, IsNotEmpty, ValidateNested } from 'class-validator';
+
+export class UpdateSystemConfigDto {
+  @IsNotEmpty()
+  @ValidateNested({ each: true })
+  config!: SystemConfigItem[];
+}
+
+export class SystemConfigItem {
+  @IsNotEmpty()
+  @IsEnum(SystemConfigKey)
+  @ApiProperty({
+    enum: SystemConfigKey,
+    enumName: 'SystemConfigKey',
+  })
+  key!: SystemConfigKey;
+  value!: SystemConfigValue;
+}

server/apps/immich/src/api-v1/system-config/response-dto/system-config-response.dto.ts

@@ -0,0 +1,20 @@
+import { SystemConfigKey, SystemConfigValue } from '@app/database/entities/system-config.entity';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class SystemConfigResponseDto {
+  config!: SystemConfigResponseItem[];
+}
+
+export class SystemConfigResponseItem {
+  @ApiProperty({ type: 'string' })
+  name!: string;
+
+  @ApiProperty({ enumName: 'SystemConfigKey', enum: SystemConfigKey })
+  key!: SystemConfigKey;
+
+  @ApiProperty({ type: 'string' })
+  value!: SystemConfigValue;
+
+  @ApiProperty({ type: 'string' })
+  defaultValue!: SystemConfigValue;
+}

server/apps/immich/src/api-v1/system-config/system-config.controller.ts

@@ -0,0 +1,24 @@
+import { Body, Controller, Get, Put, ValidationPipe } from '@nestjs/common';
+import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
+import { Authenticated } from '../../decorators/authenticated.decorator';
+import { UpdateSystemConfigDto } from './dto/update-system-config';
+import { SystemConfigResponseDto } from './response-dto/system-config-response.dto';
+import { SystemConfigService } from './system-config.service';
+
+@ApiTags('System Config')
+@ApiBearerAuth()
+@Authenticated({ admin: true })
+@Controller('system-config')
+export class SystemConfigController {
+  constructor(private readonly systemConfigService: SystemConfigService) {}
+
+  @Get()
+  getConfig(): Promise<SystemConfigResponseDto> {
+    return this.systemConfigService.getConfig();
+  }
+
+  @Put()
+  async updateConfig(@Body(ValidationPipe) dto: UpdateSystemConfigDto): Promise<SystemConfigResponseDto> {
+    return this.systemConfigService.updateConfig(dto);
+  }
+}

server/apps/immich/src/api-v1/system-config/system-config.module.ts

@@ -0,0 +1,14 @@
+import { SystemConfigEntity } from '@app/database/entities/system-config.entity';
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { ImmichConfigModule } from 'libs/immich-config/src';
+import { ImmichJwtModule } from '../../modules/immich-jwt/immich-jwt.module';
+import { SystemConfigController } from './system-config.controller';
+import { SystemConfigService } from './system-config.service';
+
+@Module({
+  imports: [ImmichJwtModule, ImmichConfigModule, TypeOrmModule.forFeature([SystemConfigEntity])],
+  controllers: [SystemConfigController],
+  providers: [SystemConfigService],
+})
+export class SystemConfigModule {}

server/apps/immich/src/api-v1/system-config/system-config.service.ts

@@ -0,0 +1,20 @@
+import { Injectable } from '@nestjs/common';
+import { ImmichConfigService } from 'libs/immich-config/src';
+import { UpdateSystemConfigDto } from './dto/update-system-config';
+import { SystemConfigResponseDto } from './response-dto/system-config-response.dto';
+
+@Injectable()
+export class SystemConfigService {
+  constructor(private immichConfigService: ImmichConfigService) {}
+
+  async getConfig(): Promise<SystemConfigResponseDto> {
+    const config = await this.immichConfigService.getSystemConfig();
+    return { config };
+  }
+
+  async updateConfig(dto: UpdateSystemConfigDto): Promise<SystemConfigResponseDto> {
+    await this.immichConfigService.updateSystemConfig(dto.config);
+    const config = await this.immichConfigService.getSystemConfig();
+    return { config };
+  }
+}

server/apps/immich/src/app.module.ts

@@ -16,6 +16,7 @@ import { ScheduleModule } from '@nestjs/schedule';
 import { ScheduleTasksModule } from './modules/schedule-tasks/schedule-tasks.module';
 import { DatabaseModule } from '@app/database';
 import { JobModule } from './api-v1/job/job.module';
+import { SystemConfigModule } from './api-v1/system-config/system-config.module';
 import { OAuthModule } from './api-v1/oauth/oauth.module';
 
 @Module({
@@ -60,6 +61,8 @@ import { OAuthModule } from './api-v1/oauth/oauth.module';
     ScheduleTasksModule,
 
     JobModule,
+
+    SystemConfigModule,
   ],
   controllers: [AppController],
   providers: [],

server/apps/microservices/src/microservices.module.ts

@@ -7,8 +7,9 @@ import { UserEntity } from '@app/database/entities/user.entity';
 import { QueueNameEnum } from '@app/job/constants/queue-name.constant';
 import { BullModule } from '@nestjs/bull';
 import { Module } from '@nestjs/common';
-import { ConfigModule, ConfigService } from '@nestjs/config';
+import { ConfigModule } from '@nestjs/config';
 import { TypeOrmModule } from '@nestjs/typeorm';
+import { ImmichConfigModule } from 'libs/immich-config/src';
 import { CommunicationModule } from '../../immich/src/api-v1/communication/communication.module';
 import { MicroservicesService } from './microservices.service';
 import { AssetUploadedProcessor } from './processors/asset-uploaded.processor';
@@ -22,6 +23,7 @@ import { VideoTranscodeProcessor } from './processors/video-transcode.processor'
   imports: [
     ConfigModule.forRoot(immichAppConfig),
     DatabaseModule,
+    ImmichConfigModule,
     TypeOrmModule.forFeature([UserEntity, ExifEntity, AssetEntity, SmartInfoEntity]),
     BullModule.forRootAsync({
       useFactory: async () => ({
@@ -96,7 +98,6 @@ import { VideoTranscodeProcessor } from './processors/video-transcode.processor'
     VideoTranscodeProcessor,
     GenerateChecksumProcessor,
     MachineLearningProcessor,
-    ConfigService,
   ],
   exports: [],
 })

server/apps/microservices/src/processors/video-transcode.processor.ts

@@ -9,6 +9,7 @@ import { InjectRepository } from '@nestjs/typeorm';
 import { Job } from 'bull';
 import ffmpeg from 'fluent-ffmpeg';
 import { existsSync, mkdirSync } from 'fs';
+import { ImmichConfigService } from 'libs/immich-config/src';
 import { Repository } from 'typeorm';
 
 @Processor(QueueNameEnum.VIDEO_CONVERSION)
@@ -16,6 +17,7 @@ export class VideoTranscodeProcessor {
   constructor(
     @InjectRepository(AssetEntity)
     private assetRepository: Repository<AssetEntity>,
+    private immichConfigService: ImmichConfigService,
   ) {}
 
   @Process({ name: mp4ConversionProcessorName, concurrency: 1 })
@@ -40,9 +42,17 @@ export class VideoTranscodeProcessor {
   }
 
   async runFFMPEGPipeLine(asset: AssetEntity, savedEncodedPath: string): Promise<void> {
+    const config = await this.immichConfigService.getSystemConfigMap();
+
     return new Promise((resolve, reject) => {
       ffmpeg(asset.originalPath)
-        .outputOptions(['-crf 23', '-preset ultrafast', '-vcodec libx264', '-acodec mp3', '-vf scale=1280:-2'])
+        .outputOptions([
+          `-crf ${config.ffmpeg_crf}`,
+          `-preset ${config.ffmpeg_preset}`,
+          `-vcodec ${config.ffmpeg_target_video_codec}`,
+          `-acodec ${config.ffmpeg_target_audio_codec}`,
+          `-vf scale=${config.ffmpeg_target_scaling}`,
+        ])
         .output(savedEncodedPath)
         .on('start', () => {
           Logger.log('Start Converting Video', 'mp4Conversion');