1
0
mirror of https://github.com/bpatrik/pigallery2.git synced 2024-12-21 01:22:08 +02:00

Moving extension folder within config folder for docker. #743

This commit is contained in:
Patrik J. Braun 2023-11-24 23:42:17 +01:00
parent fc75be1b25
commit 4fe7f31d0e
6 changed files with 277 additions and 262 deletions

View File

@ -21,6 +21,7 @@ ENV NODE_ENV=production \
default-Database-dbFolder=/app/data/db \ default-Database-dbFolder=/app/data/db \
default-Media-folder=/app/data/images \ default-Media-folder=/app/data/images \
default-Media-tempFolder=/app/data/tmp \ default-Media-tempFolder=/app/data/tmp \
default-Extensions-folder=/app/data/config/extensions \
# flagging dockerized environemnt # flagging dockerized environemnt
PI_DOCKER=true PI_DOCKER=true

View File

@ -19,6 +19,7 @@ ENV NODE_ENV=production \
default-Database-dbFolder=/app/data/db \ default-Database-dbFolder=/app/data/db \
default-Media-folder=/app/data/images \ default-Media-folder=/app/data/images \
default-Media-tempFolder=/app/data/tmp \ default-Media-tempFolder=/app/data/tmp \
default-Extensions-folder=/app/data/config/extensions \
# flagging dockerized environemnt # flagging dockerized environemnt
PI_DOCKER=true PI_DOCKER=true

View File

@ -19,6 +19,7 @@ ENV NODE_ENV=production \
default-Database-dbFolder=/app/data/db \ default-Database-dbFolder=/app/data/db \
default-Media-folder=/app/data/images \ default-Media-folder=/app/data/images \
default-Media-tempFolder=/app/data/tmp \ default-Media-tempFolder=/app/data/tmp \
default-Extensions-folder=/app/data/config/extensions \
# flagging dockerized environemnt # flagging dockerized environemnt
PI_DOCKER=true PI_DOCKER=true

View File

@ -23,6 +23,7 @@ ENV NODE_ENV=production \
default-Database-dbFolder=/app/data/db \ default-Database-dbFolder=/app/data/db \
default-Media-folder=/app/data/images \ default-Media-folder=/app/data/images \
default-Media-tempFolder=/app/data/tmp \ default-Media-tempFolder=/app/data/tmp \
default-Extensions-folder=/app/data/config/extensions \
# flagging dockerized environemnt # flagging dockerized environemnt
PI_DOCKER=true PI_DOCKER=true

View File

@ -36,7 +36,7 @@ export class ProjectPathClass {
this.TranscodedFolder = path.join(this.TempFolder, 'tc'); this.TranscodedFolder = path.join(this.TempFolder, 'tc');
this.FacesFolder = path.join(this.TempFolder, 'f'); this.FacesFolder = path.join(this.TempFolder, 'f');
this.DBFolder = this.getAbsolutePath(Config.Database.dbFolder); this.DBFolder = this.getAbsolutePath(Config.Database.dbFolder);
this.ExtensionFolder = path.join(this.Root, 'extensions'); this.ExtensionFolder = this.getAbsolutePath(Config.Extensions.folder);
// create thumbnail folder if not exist // create thumbnail folder if not exist
if (!fs.existsSync(this.TempFolder)) { if (!fs.existsSync(this.TempFolder)) {

View File

@ -87,14 +87,14 @@ export enum FFmpegPresets {
export type videoCodecType = 'libvpx-vp9' | 'libx264' | 'libvpx' | 'libx265'; export type videoCodecType = 'libvpx-vp9' | 'libx264' | 'libvpx' | 'libx265';
export type videoResolutionType = export type videoResolutionType =
| 240 | 240
| 360 | 360
| 480 | 480
| 720 | 720
| 1080 | 1080
| 1440 | 1440
| 2160 | 2160
| 4320; | 4320;
export type videoFormatType = 'mp4' | 'webm'; export type videoFormatType = 'mp4' | 'webm';
@SubConfigClass({softReadonly: true}) @SubConfigClass({softReadonly: true})
@ -102,51 +102,51 @@ export class MySQLConfig {
@ConfigProperty({ @ConfigProperty({
envAlias: 'MYSQL_HOST', envAlias: 'MYSQL_HOST',
tags: tags:
{ {
name: $localize`Host`, name: $localize`Host`,
uiResetNeeded: {server: true}, uiResetNeeded: {server: true},
priority: ConfigPriority.advanced priority: ConfigPriority.advanced
}, },
}) })
host: string = 'localhost'; host: string = 'localhost';
@ConfigProperty({ @ConfigProperty({
envAlias: 'MYSQL_PORT', min: 0, max: 65535, envAlias: 'MYSQL_PORT', min: 0, max: 65535,
tags: tags:
{ {
name: $localize`Port`, name: $localize`Port`,
uiResetNeeded: {server: true}, uiResetNeeded: {server: true},
priority: ConfigPriority.advanced priority: ConfigPriority.advanced
}, },
}) })
port: number = 3306; port: number = 3306;
@ConfigProperty({ @ConfigProperty({
envAlias: 'MYSQL_DATABASE', envAlias: 'MYSQL_DATABASE',
tags: tags:
{ {
name: $localize`Database`, name: $localize`Database`,
uiResetNeeded: {server: true}, uiResetNeeded: {server: true},
priority: ConfigPriority.advanced priority: ConfigPriority.advanced
}, },
}) })
database: string = 'pigallery2'; database: string = 'pigallery2';
@ConfigProperty({ @ConfigProperty({
envAlias: 'MYSQL_USERNAME', envAlias: 'MYSQL_USERNAME',
tags: tags:
{ {
name: $localize`Username`, name: $localize`Username`,
uiResetNeeded: {server: true}, uiResetNeeded: {server: true},
priority: ConfigPriority.advanced priority: ConfigPriority.advanced
}, },
}) })
username: string = ''; username: string = '';
@ConfigProperty({ @ConfigProperty({
envAlias: 'MYSQL_PASSWORD', type: 'password', envAlias: 'MYSQL_PASSWORD', type: 'password',
tags: tags:
{ {
name: $localize`Password`, name: $localize`Password`,
uiResetNeeded: {server: true}, uiResetNeeded: {server: true},
priority: ConfigPriority.advanced priority: ConfigPriority.advanced
} }
}) })
password: string = ''; password: string = '';
} }
@ -155,11 +155,11 @@ export class MySQLConfig {
export class SQLiteConfig { export class SQLiteConfig {
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`Sqlite db filename`, name: $localize`Sqlite db filename`,
uiResetNeeded: {server: true}, uiResetNeeded: {server: true},
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
}, },
description: $localize`Sqlite will save the db with this filename.`, description: $localize`Sqlite will save the db with this filename.`,
}) })
DBFileName: string = 'sqlite.db'; DBFileName: string = 'sqlite.db';
@ -169,51 +169,51 @@ export class SQLiteConfig {
export class UserConfig { export class UserConfig {
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`Name`, name: $localize`Name`,
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
} }
}) })
name: string; name: string;
@ConfigProperty({ @ConfigProperty({
type: UserRoles, type: UserRoles,
tags: tags:
{ {
name: $localize`Role`, name: $localize`Role`,
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
}, },
}) })
role: UserRoles = UserRoles.User; role: UserRoles = UserRoles.User;
@ConfigProperty<string, ServerConfig, TAGS>({ @ConfigProperty<string, ServerConfig, TAGS>({
type: 'string', type: 'string',
tags: tags:
{ {
name: $localize`Password`, name: $localize`Password`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
relevant: (c: UserConfig) => !c.encrypted relevant: (c: UserConfig) => !c.encrypted
}, },
description: $localize`Unencrypted, temporary password. App will encrypt it and delete this.` description: $localize`Unencrypted, temporary password. App will encrypt it and delete this.`
}) })
password: string; password: string;
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`Encrypted password`, name: $localize`Encrypted password`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
secret: true secret: true
}, },
}) })
encryptedPassword: string | undefined; encryptedPassword: string | undefined;
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
relevant: () => false // never render this on UI. Only used to indicate that encryption is done. relevant: () => false // never render this on UI. Only used to indicate that encryption is done.
} as TAGS, } as TAGS,
}) })
encrypted: boolean; encrypted: boolean;
@ -235,44 +235,44 @@ export class ServerDataBaseConfig {
@ConfigProperty<DatabaseType, ServerConfig>({ @ConfigProperty<DatabaseType, ServerConfig>({
type: DatabaseType, type: DatabaseType,
tags: tags:
{ {
name: $localize`Type`, name: $localize`Type`,
priority: ConfigPriority.advanced, priority: ConfigPriority.advanced,
uiResetNeeded: {db: true}, uiResetNeeded: {db: true},
githubIssue: 573 githubIssue: 573
} as TAGS, } as TAGS,
description: $localize`SQLite is recommended.` description: $localize`SQLite is recommended.`
}) })
type: DatabaseType = DatabaseType.sqlite; type: DatabaseType = DatabaseType.sqlite;
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`Database folder`, name: $localize`Database folder`,
uiResetNeeded: {server: true}, uiResetNeeded: {server: true},
priority: ConfigPriority.advanced priority: ConfigPriority.advanced
}, },
description: $localize`All file-based data will be stored here (sqlite database, job history data).`, description: $localize`All file-based data will be stored here (sqlite database, job history data).`,
}) })
dbFolder: string = 'db'; dbFolder: string = 'db';
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`SQLite`, name: $localize`SQLite`,
uiResetNeeded: {db: true}, uiResetNeeded: {db: true},
relevant: (c: any) => c.type === DatabaseType.sqlite, relevant: (c: any) => c.type === DatabaseType.sqlite,
} }
}) })
sqlite?: SQLiteConfig = new SQLiteConfig(); sqlite?: SQLiteConfig = new SQLiteConfig();
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`MySQL`, name: $localize`MySQL`,
uiResetNeeded: {db: true}, uiResetNeeded: {db: true},
relevant: (c: any) => c.type === DatabaseType.mysql, relevant: (c: any) => c.type === DatabaseType.mysql,
} }
}) })
mysql?: MySQLConfig = new MySQLConfig(); mysql?: MySQLConfig = new MySQLConfig();
@ -285,13 +285,13 @@ export class ServerUserConfig extends ClientUserConfig {
@ConfigProperty({ @ConfigProperty({
arrayType: UserConfig, arrayType: UserConfig,
tags: tags:
{ {
name: $localize`Enforced users`, name: $localize`Enforced users`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
uiResetNeeded: {server: true}, uiResetNeeded: {server: true},
uiOptional: true, uiOptional: true,
githubIssue: 575 githubIssue: 575
} as TAGS, } as TAGS,
description: $localize`Creates these users in the DB during startup if they do not exist. If a user with this name exist, it won't be overwritten, even if the role is different.`, description: $localize`Creates these users in the DB during startup if they do not exist. If a user with this name exist, it won't be overwritten, even if the role is different.`,
}) })
enforcedUsers: UserConfig[] = []; enforcedUsers: UserConfig[] = [];
@ -302,40 +302,40 @@ export class ServerUserConfig extends ClientUserConfig {
export class ServerThumbnailConfig extends ClientThumbnailConfig { export class ServerThumbnailConfig extends ClientThumbnailConfig {
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`High quality resampling`, name: $localize`High quality resampling`,
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
}, },
description: $localize`if true, 'lanczos3' will used to scale photos, otherwise faster but lower quality 'nearest'.` description: $localize`if true, 'lanczos3' will used to scale photos, otherwise faster but lower quality 'nearest'.`
}) })
useLanczos3: boolean = true; useLanczos3: boolean = true;
@ConfigProperty({ @ConfigProperty({
max: 100, min: 1, type: 'unsignedInt', max: 100, min: 1, type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Converted photo and thumbnail quality`, name: $localize`Converted photo and thumbnail quality`,
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
}, },
description: $localize`Between 0-100.` description: $localize`Between 0-100.`
}) })
quality = 80; quality = 80;
@ConfigProperty({ @ConfigProperty({
type: 'boolean', type: 'boolean',
tags: tags:
{ {
name: $localize`Use chroma subsampling`, name: $localize`Use chroma subsampling`,
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
}, },
description: $localize`Use high quality chroma subsampling in webp. See: https://sharp.pixelplumbing.com/api-output#webp.` description: $localize`Use high quality chroma subsampling in webp. See: https://sharp.pixelplumbing.com/api-output#webp.`
}) })
smartSubsample = true; smartSubsample = true;
@ConfigProperty({ @ConfigProperty({
type: 'float', type: 'float',
tags: tags:
{ {
name: $localize`Person face margin`, name: $localize`Person face margin`,
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
}, },
description: $localize`This ratio of the face bounding box will be added to the face as a margin. Higher number add more margin.` description: $localize`This ratio of the face bounding box will be added to the face as a margin. Higher number add more margin.`
}) })
personFaceMargin: number = 0.7; // in ratio [0-1] personFaceMargin: number = 0.7; // in ratio [0-1]
@ -345,47 +345,47 @@ export class ServerThumbnailConfig extends ClientThumbnailConfig {
export class ServerGPXCompressingConfig extends ClientGPXCompressingConfig { export class ServerGPXCompressingConfig extends ClientGPXCompressingConfig {
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`OnTheFly *.gpx compression`, name: $localize`OnTheFly *.gpx compression`,
priority: ConfigPriority.advanced, priority: ConfigPriority.advanced,
uiDisabled: (sc: ServerGPXCompressingConfig, c: ServerConfig) => !c.Map.enabled || !sc.enabled || !c.MetaFile.gpx uiDisabled: (sc: ServerGPXCompressingConfig, c: ServerConfig) => !c.Map.enabled || !sc.enabled || !c.MetaFile.gpx
}, },
description: $localize`Enables on the fly *.gpx compression.`, description: $localize`Enables on the fly *.gpx compression.`,
}) })
onTheFly: boolean = true; onTheFly: boolean = true;
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Min distance`, name: $localize`Min distance`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
unit: 'm', unit: 'm',
uiDisabled: (sc: ServerGPXCompressingConfig, c: ServerConfig) => !c.Map.enabled || !sc.enabled || !c.MetaFile.gpx uiDisabled: (sc: ServerGPXCompressingConfig, c: ServerConfig) => !c.Map.enabled || !sc.enabled || !c.MetaFile.gpx
} as TAGS, } as TAGS,
description: $localize`Filters out entry that are closer than this to each other in meters.` description: $localize`Filters out entry that are closer than this to each other in meters.`
}) })
minDistance: number = 5; minDistance: number = 5;
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Max middle point deviance`, name: $localize`Max middle point deviance`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
unit: 'm', unit: 'm',
uiDisabled: (sc: ServerGPXCompressingConfig, c: ServerConfig) => !c.Map.enabled || !sc.enabled || !c.MetaFile.gpx uiDisabled: (sc: ServerGPXCompressingConfig, c: ServerConfig) => !c.Map.enabled || !sc.enabled || !c.MetaFile.gpx
} as TAGS, } as TAGS,
description: $localize`Filters out entry that would fall on the line if we would just connect the previous and the next points. This setting sets the sensitivity for that (higher number, more points are filtered).` description: $localize`Filters out entry that would fall on the line if we would just connect the previous and the next points. This setting sets the sensitivity for that (higher number, more points are filtered).`
}) })
maxMiddleDeviance: number = 5; maxMiddleDeviance: number = 5;
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Min time delta`, name: $localize`Min time delta`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
unit: 'ms', unit: 'ms',
uiDisabled: (sc: ServerGPXCompressingConfig, c: ServerConfig) => !c.Map.enabled || !sc.enabled || !c.MetaFile.gpx uiDisabled: (sc: ServerGPXCompressingConfig, c: ServerConfig) => !c.Map.enabled || !sc.enabled || !c.MetaFile.gpx
} as TAGS, } as TAGS,
description: $localize`Filters out entry that are closer than this in time in milliseconds.` description: $localize`Filters out entry that are closer than this in time in milliseconds.`
}) })
minTimeDistance: number = 5000; minTimeDistance: number = 5000;
@ -395,17 +395,17 @@ export class ServerGPXCompressingConfig extends ClientGPXCompressingConfig {
export class ServerMetaFileConfig extends ClientMetaFileConfig { export class ServerMetaFileConfig extends ClientMetaFileConfig {
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`GPX compression`, name: $localize`GPX compression`,
priority: ConfigPriority.advanced, priority: ConfigPriority.advanced,
uiJob: [{ uiJob: [{
job: DefaultsJobs[DefaultsJobs['GPX Compression']], job: DefaultsJobs[DefaultsJobs['GPX Compression']],
relevant: (c) => c.MetaFile.GPXCompressing.enabled relevant: (c) => c.MetaFile.GPXCompressing.enabled
}, { }, {
job: DefaultsJobs[DefaultsJobs['Delete Compressed GPX']], job: DefaultsJobs[DefaultsJobs['Delete Compressed GPX']],
relevant: (c) => c.MetaFile.GPXCompressing.enabled relevant: (c) => c.MetaFile.GPXCompressing.enabled
}] }]
} as TAGS } as TAGS
}) })
GPXCompressing: ServerGPXCompressingConfig = new ServerGPXCompressingConfig(); GPXCompressing: ServerGPXCompressingConfig = new ServerGPXCompressingConfig();
} }
@ -416,11 +416,11 @@ export class ServerSharingConfig extends ClientSharingConfig {
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Update timeout`, name: $localize`Update timeout`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
unit: 'ms' unit: 'ms'
} as TAGS, } as TAGS,
description: $localize`After creating a sharing link, it can be updated for this long.` description: $localize`After creating a sharing link, it can be updated for this long.`
}) })
updateTimeout: number = 1000 * 60 * 5; updateTimeout: number = 1000 * 60 * 5;
@ -431,47 +431,47 @@ export class ServerIndexingConfig {
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Index cache timeout`, name: $localize`Index cache timeout`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
unit: 'ms' unit: 'ms'
} as TAGS, } as TAGS,
description: $localize`If there was no indexing in this time, it reindexes. (skipped if indexes are in DB and sensitivity is low).` description: $localize`If there was no indexing in this time, it reindexes. (skipped if indexes are in DB and sensitivity is low).`
}) })
cachedFolderTimeout: number = 1000 * 60 * 60; // Do not rescans the folder if seems ok cachedFolderTimeout: number = 1000 * 60 * 60; // Do not rescans the folder if seems ok
@ConfigProperty({ @ConfigProperty({
type: ReIndexingSensitivity, type: ReIndexingSensitivity,
tags: tags:
{ {
name: $localize`Folder reindexing sensitivity`, name: $localize`Folder reindexing sensitivity`,
priority: ConfigPriority.advanced priority: ConfigPriority.advanced
}, },
description: $localize`Set the reindexing sensitivity. High value check the folders for change more often. Setting to never only indexes if never indexed or explicit running the Indexing Job.` description: $localize`Set the reindexing sensitivity. High value check the folders for change more often. Setting to never only indexes if never indexed or explicit running the Indexing Job.`
}) })
reIndexingSensitivity: ReIndexingSensitivity = ReIndexingSensitivity.low; reIndexingSensitivity: ReIndexingSensitivity = ReIndexingSensitivity.low;
@ConfigProperty({ @ConfigProperty({
arrayType: 'string', arrayType: 'string',
tags: tags:
{ {
name: $localize`Exclude Folder List`, name: $localize`Exclude Folder List`,
priority: ConfigPriority.advanced, priority: ConfigPriority.advanced,
uiResetNeeded: {server: true, db: true}, uiResetNeeded: {server: true, db: true},
uiOptional: true, uiOptional: true,
uiAllowSpaces: true uiAllowSpaces: true
} as TAGS, } as TAGS,
description: $localize`Folders to exclude from indexing. If an entry starts with '/' it is treated as an absolute path. If it doesn't start with '/' but contains a '/', the path is relative to the image directory. If it doesn't contain a '/', any folder with this name will be excluded.`, description: $localize`Folders to exclude from indexing. If an entry starts with '/' it is treated as an absolute path. If it doesn't start with '/' but contains a '/', the path is relative to the image directory. If it doesn't contain a '/', any folder with this name will be excluded.`,
}) })
excludeFolderList: string[] = ['.Trash-1000', '.dtrash', '$RECYCLE.BIN']; excludeFolderList: string[] = ['.Trash-1000', '.dtrash', '$RECYCLE.BIN'];
@ConfigProperty({ @ConfigProperty({
arrayType: 'string', arrayType: 'string',
tags: tags:
{ {
name: $localize`Exclude File List`, name: $localize`Exclude File List`,
priority: ConfigPriority.advanced, priority: ConfigPriority.advanced,
uiResetNeeded: {server: true, db: true}, uiResetNeeded: {server: true, db: true},
uiOptional: true, uiOptional: true,
hint: $localize`.ignore;.pg2ignore` hint: $localize`.ignore;.pg2ignore`
} as TAGS, } as TAGS,
description: $localize`Files that mark a folder to be excluded from indexing. Any folder that contains a file with this name will be excluded from indexing.`, description: $localize`Files that mark a folder to be excluded from indexing. Any folder that contains a file with this name will be excluded from indexing.`,
}) })
excludeFileList: string[] = []; excludeFileList: string[] = [];
@ -482,10 +482,10 @@ export class ServerDuplicatesConfig {
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Max duplicates`, name: $localize`Max duplicates`,
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
}, },
description: $localize`Maximum number of duplicates to list.` description: $localize`Maximum number of duplicates to list.`
}) })
listingLimit: number = 1000; listingLimit: number = 1000;
@ -586,21 +586,21 @@ export class JobScheduleConfig implements JobScheduleDTO {
}, },
}) })
trigger: trigger:
| AfterJobTriggerConfig
| NeverJobTriggerConfig
| PeriodicJobTriggerConfig
| ScheduledJobTriggerConfig;
constructor(
name: string,
jobName: string,
trigger:
| AfterJobTriggerConfig | AfterJobTriggerConfig
| NeverJobTriggerConfig | NeverJobTriggerConfig
| PeriodicJobTriggerConfig | PeriodicJobTriggerConfig
| ScheduledJobTriggerConfig; | ScheduledJobTriggerConfig,
config: any = {},
constructor( allowParallelRun: boolean = false
name: string,
jobName: string,
trigger:
| AfterJobTriggerConfig
| NeverJobTriggerConfig
| PeriodicJobTriggerConfig
| ScheduledJobTriggerConfig,
config: any = {},
allowParallelRun: boolean = false
) { ) {
this.name = name; this.name = name;
this.jobName = jobName; this.jobName = jobName;
@ -615,20 +615,20 @@ export class ServerJobConfig {
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Max saved progress`, name: $localize`Max saved progress`,
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
}, },
description: $localize`Job history size.` description: $localize`Job history size.`
}) })
maxSavedProgress: number = 20; maxSavedProgress: number = 20;
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Processing batch size`, name: $localize`Processing batch size`,
priority: ConfigPriority.underTheHood priority: ConfigPriority.underTheHood
}, },
description: $localize`Jobs load this many photos or videos form the DB for processing at once.` description: $localize`Jobs load this many photos or videos form the DB for processing at once.`
}) })
mediaProcessingBatchSize: number = 1000; mediaProcessingBatchSize: number = 1000;
@ -641,46 +641,46 @@ export class ServerJobConfig {
}) })
scheduled: JobScheduleConfig[] = [ scheduled: JobScheduleConfig[] = [
new JobScheduleConfig( new JobScheduleConfig(
DefaultsJobs[DefaultsJobs.Indexing], DefaultsJobs[DefaultsJobs.Indexing],
DefaultsJobs[DefaultsJobs.Indexing], DefaultsJobs[DefaultsJobs.Indexing],
new NeverJobTriggerConfig(), new NeverJobTriggerConfig(),
{indexChangesOnly: true} // set config explicitly, so it is not undefined on the UI {indexChangesOnly: true} // set config explicitly, so it is not undefined on the UI
), ),
new JobScheduleConfig( new JobScheduleConfig(
DefaultsJobs[DefaultsJobs['Album Cover Filling']], DefaultsJobs[DefaultsJobs['Album Cover Filling']],
DefaultsJobs[DefaultsJobs['Album Cover Filling']], DefaultsJobs[DefaultsJobs['Album Cover Filling']],
new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Indexing']]), new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Indexing']]),
{} {}
), ),
new JobScheduleConfig( new JobScheduleConfig(
DefaultsJobs[DefaultsJobs['Thumbnail Generation']], DefaultsJobs[DefaultsJobs['Thumbnail Generation']],
DefaultsJobs[DefaultsJobs['Thumbnail Generation']], DefaultsJobs[DefaultsJobs['Thumbnail Generation']],
new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Album Cover Filling']]), new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Album Cover Filling']]),
{sizes: [240], indexedOnly: true} {sizes: [240], indexedOnly: true}
), ),
new JobScheduleConfig( new JobScheduleConfig(
DefaultsJobs[DefaultsJobs['Photo Converting']], DefaultsJobs[DefaultsJobs['Photo Converting']],
DefaultsJobs[DefaultsJobs['Photo Converting']], DefaultsJobs[DefaultsJobs['Photo Converting']],
new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Thumbnail Generation']]), new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Thumbnail Generation']]),
{indexedOnly: true} {indexedOnly: true}
), ),
new JobScheduleConfig( new JobScheduleConfig(
DefaultsJobs[DefaultsJobs['Video Converting']], DefaultsJobs[DefaultsJobs['Video Converting']],
DefaultsJobs[DefaultsJobs['Video Converting']], DefaultsJobs[DefaultsJobs['Video Converting']],
new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Photo Converting']]), new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Photo Converting']]),
{indexedOnly: true} {indexedOnly: true}
), ),
new JobScheduleConfig( new JobScheduleConfig(
DefaultsJobs[DefaultsJobs['GPX Compression']], DefaultsJobs[DefaultsJobs['GPX Compression']],
DefaultsJobs[DefaultsJobs['GPX Compression']], DefaultsJobs[DefaultsJobs['GPX Compression']],
new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Video Converting']]), new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['Video Converting']]),
{indexedOnly: true} {indexedOnly: true}
), ),
new JobScheduleConfig( new JobScheduleConfig(
DefaultsJobs[DefaultsJobs['Temp Folder Cleaning']], DefaultsJobs[DefaultsJobs['Temp Folder Cleaning']],
DefaultsJobs[DefaultsJobs['Temp Folder Cleaning']], DefaultsJobs[DefaultsJobs['Temp Folder Cleaning']],
new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['GPX Compression']]), new AfterJobTriggerConfig(DefaultsJobs[DefaultsJobs['GPX Compression']]),
{indexedOnly: true} {indexedOnly: true}
), ),
]; ];
} }
@ -690,73 +690,73 @@ export class VideoTranscodingConfig {
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Bit rate`, name: $localize`Bit rate`,
priority: ConfigPriority.advanced, priority: ConfigPriority.advanced,
unit: 'bps' unit: 'bps'
}, },
description: $localize`Target bit rate of the output video will be scaled down this this. This should be less than the upload rate of your home server.` description: $localize`Target bit rate of the output video will be scaled down this this. This should be less than the upload rate of your home server.`
}) })
bitRate: number = 5 * 1024 * 1024; bitRate: number = 5 * 1024 * 1024;
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', type: 'unsignedInt',
tags: tags:
{ {
name: $localize`Resolution`, name: $localize`Resolution`,
priority: ConfigPriority.advanced, priority: ConfigPriority.advanced,
uiOptions: [720, 1080, 1440, 2160, 4320], uiOptions: [720, 1080, 1440, 2160, 4320],
unit: 'px' unit: 'px'
}, },
description: $localize`The height of the output video will be scaled down to this, while keeping the aspect ratio.` description: $localize`The height of the output video will be scaled down to this, while keeping the aspect ratio.`
}) })
resolution: videoResolutionType = 720; resolution: videoResolutionType = 720;
@ConfigProperty({ @ConfigProperty({
type: 'positiveFloat', type: 'positiveFloat',
tags: tags:
{ {
name: $localize`FPS`, name: $localize`FPS`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
uiOptions: [24, 25, 30, 48, 50, 60] uiOptions: [24, 25, 30, 48, 50, 60]
}, },
description: $localize`Target frame per second (fps) of the output video will be scaled down this this.` description: $localize`Target frame per second (fps) of the output video will be scaled down this this.`
}) })
fps: number = 25; fps: number = 25;
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`Format`, name: $localize`Format`,
priority: ConfigPriority.advanced, priority: ConfigPriority.advanced,
uiOptions: ['mp4', 'webm'] uiOptions: ['mp4', 'webm']
} }
}) })
format: videoFormatType = 'mp4'; format: videoFormatType = 'mp4';
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`MP4 codec`, name: $localize`MP4 codec`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
uiOptions: ['libx264', 'libx265'], uiOptions: ['libx264', 'libx265'],
relevant: (c: any) => c.format === 'mp4' relevant: (c: any) => c.format === 'mp4'
} }
}) })
mp4Codec: videoCodecType = 'libx264'; mp4Codec: videoCodecType = 'libx264';
@ConfigProperty({ @ConfigProperty({
tags: tags:
{ {
name: $localize`Webm Codec`, name: $localize`Webm Codec`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
uiOptions: ['libvpx', 'libvpx-vp9'], uiOptions: ['libvpx', 'libvpx-vp9'],
relevant: (c: any) => c.format === 'webm' relevant: (c: any) => c.format === 'webm'
} }
}) })
webmCodec: videoCodecType = 'libvpx'; webmCodec: videoCodecType = 'libvpx';
@ConfigProperty({ @ConfigProperty({
type: 'unsignedInt', max: 51, type: 'unsignedInt', max: 51,
tags: tags:
{ {
name: $localize`CRF`, name: $localize`CRF`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
}, },
description: $localize`The range of the Constant Rate Factor (CRF) scale is 0–51, where 0 is lossless, 23 is the default, and 51 is worst quality possible.`, description: $localize`The range of the Constant Rate Factor (CRF) scale is 0–51, where 0 is lossless, 23 is the default, and 51 is worst quality possible.`,
}) })
@ -764,10 +764,10 @@ export class VideoTranscodingConfig {
@ConfigProperty({ @ConfigProperty({
type: FFmpegPresets, type: FFmpegPresets,
tags: tags:
{ {
name: $localize`Preset`, name: $localize`Preset`,
priority: ConfigPriority.advanced, priority: ConfigPriority.advanced,
}, },
description: $localize`A preset is a collection of options that will provide a certain encoding speed to compression ratio. A slower preset will provide better compression (compression is quality per filesize).`, description: $localize`A preset is a collection of options that will provide a certain encoding speed to compression ratio. A slower preset will provide better compression (compression is quality per filesize).`,
}) })
preset: FFmpegPresets = FFmpegPresets.medium; preset: FFmpegPresets = FFmpegPresets.medium;
@ -819,7 +819,7 @@ export class PhotoConvertingConfig extends ClientPhotoConvertingConfig {
name: $localize`On the fly converting`, name: $localize`On the fly converting`,
priority: ConfigPriority.underTheHood, priority: ConfigPriority.underTheHood,
uiDisabled: (sc: PhotoConvertingConfig) => uiDisabled: (sc: PhotoConvertingConfig) =>
!sc.enabled !sc.enabled
}, },
description: $localize`Converts photos on the fly, when they are requested.`, description: $localize`Converts photos on the fly, when they are requested.`,
@ -833,7 +833,7 @@ export class PhotoConvertingConfig extends ClientPhotoConvertingConfig {
uiOptions: [720, 1080, 1440, 2160, 4320], uiOptions: [720, 1080, 1440, 2160, 4320],
unit: 'px', unit: 'px',
uiDisabled: (sc: PhotoConvertingConfig) => uiDisabled: (sc: PhotoConvertingConfig) =>
!sc.enabled !sc.enabled
}, },
description: $localize`The shorter edge of the converted photo will be scaled down to this, while keeping the aspect ratio.`, description: $localize`The shorter edge of the converted photo will be scaled down to this, while keeping the aspect ratio.`,
}) })
@ -1016,6 +1016,17 @@ export class ServerServiceConfig extends ClientServiceConfig {
@SubConfigClass<TAGS>({softReadonly: true}) @SubConfigClass<TAGS>({softReadonly: true})
export class ServerExtensionsConfig extends ClientExtensionsConfig { export class ServerExtensionsConfig extends ClientExtensionsConfig {
@ConfigProperty({
tags: {
name: $localize`Extension folder`,
priority: ConfigPriority.underTheHood,
dockerSensitive: true
},
description: $localize`Folder where the app stores the extensions. Extensions live in their sub-folders.`,
})
folder: string = 'extensions';
@ConfigProperty({volatile: true}) @ConfigProperty({volatile: true})
list: string[] = []; list: string[] = [];