Skip to content

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

feat: allow SYNCIN_ env vars to override default config

johaven5907f81e4001
diff --git a/backend/package.json b/backend/package.json
index 0c6a65b6..99a40b16 100755
--- a/backend/package.json
+++ b/backend/package.json
@@ -56,6 +56,7 @@
"canvas": "^3.1.0",
"class-transformer": "^0.5.1",
"class-validator": "^0.14.1",
+ "deepmerge": "^4.3.1",
"drizzle-kit": "^0.31.0",
"drizzle-orm": "^0.44.0",
"fast-xml-parser": "^5.0.7",
diff --git a/backend/src/configuration/config.constants.ts b/backend/src/configuration/config.constants.ts
index d423def7..847fd23a 100644
--- a/backend/src/configuration/config.constants.ts
+++ b/backend/src/configuration/config.constants.ts
@@ -11,6 +11,9 @@ export const IS_DEV_ENV: boolean = process.env['NODE_ENV'] === 'development'
export const IS_TEST_ENV: boolean = process.env['NODE_ENV'] === 'test'
export const ENVIRONMENT_FILE_NAME = 'environment.yaml'
export const ENVIRONMENT_PATH = `environment/${ENVIRONMENT_FILE_NAME}`
+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 ENVIRONMENT_PREFIX = 'SYNCIN_'
diff --git a/backend/src/configuration/config.loader.ts b/backend/src/configuration/config.loader.ts
index d71fe28a..6e9359d9 100644
--- a/backend/src/configuration/config.loader.ts
+++ b/backend/src/configuration/config.loader.ts
@@ -4,19 +4,140 @@
* See the LICENSE file for licensing details
*/
+import deepmerge from 'deepmerge'
import * as yaml from 'js-yaml'
import fs from 'node:fs'
import path from 'node:path'
-import { APP_LOGS_PATH, ENVIRONMENT_FILE_NAME, ENVIRONMENT_PATH } from './config.constants'
+import {
+ APP_LOGS_PATH,
+ ENVIRONMENT_DIST_FILE_NAME,
+ ENVIRONMENT_DIST_PATH,
+ ENVIRONMENT_FILE_NAME,
+ ENVIRONMENT_PATH,
+ ENVIRONMENT_PREFIX
+} from './config.constants'
export function configLoader(): any {
if (!fs.existsSync(APP_LOGS_PATH)) {
fs.mkdirSync(APP_LOGS_PATH, { recursive: true })
}
- for (const envPath of [path.join(__dirname, `../../../${ENVIRONMENT_PATH}`), `./${ENVIRONMENT_PATH}`, ENVIRONMENT_FILE_NAME]) {
- if (fs.existsSync(envPath) && fs.lstatSync(envPath).isFile()) {
- return yaml.load(fs.readFileSync(envPath, 'utf8'))
+
+ let config = loadEnvFile(ENVIRONMENT_PATH, ENVIRONMENT_FILE_NAME)
+
+ if (hasEnvConfig()) {
+ // If any environment vars are found, parse the config model and apply those settings
+ const envConfig = getEnvOverrides(loadEnvFile(ENVIRONMENT_DIST_PATH, ENVIRONMENT_DIST_FILE_NAME, true))
+ config = deepmerge(config, envConfig)
+ }
+
+ if (Object.keys(config).length === 0) {
+ throw new Error(`Missing configuration: "${ENVIRONMENT_FILE_NAME}" not found, or no variables beginning with "${ENVIRONMENT_PREFIX}" are set.`)
+ }
+
+ return config
+}
+
+function loadEnvFile(envPath: string, envFileName: string, throwIfMissing = false): any {
+ for (const ePath of [path.join(__dirname, `../../../${envPath}`), `./${envPath}`, envFileName]) {
+ if (fs.existsSync(ePath) && fs.lstatSync(ePath).isFile()) {
+ return yaml.load(fs.readFileSync(ePath, 'utf8'))
}
}
- throw new Error(`${ENVIRONMENT_FILE_NAME} not found`)
+ if (throwIfMissing) {
+ throw new Error(`${envFileName} not found`)
+ }
+ return {}
+}
+
+function hasEnvConfig(): boolean {
+ return Object.keys(process.env).some((key) => key.startsWith(ENVIRONMENT_PREFIX))
+}
+
+/**
+ * Parse a raw env-string into boolean, number or leave as string.
+ */
+function parseEnvValue(value: string): any {
+ // remove quotes & convert to lowercase
+ value = value.replace(/^"+|"+$/g, '').toLowerCase()
+ if (value === 'true') return true
+ if (value === 'false') return false
+ if (!isNaN(Number(value))) return Number(value)
+ return value
+}
+
+/**
+ * Assigns a nested property into obj, creating sub-objects as needed.
+ */
+function setObjectPropertyFromString(obj: any, property: string, value: any): void {
+ const segments = property.split('.')
+ let cursor = obj
+ for (let i = 0; i < segments.length - 1; i++) {
+ const seg = segments[i]
+ if (!(seg in cursor) || typeof cursor[seg] !== 'object') {
+ cursor[seg] = {}
+ }
+ cursor = cursor[seg]
+ }
+ cursor[segments[segments.length - 1]] = value
+}
+
+/**
+ * Returns a new object containing only the env-var overrides
+ * that match existing keys in `config`, nested and cased properly.
+ */
+export function getEnvOverrides(config: Record<string, any>): Record<string, any> {
+ const result: Record<string, any> = {}
+
+ for (const [envKey, rawValue] of Object.entries(process.env)) {
+ if (!envKey.startsWith(ENVIRONMENT_PREFIX) || rawValue === undefined) {
+ continue
+ }
+
+ // ["APPLICATIONS","FILES","DATAPATH"] etc.
+ const segments = envKey.slice(ENVIRONMENT_PREFIX.length).split('_')
+ const secretFromFile = segments[segments.length - 1] === 'FILE'
+ if (secretFromFile) {
+ // remove FILE attribute
+ segments.pop()
+ }
+
+ // Walk through config to validate path & capture real key names
+ let cursorConfig: any = config
+ const realSegments: string[] = []
+ let pathExists = true
+
+ for (const seg of segments) {
+ if (cursorConfig == null || typeof cursorConfig !== 'object') {
+ pathExists = false
+ break
+ }
+ // Find the actual key (preserving camelCase) whose uppercase matches seg
+ const match = Object.keys(cursorConfig).find((k) => k.toUpperCase() === seg)
+ if (!match) {
+ pathExists = false
+ break
+ }
+ realSegments.push(match)
+ cursorConfig = cursorConfig[match]
+ }
+
+ if (!pathExists) {
+ console.warn(`Ignoring unknown environment variable: "${envKey}".`)
+ continue
+ }
+
+ // Build the nested override in `result`
+ const path = realSegments.join('.')
+ if (secretFromFile) {
+ try {
+ setObjectPropertyFromString(result, path, fs.readFileSync(rawValue, 'utf-8').trim())
+ } catch (e) {
+ console.error(`Unable to store secret from file ${rawValue} : ${e}`)
+ }
+ } else {
+ setObjectPropertyFromString(result, path, parseEnvValue(rawValue))
+ }
+ }
+
+ return result
}
diff --git a/package-lock.json b/package-lock.json
index 62527759..96305952 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -22,7 +22,6 @@
},
"backend": {
"name": "@sync-in-server/backend",
- "version": "1.0.0",
"license": "AGPL-3.0-or-later",
"dependencies": {
"@fastify/cookie": "^11.0.2",
@@ -48,6 +47,7 @@
"canvas": "^3.1.0",
"class-transformer": "^0.5.1",
"class-validator": "^0.14.1",
+ "deepmerge": "^4.3.1",
"drizzle-kit": "^0.31.0",
"drizzle-orm": "^0.44.0",
"fast-xml-parser": "^5.0.7",
@@ -120,7 +120,6 @@
},
"frontend": {
"name": "@sync-in-server/frontend",
- "version": "1.0.0",
"license": "AGPL-3.0-or-later",
"dependencies": {
"@ali-hm/angular-tree-component": "^19.1.2",
@@ -14599,9 +14598,9 @@
}
},
"node_modules/form-data": {
- "version": "4.0.3",
- "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.3.tgz",
- "integrity": "sha512-qsITQPfmvMOSAdeyZ+12I1c+CKSstAFAwu+97zrnWAbIr5u8wfsExUzCesVLC8NgHuRUqNN4Zy6UPWUTRGslcA==",
+ "version": "4.0.4",
+ "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.4.tgz",
+ "integrity": "sha512-KrGhL9Q4zjj0kiUt5OO4Mr/A/jlI2jDYs5eHBpYHPcBEVSiipAvn2Ko2HnPe20rmcuuvMHNdZFp+4IlGTMF0Ow==",
"license": "MIT",
"dependencies": {
"asynckit": "^0.4.0",