[READ-ONLY] Mirror of https://github.com/FoxxMD/komodo-import. Import existing compose stacks into Komodo
foxxmd.github.io/komodo-import
compose
docker
import
komodo
toml
feat: Move toml result logic into separate exporter functions
* File export gated behind OUTPUT_DIR env being present
* Make TOML log output more readable with instructions
+66
-18
+20
-3
README.md
+20
-3
README.md
···
234
234
file_paths = [ "compose.yaml" ]
235
235
env_file_path = ".komodoEnv"
236
236
additional_env_files = [ ".env" ]
237
-
[2025-08-08 13:47:17.496 -0400] INFO : [App] Contents written to /config/sync-2025-08-08--13-47-17.toml
238
237
[2025-08-08 13:47:17.496 -0400] INFO : [App] Done!
239
238
```
240
239
···
254
253
255
254
## Writing Generated TOML to File
256
255
257
-
Komodo Import will additionally attempt to write the generated output to a `.toml` file in the `/config` folder within its container.
256
+
Komodo Import will additionally attempt to write the generated output to a `.toml` file if the ENV `OUTPUT_DIR` is present. This should be the *directory* (not file) that the generated file should be written to.
257
+
258
+
Bind mount a folder into the container and set `OUTPUT_DIR` like in the example below:
259
+
260
+
<details>
261
+
262
+
<summary>File Output Example</summary>
263
+
264
+
```yaml
265
+
services:
266
+
komodo-import:
267
+
# ...
268
+
environment:
269
+
# ...
270
+
- OUTPUT_DIR=/output
271
+
volumes:
272
+
# ...
273
+
- /my/host/folder:/output
274
+
```
258
275
259
-
To use/persist these files, bind mount a folder to `/config` -- see example [compose.yaml](./compose.yaml) in the commented out `volume` lines.
276
+
</details>
+25
src/exporters/exportToFile.ts
+25
src/exporters/exportToFile.ts
···
1
+
import { childLogger, Logger } from "@foxxmd/logging";
2
+
import { fileOrDirectoryIsWriteable } from "../common/utils/io.js";
3
+
import { mkdir, writeFile, chmod, constants } from 'node:fs/promises';
4
+
import path from "path";
5
+
import dayjs from 'dayjs'
6
+
import { isDebugMode } from "../common/utils/utils.js";
7
+
8
+
export const exportToFile = async (toml: string, parentLogger: Logger): Promise<void> => {
9
+
const logger = childLogger(parentLogger, 'File Export');
10
+
const outputDir = process.env.OUTPUT_DIR;
11
+
if (outputDir !== undefined && outputDir.trim() !== '') {
12
+
const time = dayjs().format('YYYY-MM-DD--HH-mm-ss');
13
+
const outputFile = path.join(outputDir, `sync-${time}.toml`);
14
+
try {
15
+
fileOrDirectoryIsWriteable(outputDir);
16
+
await mkdir(outputDir, { recursive: true });
17
+
await writeFile(outputFile, toml);
18
+
logger.info(`Contents written to ${outputFile}`);
19
+
} catch (e) {
20
+
logger.warn(new Error(`Unable to write toml to file ${outputFile}`, { cause: e }));
21
+
}
22
+
} else if(isDebugMode()) {
23
+
logger.debug('Not writing to file because OUTPUT_DIR is empty or not defined.');
24
+
}
25
+
}
+16
src/exporters/exportToLog.ts
+16
src/exporters/exportToLog.ts
···
1
+
import { Logger } from "@foxxmd/logging";
2
+
import { parseBool } from "../common/utils/utils.js";
3
+
import { stripIndents } from "common-tags";
4
+
5
+
const separator = '✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️';
6
+
7
+
export const exportToLog = (toml: string, logger: Logger) => {
8
+
if(parseBool(process.env.LOG_TOML ?? true)) {
9
+
logger.info(stripIndents`
10
+
Copy the text between the scissors to use as the *Resource File* contents within your Resource Sync
11
+
12
+
${separator}
13
+
${toml}
14
+
${separator}`);
15
+
}
16
+
}
+5
-15
src/index.ts
+5
-15
src/index.ts
···
15
15
import { buildFileStack, buildFileStacks } from './builders/stack/filesOnServer.js';
16
16
import { CommonImportOptions } from './common/infrastructure/config/common.js';
17
17
import { FilesOnServerConfig } from './common/infrastructure/config/filesOnServer.js';
18
+
import { KomodoClient, Types } from "komodo_client";
19
+
import { exportToLog } from './exporters/exportToLog.js';
20
+
import { exportToFile } from './exporters/exportToFile.js';
18
21
19
22
dayjs.extend(utc)
20
23
dayjs.extend(timezone);
···
36
39
const configDir = process.env.CONFIG_DIR || path.resolve(projectDir, `./config`);
37
40
38
41
try {
39
-
40
-
initLogger.verbose(`Config Dir ENV: ${process.env.CONFIG_DIR} -> Resolved: ${configDir}`);
41
42
42
43
if (process.env.DEBUG_MODE !== undefined) {
43
44
// make sure value is legit
···
111
112
stack: stacks
112
113
};
113
114
114
-
const time = dayjs().format('YYYY-MM-DD--HH-mm-ss');
115
-
116
115
let toml: string;
117
116
let logTomlData = isDebugMode();
118
117
try {
···
126
125
}
127
126
}
128
127
129
-
logger.info(`TOML:\n${toml}`);
130
-
131
-
const tomlFilePath = path.join(configDir, `sync-${time}.toml`);
132
-
try {
133
-
fileOrDirectoryIsWriteable(tomlFilePath);
134
-
await promises.mkdir(configDir, { recursive: true });
135
-
await writeFile(path.join(configDir, `sync-${time}.toml`), toml);
136
-
logger.info(`Contents written to ${tomlFilePath}`);
137
-
} catch (e) {
138
-
logger.warn(new Error(`Unable to write toml to file`, { cause: e }));
139
-
}
128
+
exportToLog(toml, logger);
129
+
await exportToFile(toml, logger);
140
130
141
131
logger.info('Done!');
142
132