Skip to content

Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.

feat(backend): make log file path configurable via logger.filePath

johaven5ffac5a9f42e
diff --git a/backend/src/configuration/config.constants.ts b/backend/src/configuration/config.constants.ts
index 847fd23a..5247af7d 100644
--- a/backend/src/configuration/config.constants.ts
+++ b/backend/src/configuration/config.constants.ts
@@ -15,5 +15,5 @@ export const ENVIRONMENT_DIST_FILE_NAME = 'environment.dist.yaml'
export const ENVIRONMENT_DIST_PATH = `environment/${ENVIRONMENT_DIST_FILE_NAME}`
export const STATIC_PATH = path.resolve(path.join(__dirname, IS_TEST_ENV ? '../../../dist/static' : '../../static'))
export const STATIC_ASSETS_PATH = path.join(STATIC_PATH, 'assets')
-export const APP_LOGS_PATH = path.join(__dirname, '../../logs')
+export const DEFAULT_LOG_FILE_PATH = path.join(__dirname, '../../logs/server.log')
export const ENVIRONMENT_PREFIX = 'SYNCIN_'
diff --git a/backend/src/configuration/config.loader.ts b/backend/src/configuration/config.loader.ts
index fcd6f745..afec0f4e 100644
--- a/backend/src/configuration/config.loader.ts
+++ b/backend/src/configuration/config.loader.ts
@@ -9,20 +9,17 @@ import * as yaml from 'js-yaml'
import fs from 'node:fs'
import path from 'node:path'
import {
- APP_LOGS_PATH,
+ DEFAULT_LOG_FILE_PATH,
ENVIRONMENT_DIST_FILE_NAME,
ENVIRONMENT_DIST_PATH,
ENVIRONMENT_FILE_NAME,
ENVIRONMENT_PATH,
ENVIRONMENT_PREFIX
} from './config.constants'
+import type { Configuration } from './config.validation'
export function configLoader(): any {
- if (!fs.existsSync(APP_LOGS_PATH)) {
- fs.mkdirSync(APP_LOGS_PATH, { recursive: true })
- }
-
- let config = loadEnvFile(ENVIRONMENT_PATH, ENVIRONMENT_FILE_NAME)
+ let config: Partial<Configuration> = loadEnvFile(ENVIRONMENT_PATH, ENVIRONMENT_FILE_NAME)
if (hasEnvConfig()) {
// If any environment vars are found, parse the config model and apply those settings
@@ -34,6 +31,16 @@ export function configLoader(): any {
throw new Error(`Missing configuration: "${ENVIRONMENT_FILE_NAME}" not found, or no variables beginning with "${ENVIRONMENT_PREFIX}" are set.`)
}
+ if (!config.logger.stdout) {
+ // ensure log directory exists
+ const logFilePath = config.logger.filePath || DEFAULT_LOG_FILE_PATH
+ const dirLogPath = path.dirname(logFilePath)
+ if (!fs.existsSync(dirLogPath)) {
+ fs.mkdirSync(dirLogPath, { recursive: true })
+ }
+ console.log(`Logging to file → ${logFilePath}`)
+ }
+
return config
}
diff --git a/backend/src/configuration/config.logger.ts b/backend/src/configuration/config.logger.ts
index 0ca4b71c..0ece6aeb 100644
--- a/backend/src/configuration/config.logger.ts
+++ b/backend/src/configuration/config.logger.ts
@@ -4,9 +4,7 @@
* See the LICENSE file for licensing details
*/
-import { join } from 'node:path'
import type { Options } from 'pino-http'
-import { APP_LOGS_PATH } from './config.constants'
import type { LoggerConfig } from './config.validation'
export const configLogger = (loggerConfig: LoggerConfig) =>
@@ -59,7 +57,7 @@ export const configLogger = (loggerConfig: LoggerConfig) =>
messageFormat: `[{context}]{if user} <{user}> {end} ${
loggerConfig.colorize ? '\x1b[37m' : ''
}{msg}{if res} ({res.contentLength} bytes in {responseTime}ms) {userAgent}{end}{if reqId} | {reqId}{end}`,
- destination: loggerConfig.stdout ? 1 : join(APP_LOGS_PATH, 'server.log'),
+ destination: loggerConfig.stdout ? 1 : loggerConfig.filePath,
mkdir: true,
sync: false
}
diff --git a/backend/src/configuration/config.validation.ts b/backend/src/configuration/config.validation.ts
index 8f03eb58..b17a6257 100644
--- a/backend/src/configuration/config.validation.ts
+++ b/backend/src/configuration/config.validation.ts
@@ -14,6 +14,7 @@ import { CacheConfig } from '../infrastructure/cache/cache.config'
import { MySQLConfig } from '../infrastructure/database/database.config'
import { MailerConfig } from '../infrastructure/mailer/mailer.config'
import { WebSocketConfig } from '../infrastructure/websocket/web-socket.config'
+import { DEFAULT_LOG_FILE_PATH } from './config.constants'
export class ServerConfig {
@IsIP()
@@ -46,6 +47,9 @@ export class LoggerConfig {
@IsBoolean()
colorize: boolean = true
+
+ @IsString()
+ filePath: string = DEFAULT_LOG_FILE_PATH
}
export class Configuration {
diff --git a/environment/environment.dist.yaml b/environment/environment.dist.yaml
index 6aa0d401..02de7d1a 100755
--- a/environment/environment.dist.yaml
+++ b/environment/environment.dist.yaml
@@ -17,6 +17,8 @@ logger:
stdout: true
# colorize output
colorize: true
+ # file path where logs are written when stdout is false
+ filePath: /var/log/sync-in/server.log
mysql:
url: mysql://user:MySQLRootPassword@localhost:3306/database
logQueries: false