@nocobase/cli 2.2.0-alpha.3 → 2.2.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/env-proxy/nginx/app.conf.tpl +23 -0
- package/assets/env-proxy/nginx/nocobase.conf.tpl +5 -0
- package/assets/env-proxy/nginx/snippets/dist-location.conf +5 -0
- package/assets/env-proxy/nginx/snippets/gzip.conf +17 -0
- package/assets/env-proxy/nginx/snippets/log-format-http.conf +13 -0
- package/assets/env-proxy/nginx/snippets/maps-http.conf +14 -0
- package/assets/env-proxy/nginx/snippets/mime-types.conf +98 -0
- package/assets/env-proxy/nginx/snippets/proxy-location.conf +17 -0
- package/assets/env-proxy/nginx/snippets/spa-location.conf +6 -0
- package/assets/env-proxy/nginx/snippets/uploads-location.conf +21 -0
- package/dist/commands/install.js +34 -45
- package/dist/commands/proxy/caddy/generate.js +82 -4
- package/dist/commands/proxy/nginx/generate.js +87 -4
- package/dist/commands/revision/create.js +1 -1
- package/dist/commands/source/download.js +16 -12
- package/dist/lib/app-managed-resources.js +3 -4
- package/dist/lib/auth-store.js +7 -0
- package/dist/lib/cli-config.js +52 -1
- package/dist/lib/docker-image.js +94 -6
- package/dist/lib/env-proxy.js +154 -58
- package/dist/lib/proxy-caddy.js +24 -2
- package/dist/lib/proxy-nginx.js +18 -4
- package/dist/locale/en-US.json +1 -1
- package/dist/locale/zh-CN.json +1 -1
- package/package.json +3 -2
|
@@ -8,19 +8,52 @@
|
|
|
8
8
|
*/
|
|
9
9
|
import { Command, Flags } from '@oclif/core';
|
|
10
10
|
import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, } from '../../../lib/app-runtime.js';
|
|
11
|
-
import { getNginxProxyDriver, normalizeProxyListenPort, resolveNginxProxyRuntimeContext, writeNginxProxyBundle, } from '../../../lib/proxy-nginx.js';
|
|
11
|
+
import { getNginxProxyDriver, normalizeProxyListenPort, resolveNginxProxyRuntimeContext, writeManualNginxProxyBundle, writeNginxProxyBundle, } from '../../../lib/proxy-nginx.js';
|
|
12
12
|
import { announceTargetEnv, failTask, startTask, succeedTask } from '../../../lib/ui.js';
|
|
13
13
|
export default class ProxyNginxGenerate extends Command {
|
|
14
14
|
static summary = 'Generate nginx proxy files for one managed env';
|
|
15
15
|
static examples = [
|
|
16
|
+
'<%= config.bin %> proxy nginx generate --host app1.example.com',
|
|
16
17
|
'<%= config.bin %> proxy nginx generate --env app1 --host app1.example.com',
|
|
17
18
|
'<%= config.bin %> proxy nginx generate --env app1 --host app1.example.com --port 8080',
|
|
19
|
+
'<%= config.bin %> proxy nginx generate --manual --name default --storage-path /path/to/storage --dist-root-path /path/to/dist-client --runtime-version 2.1.0 --upstream-port 13000',
|
|
18
20
|
];
|
|
19
21
|
static flags = {
|
|
20
22
|
env: Flags.string({
|
|
21
23
|
char: 'e',
|
|
22
|
-
description: 'CLI env name to generate proxy files for',
|
|
23
|
-
|
|
24
|
+
description: 'CLI env name to generate proxy files for. Defaults to the current env when omitted',
|
|
25
|
+
}),
|
|
26
|
+
manual: Flags.boolean({
|
|
27
|
+
description: 'Generate proxy files from explicit runtime flags instead of a saved env',
|
|
28
|
+
default: false,
|
|
29
|
+
}),
|
|
30
|
+
name: Flags.string({
|
|
31
|
+
description: 'Output bundle name used under .nocobase/proxy/nginx in manual mode',
|
|
32
|
+
}),
|
|
33
|
+
'storage-path': Flags.string({
|
|
34
|
+
description: 'Path to the NocoBase storage directory in manual mode',
|
|
35
|
+
}),
|
|
36
|
+
'dist-root-path': Flags.string({
|
|
37
|
+
description: 'Path to the dist-client root directory used to generate index-v1.html and index-v2.html in manual mode',
|
|
38
|
+
}),
|
|
39
|
+
'runtime-version': Flags.string({
|
|
40
|
+
description: 'Frontend runtime version under dist-root-path in manual mode',
|
|
41
|
+
}),
|
|
42
|
+
'app-public-path': Flags.string({
|
|
43
|
+
description: 'Public base path served by the proxied app in manual mode. Defaults to /',
|
|
44
|
+
}),
|
|
45
|
+
'upstream-host': Flags.string({
|
|
46
|
+
description: 'Upstream host used by nginx proxy_pass in manual mode',
|
|
47
|
+
}),
|
|
48
|
+
'upstream-port': Flags.string({
|
|
49
|
+
description: 'Upstream port used by nginx proxy_pass in manual mode',
|
|
50
|
+
}),
|
|
51
|
+
'cdn-base-url': Flags.string({
|
|
52
|
+
description: 'Client asset CDN base URL used when generating runtime HTML',
|
|
53
|
+
}),
|
|
54
|
+
force: Flags.boolean({
|
|
55
|
+
description: 'Overwrite existing app.conf even when the managed block is missing',
|
|
56
|
+
default: false,
|
|
24
57
|
}),
|
|
25
58
|
host: Flags.string({
|
|
26
59
|
description: 'Host exposed by the nginx entry config, such as example.com or localhost',
|
|
@@ -34,9 +67,56 @@ export default class ProxyNginxGenerate extends Command {
|
|
|
34
67
|
const requestedEnv = flags.env?.trim() || undefined;
|
|
35
68
|
const requestedPort = flags.port?.trim() || undefined;
|
|
36
69
|
const normalizedPort = normalizeProxyListenPort(requestedPort);
|
|
70
|
+
const manual = Boolean(flags.manual);
|
|
37
71
|
if (requestedPort && !normalizedPort) {
|
|
38
72
|
this.error(`Invalid proxy entry port "${requestedPort}". Use an integer between 1 and 65535.`);
|
|
39
73
|
}
|
|
74
|
+
if (manual && requestedEnv) {
|
|
75
|
+
this.error('`--manual` cannot be combined with `--env`.');
|
|
76
|
+
}
|
|
77
|
+
if (manual) {
|
|
78
|
+
const name = flags.name?.trim() || undefined;
|
|
79
|
+
const requestedUpstreamPort = flags['upstream-port']?.trim() || undefined;
|
|
80
|
+
const upstreamPort = normalizeProxyListenPort(requestedUpstreamPort);
|
|
81
|
+
const storagePath = flags['storage-path']?.trim() || undefined;
|
|
82
|
+
const distRootPath = flags['dist-root-path']?.trim() || undefined;
|
|
83
|
+
const runtimeVersion = flags['runtime-version']?.trim() || undefined;
|
|
84
|
+
if (requestedUpstreamPort && !upstreamPort) {
|
|
85
|
+
this.error(`Invalid manual upstream port "${requestedUpstreamPort}". Use an integer between 1 and 65535.`);
|
|
86
|
+
}
|
|
87
|
+
if (!name || !upstreamPort || !storagePath || !distRootPath || !runtimeVersion) {
|
|
88
|
+
this.error('Manual mode requires `--name`, `--upstream-port`, `--storage-path`, `--dist-root-path`, and `--runtime-version`.');
|
|
89
|
+
}
|
|
90
|
+
const driver = await getNginxProxyDriver();
|
|
91
|
+
const runtimeContext = await resolveNginxProxyRuntimeContext();
|
|
92
|
+
announceTargetEnv(name);
|
|
93
|
+
startTask(`Generating nginx proxy config for env "${name}" with the ${driver} driver...`);
|
|
94
|
+
try {
|
|
95
|
+
const { bundle, status } = await writeManualNginxProxyBundle({
|
|
96
|
+
name,
|
|
97
|
+
storagePath,
|
|
98
|
+
distRootPath,
|
|
99
|
+
runtimeVersion,
|
|
100
|
+
appPublicPath: flags['app-public-path']?.trim() || undefined,
|
|
101
|
+
upstreamHost: flags['upstream-host']?.trim() || undefined,
|
|
102
|
+
upstreamPort,
|
|
103
|
+
cdnBaseUrl: flags['cdn-base-url']?.trim() || undefined,
|
|
104
|
+
}, {
|
|
105
|
+
host: flags.host?.trim() || undefined,
|
|
106
|
+
port: normalizedPort,
|
|
107
|
+
}, runtimeContext, {
|
|
108
|
+
force: flags.force,
|
|
109
|
+
});
|
|
110
|
+
succeedTask(status === 'created'
|
|
111
|
+
? `Saved nginx proxy files for env "${name}" under ${bundle.entryDir}, and created editable app entry config at ${bundle.appConfigPath}.`
|
|
112
|
+
: `Saved nginx proxy files for env "${name}" under ${bundle.entryDir}, and refreshed editable app entry config at ${bundle.appConfigPath}.`);
|
|
113
|
+
}
|
|
114
|
+
catch (error) {
|
|
115
|
+
failTask(`Failed to generate nginx proxy config for env "${name}".`);
|
|
116
|
+
this.error(error instanceof Error ? error.message : String(error));
|
|
117
|
+
}
|
|
118
|
+
return;
|
|
119
|
+
}
|
|
40
120
|
const runtime = await resolveManagedAppRuntime(requestedEnv);
|
|
41
121
|
if (!runtime) {
|
|
42
122
|
this.error(formatMissingManagedAppEnvMessage(requestedEnv));
|
|
@@ -55,7 +135,10 @@ export default class ProxyNginxGenerate extends Command {
|
|
|
55
135
|
const { bundle, status } = await writeNginxProxyBundle(runtime, {
|
|
56
136
|
host: flags.host?.trim() || undefined,
|
|
57
137
|
port: normalizedPort,
|
|
58
|
-
}, runtimeContext
|
|
138
|
+
}, runtimeContext, {
|
|
139
|
+
cdnBaseUrl: flags['cdn-base-url']?.trim() || undefined,
|
|
140
|
+
force: flags.force,
|
|
141
|
+
});
|
|
59
142
|
succeedTask(status === 'created'
|
|
60
143
|
? `Saved nginx proxy files for env "${runtime.envName}" under ${bundle.entryDir}, and created editable app entry config at ${bundle.appConfigPath}.`
|
|
61
144
|
: `Saved nginx proxy files for env "${runtime.envName}" under ${bundle.entryDir}, and refreshed editable app entry config at ${bundle.appConfigPath}.`);
|
|
@@ -12,9 +12,10 @@ import path from 'node:path';
|
|
|
12
12
|
import { stdin as stdinStream, stdout as stdoutStream } from 'node:process';
|
|
13
13
|
import { runPromptCatalog, } from "../../lib/prompt-catalog.js";
|
|
14
14
|
import { applyCliLocale, CLI_LOCALE_FLAG_DESCRIPTION, CLI_LOCALE_FLAG_OPTIONS, localeText, resolveCliLocale, translateCli, } from "../../lib/cli-locale.js";
|
|
15
|
-
import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_REGISTRY_ZH_CN, resolveDockerImageRef, } from "../../lib/docker-image.js";
|
|
15
|
+
import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_REGISTRY_ZH_CN, resolveOfficialDockerRegistry, resolveDockerImageRef, } from "../../lib/docker-image.js";
|
|
16
16
|
import { getEnv } from '../../lib/auth-store.js';
|
|
17
17
|
import { resolveDefaultConfigScope } from '../../lib/cli-home.js';
|
|
18
|
+
import { getCliConfigValue } from '../../lib/cli-config.js';
|
|
18
19
|
import { buildBeforeDependencyInstallHookContext, runBeforeDependencyInstallHook, } from '../../lib/hook-script.js';
|
|
19
20
|
import { run } from "../../lib/run-npm.js";
|
|
20
21
|
import { printVerbose, setVerboseMode, startTask, stopTask, updateTask } from '../../lib/ui.js';
|
|
@@ -450,9 +451,9 @@ export default class SourceDownload extends Command {
|
|
|
450
451
|
}
|
|
451
452
|
return outputAbs;
|
|
452
453
|
}
|
|
453
|
-
dockerTarPath(flags, outputAbs) {
|
|
454
|
+
async dockerTarPath(flags, outputAbs) {
|
|
454
455
|
const imageRef = resolveDockerImageRef(flags['docker-registry'], flags.version, {
|
|
455
|
-
defaultRegistry:
|
|
456
|
+
defaultRegistry: await this.resolveConfiguredDockerRegistryDefault(),
|
|
456
457
|
defaultVersion: 'latest',
|
|
457
458
|
});
|
|
458
459
|
const safeBase = imageRef.replace(/[\\/:]/g, '-');
|
|
@@ -462,9 +463,11 @@ export default class SourceDownload extends Command {
|
|
|
462
463
|
* Defaults for prompts only. Keys present in **`preset`** are omitted so `runPromptCatalog` uses
|
|
463
464
|
* **`values`** (preset) alone for those steps — no duplicate prefill for skipped prompts.
|
|
464
465
|
*/
|
|
465
|
-
|
|
466
|
+
async resolveConfiguredDockerRegistryDefault() {
|
|
467
|
+
return resolveOfficialDockerRegistry(await getCliConfigValue('nb-image-registry'));
|
|
468
|
+
}
|
|
469
|
+
buildInitialValuesFromParsed(flags, preset, defaultDockerRegistry) {
|
|
466
470
|
const initialValues = {};
|
|
467
|
-
const localeDefaultDockerRegistry = defaultDockerRegistryForLang(flags.locale ?? process.env.NB_LOCALE);
|
|
468
471
|
const source = flags.source?.trim();
|
|
469
472
|
if (source) {
|
|
470
473
|
initialValues.source = source;
|
|
@@ -488,7 +491,7 @@ export default class SourceDownload extends Command {
|
|
|
488
491
|
initialValues.dockerRegistry = String(flags['docker-registry'] ?? '').trim();
|
|
489
492
|
}
|
|
490
493
|
else {
|
|
491
|
-
initialValues.dockerRegistry =
|
|
494
|
+
initialValues.dockerRegistry = defaultDockerRegistry;
|
|
492
495
|
}
|
|
493
496
|
initialValues.dockerPlatform = normalizeDockerPlatform(flags['docker-platform']);
|
|
494
497
|
initialValues.dockerSave = flags['docker-save'];
|
|
@@ -569,7 +572,7 @@ export default class SourceDownload extends Command {
|
|
|
569
572
|
}
|
|
570
573
|
return flags.build;
|
|
571
574
|
}
|
|
572
|
-
mapCatalogResultsToResolved(results, flags) {
|
|
575
|
+
mapCatalogResultsToResolved(results, flags, defaultDockerRegistry) {
|
|
573
576
|
const source = String(results.source);
|
|
574
577
|
const version = resolveVersionFromResults(results, flags.version) || 'latest';
|
|
575
578
|
const devDependencies = source === 'npm' ? Boolean(results.devDependencies) : undefined;
|
|
@@ -583,7 +586,7 @@ export default class SourceDownload extends Command {
|
|
|
583
586
|
const dockerRegistry = source === 'docker'
|
|
584
587
|
? results.dockerRegistry !== undefined
|
|
585
588
|
? String(results.dockerRegistry).trim() || undefined
|
|
586
|
-
: flags['docker-registry']?.trim() ||
|
|
589
|
+
: flags['docker-registry']?.trim() || defaultDockerRegistry
|
|
587
590
|
: undefined;
|
|
588
591
|
const dockerPlatform = source === 'docker'
|
|
589
592
|
? normalizeDockerPlatform(results.dockerPlatform !== undefined ? results.dockerPlatform : flags['docker-platform'])
|
|
@@ -628,7 +631,8 @@ export default class SourceDownload extends Command {
|
|
|
628
631
|
this.error('Download source is required in non-interactive mode. Use --source npm, --source git, or --source docker.');
|
|
629
632
|
}
|
|
630
633
|
const presetValues = this.buildPresetValuesFromFlags(flags);
|
|
631
|
-
const
|
|
634
|
+
const defaultDockerRegistry = await this.resolveConfiguredDockerRegistryDefault();
|
|
635
|
+
const initialValues = this.buildInitialValuesFromParsed(flags, presetValues, defaultDockerRegistry);
|
|
632
636
|
const results = await runPromptCatalog(SourceDownload.prompts, {
|
|
633
637
|
initialValues,
|
|
634
638
|
values: presetValues,
|
|
@@ -654,7 +658,7 @@ export default class SourceDownload extends Command {
|
|
|
654
658
|
if (flags['docker-save'] && source !== 'docker') {
|
|
655
659
|
this.error('--docker-save is only available when --source docker is selected.');
|
|
656
660
|
}
|
|
657
|
-
return this.mapCatalogResultsToResolved(results, flags);
|
|
661
|
+
return this.mapCatalogResultsToResolved(results, flags, defaultDockerRegistry);
|
|
658
662
|
}
|
|
659
663
|
npmRegistryUrl(flags) {
|
|
660
664
|
const url = flags['npm-registry']?.trim();
|
|
@@ -784,7 +788,7 @@ export default class SourceDownload extends Command {
|
|
|
784
788
|
}
|
|
785
789
|
async downloadFromDocker(flags) {
|
|
786
790
|
const imageRef = resolveDockerImageRef(flags['docker-registry'], flags.version, {
|
|
787
|
-
defaultRegistry:
|
|
791
|
+
defaultRegistry: await this.resolveConfiguredDockerRegistryDefault(),
|
|
788
792
|
defaultVersion: 'latest',
|
|
789
793
|
});
|
|
790
794
|
const platform = dockerPlatformArg(flags['docker-platform']);
|
|
@@ -811,7 +815,7 @@ export default class SourceDownload extends Command {
|
|
|
811
815
|
await fsp.rm(outAbs, { recursive: true, force: true });
|
|
812
816
|
}
|
|
813
817
|
await fsp.mkdir(outAbs, { recursive: true });
|
|
814
|
-
const tarPath = this.dockerTarPath(flags, outAbs);
|
|
818
|
+
const tarPath = await this.dockerTarPath(flags, outAbs);
|
|
815
819
|
this.log(`Saving Docker image tarball to ${tarPath}`);
|
|
816
820
|
await this.runExternalCommand('docker', ['save', '-o', tarPath, imageRef], {
|
|
817
821
|
errorName: 'docker save',
|
|
@@ -14,7 +14,7 @@ import { dockerContainerExists, managedAppLifecycleEnvVars, runLocalNocoBaseComm
|
|
|
14
14
|
import { deriveBuiltinDbConnection, resolveBuiltinDbConnection } from './builtin-db.js';
|
|
15
15
|
import { resolveConfiguredStoragePath } from './env-paths.js';
|
|
16
16
|
import { resolveDockerEnvFileArg } from "./docker-env-file.js";
|
|
17
|
-
import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_VERSION, resolveDockerImageRef, } from "./docker-image.js";
|
|
17
|
+
import { DEFAULT_DOCKER_REGISTRY, DEFAULT_DOCKER_VERSION, resolveDockerImageContainerPort, resolveDockerImageRef, } from "./docker-image.js";
|
|
18
18
|
import { resolveHookScriptPath } from './hook-script.js';
|
|
19
19
|
import { commandSucceeds, ensureDockerDaemonRunning, run } from './run-npm.js';
|
|
20
20
|
import Install from '../commands/install.js';
|
|
@@ -192,6 +192,7 @@ export async function buildSavedDockerRunArgs(runtime, options) {
|
|
|
192
192
|
defaultRegistry: DEFAULT_DOCKER_REGISTRY,
|
|
193
193
|
defaultVersion: DEFAULT_DOCKER_VERSION,
|
|
194
194
|
});
|
|
195
|
+
const containerPort = resolveDockerImageContainerPort(imageRef);
|
|
195
196
|
const missing = [];
|
|
196
197
|
if (!storagePath) {
|
|
197
198
|
missing.push('storagePath');
|
|
@@ -225,8 +226,6 @@ export async function buildSavedDockerRunArgs(runtime, options) {
|
|
|
225
226
|
'-d',
|
|
226
227
|
'--name',
|
|
227
228
|
runtime.containerName,
|
|
228
|
-
'--restart',
|
|
229
|
-
'always',
|
|
230
229
|
'--network',
|
|
231
230
|
runtime.workspaceName,
|
|
232
231
|
];
|
|
@@ -235,7 +234,7 @@ export async function buildSavedDockerRunArgs(runtime, options) {
|
|
|
235
234
|
args.push('--platform', dockerPlatform);
|
|
236
235
|
}
|
|
237
236
|
if (appPort) {
|
|
238
|
-
args.push('-p', `${appPort}
|
|
237
|
+
args.push('-p', `${appPort}:${containerPort}`);
|
|
239
238
|
}
|
|
240
239
|
if (envFile) {
|
|
241
240
|
args.push('--env-file', envFile);
|
package/dist/lib/auth-store.js
CHANGED
|
@@ -125,12 +125,19 @@ function normalizeAuthConfig(config) {
|
|
|
125
125
|
...(updatePolicy ? { update: { policy: updatePolicy } } : {}),
|
|
126
126
|
...(settings.license?.pkgUrl ? { license: { pkgUrl: normalizeOptionalString(settings.license.pkgUrl) } } : {}),
|
|
127
127
|
...(settings.docker?.network || settings.docker?.containerPrefix
|
|
128
|
+
|| settings.docker?.nbImageRegistry || settings.docker?.nbImageVariant
|
|
128
129
|
? {
|
|
129
130
|
docker: {
|
|
130
131
|
...(settings.docker?.network ? { network: normalizeOptionalString(settings.docker.network) } : {}),
|
|
131
132
|
...(settings.docker?.containerPrefix
|
|
132
133
|
? { containerPrefix: normalizeOptionalString(settings.docker.containerPrefix) }
|
|
133
134
|
: {}),
|
|
135
|
+
...(settings.docker?.nbImageRegistry
|
|
136
|
+
? { nbImageRegistry: normalizeOptionalString(settings.docker.nbImageRegistry) }
|
|
137
|
+
: {}),
|
|
138
|
+
...(settings.docker?.nbImageVariant
|
|
139
|
+
? { nbImageVariant: normalizeOptionalString(settings.docker.nbImageVariant) }
|
|
140
|
+
: {}),
|
|
134
141
|
},
|
|
135
142
|
}
|
|
136
143
|
: {}),
|
package/dist/lib/cli-config.js
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
import { loadExactAuthConfig, saveAuthConfig } from './auth-store.js';
|
|
10
10
|
import { resolveCliHomeRoot, resolveDefaultConfigScope } from './cli-home.js';
|
|
11
11
|
import { CLI_LOCALE_FLAG_OPTIONS, normalizeCliLocale, resolveCliLocale } from './cli-locale.js';
|
|
12
|
+
import { DEFAULT_NB_IMAGE_REGISTRY, DEFAULT_NB_IMAGE_VARIANT, NB_IMAGE_REGISTRY_OPTIONS, NB_IMAGE_VARIANT_OPTIONS, normalizeNbImageRegistry, normalizeNbImageVariant, } from './docker-image.js';
|
|
12
13
|
export const DEFAULT_LICENSE_PKG_URL = 'https://pkg.nocobase.com/';
|
|
13
14
|
export const DEFAULT_DOCKER_NETWORK = 'nocobase';
|
|
14
15
|
export const DEFAULT_DOCKER_CONTAINER_PREFIX = 'nb';
|
|
@@ -37,6 +38,8 @@ export const SUPPORTED_CLI_CONFIG_KEYS = [
|
|
|
37
38
|
'license.pkg-url',
|
|
38
39
|
'docker.network',
|
|
39
40
|
'docker.container-prefix',
|
|
41
|
+
'nb-image-registry',
|
|
42
|
+
'nb-image-variant',
|
|
40
43
|
'bin.docker',
|
|
41
44
|
'bin.caddy',
|
|
42
45
|
'bin.git',
|
|
@@ -129,7 +132,11 @@ function pruneSettings(config) {
|
|
|
129
132
|
delete config.settings?.license;
|
|
130
133
|
}
|
|
131
134
|
const docker = config.settings?.docker;
|
|
132
|
-
if (docker &&
|
|
135
|
+
if (docker &&
|
|
136
|
+
!trimValue(docker.network) &&
|
|
137
|
+
!trimValue(docker.containerPrefix) &&
|
|
138
|
+
!trimValue(docker.nbImageRegistry) &&
|
|
139
|
+
!trimValue(docker.nbImageVariant)) {
|
|
133
140
|
delete config.settings?.docker;
|
|
134
141
|
}
|
|
135
142
|
const bin = config.settings?.bin;
|
|
@@ -182,6 +189,10 @@ export function getExplicitCliConfigValue(config, key) {
|
|
|
182
189
|
return trimValue(config.settings?.docker?.network);
|
|
183
190
|
case 'docker.container-prefix':
|
|
184
191
|
return trimValue(config.settings?.docker?.containerPrefix);
|
|
192
|
+
case 'nb-image-registry':
|
|
193
|
+
return normalizeNbImageRegistry(config.settings?.docker?.nbImageRegistry);
|
|
194
|
+
case 'nb-image-variant':
|
|
195
|
+
return normalizeNbImageVariant(config.settings?.docker?.nbImageVariant);
|
|
185
196
|
case 'bin.docker':
|
|
186
197
|
return trimValue(config.settings?.bin?.docker);
|
|
187
198
|
case 'bin.caddy':
|
|
@@ -230,6 +241,10 @@ export function getEffectiveCliConfigValue(config, key) {
|
|
|
230
241
|
return trimValue(config.name) || DEFAULT_DOCKER_NETWORK;
|
|
231
242
|
case 'docker.container-prefix':
|
|
232
243
|
return trimValue(config.name) || DEFAULT_DOCKER_CONTAINER_PREFIX;
|
|
244
|
+
case 'nb-image-registry':
|
|
245
|
+
return explicit ?? DEFAULT_NB_IMAGE_REGISTRY;
|
|
246
|
+
case 'nb-image-variant':
|
|
247
|
+
return explicit ?? DEFAULT_NB_IMAGE_VARIANT;
|
|
233
248
|
case 'bin.docker':
|
|
234
249
|
return DEFAULT_DOCKER_BIN;
|
|
235
250
|
case 'bin.caddy':
|
|
@@ -305,6 +320,20 @@ export function normalizeCliConfigValue(key, value) {
|
|
|
305
320
|
}
|
|
306
321
|
return driver;
|
|
307
322
|
}
|
|
323
|
+
if (key === 'nb-image-registry') {
|
|
324
|
+
const registry = normalizeNbImageRegistry(normalized);
|
|
325
|
+
if (!registry) {
|
|
326
|
+
throw new Error(`Config key "${key}" must be one of: ${NB_IMAGE_REGISTRY_OPTIONS.join(', ')}`);
|
|
327
|
+
}
|
|
328
|
+
return registry;
|
|
329
|
+
}
|
|
330
|
+
if (key === 'nb-image-variant') {
|
|
331
|
+
const variant = normalizeNbImageVariant(normalized);
|
|
332
|
+
if (!variant) {
|
|
333
|
+
throw new Error(`Config key "${key}" must be one of: ${NB_IMAGE_VARIANT_OPTIONS.join(', ')}`);
|
|
334
|
+
}
|
|
335
|
+
return variant;
|
|
336
|
+
}
|
|
308
337
|
return normalized;
|
|
309
338
|
}
|
|
310
339
|
export async function loadCliConfig(options = {}) {
|
|
@@ -370,6 +399,18 @@ export async function setCliConfigValue(key, value, options = {}) {
|
|
|
370
399
|
containerPrefix: normalized,
|
|
371
400
|
};
|
|
372
401
|
break;
|
|
402
|
+
case 'nb-image-registry':
|
|
403
|
+
config.settings.docker = {
|
|
404
|
+
...(config.settings.docker ?? {}),
|
|
405
|
+
nbImageRegistry: normalized,
|
|
406
|
+
};
|
|
407
|
+
break;
|
|
408
|
+
case 'nb-image-variant':
|
|
409
|
+
config.settings.docker = {
|
|
410
|
+
...(config.settings.docker ?? {}),
|
|
411
|
+
nbImageVariant: normalized,
|
|
412
|
+
};
|
|
413
|
+
break;
|
|
373
414
|
case 'bin.docker':
|
|
374
415
|
config.settings.bin = {
|
|
375
416
|
...(config.settings.bin ?? {}),
|
|
@@ -489,6 +530,16 @@ export async function deleteCliConfigValue(key, options = {}) {
|
|
|
489
530
|
delete config.settings.docker.containerPrefix;
|
|
490
531
|
}
|
|
491
532
|
break;
|
|
533
|
+
case 'nb-image-registry':
|
|
534
|
+
if (config.settings.docker) {
|
|
535
|
+
delete config.settings.docker.nbImageRegistry;
|
|
536
|
+
}
|
|
537
|
+
break;
|
|
538
|
+
case 'nb-image-variant':
|
|
539
|
+
if (config.settings.docker) {
|
|
540
|
+
delete config.settings.docker.nbImageVariant;
|
|
541
|
+
}
|
|
542
|
+
break;
|
|
492
543
|
case 'bin.docker':
|
|
493
544
|
if (config.settings.bin) {
|
|
494
545
|
delete config.settings.bin.docker;
|
package/dist/lib/docker-image.js
CHANGED
|
@@ -9,7 +9,30 @@
|
|
|
9
9
|
export const DEFAULT_DOCKER_REGISTRY = 'nocobase/nocobase';
|
|
10
10
|
export const DEFAULT_DOCKER_REGISTRY_ZH_CN = 'registry.cn-shanghai.aliyuncs.com/nocobase/nocobase';
|
|
11
11
|
export const DEFAULT_DOCKER_VERSION = 'alpha';
|
|
12
|
+
export const NB_IMAGE_REGISTRY_OPTIONS = ['dockerhub', 'aliyun'];
|
|
13
|
+
export const DEFAULT_NB_IMAGE_REGISTRY = 'dockerhub';
|
|
14
|
+
export const NB_IMAGE_VARIANT_OPTIONS = ['standard', 'no-nginx', 'full', 'full-no-nginx'];
|
|
15
|
+
export const DEFAULT_NB_IMAGE_VARIANT = 'full';
|
|
12
16
|
export const DOCKER_IMAGE_FULL_SUFFIX = '-full';
|
|
17
|
+
export const DOCKER_IMAGE_NO_NGINX_SUFFIX = '-no-nginx';
|
|
18
|
+
export const DOCKER_IMAGE_FULL_NO_NGINX_SUFFIX = '-full-no-nginx';
|
|
19
|
+
export const DEFAULT_KINGBASE_IMAGE = 'registry.cn-shanghai.aliyuncs.com/nocobase/kingbase:v009r001c001b0030_single_x86';
|
|
20
|
+
const OFFICIAL_DOCKER_REGISTRY_REPOSITORIES = {
|
|
21
|
+
dockerhub: DEFAULT_DOCKER_REGISTRY,
|
|
22
|
+
aliyun: DEFAULT_DOCKER_REGISTRY_ZH_CN,
|
|
23
|
+
};
|
|
24
|
+
const DEFAULT_BUILTIN_DB_IMAGES = {
|
|
25
|
+
postgres: 'postgres:16',
|
|
26
|
+
mysql: 'mysql:8',
|
|
27
|
+
mariadb: 'mariadb:11',
|
|
28
|
+
kingbase: DEFAULT_KINGBASE_IMAGE,
|
|
29
|
+
};
|
|
30
|
+
const ALIYUN_BUILTIN_DB_IMAGES = {
|
|
31
|
+
postgres: 'registry.cn-shanghai.aliyuncs.com/nocobase/postgres:16',
|
|
32
|
+
mysql: 'registry.cn-shanghai.aliyuncs.com/nocobase/mysql:8',
|
|
33
|
+
mariadb: 'registry.cn-shanghai.aliyuncs.com/nocobase/mariadb:11',
|
|
34
|
+
kingbase: DEFAULT_KINGBASE_IMAGE,
|
|
35
|
+
};
|
|
13
36
|
const OFFICIAL_FULL_IMAGE_REGISTRIES = new Set([
|
|
14
37
|
DEFAULT_DOCKER_REGISTRY,
|
|
15
38
|
DEFAULT_DOCKER_REGISTRY_ZH_CN,
|
|
@@ -17,21 +40,86 @@ const OFFICIAL_FULL_IMAGE_REGISTRIES = new Set([
|
|
|
17
40
|
function trimValue(value) {
|
|
18
41
|
return String(value ?? '').trim();
|
|
19
42
|
}
|
|
43
|
+
export function normalizeNbImageRegistry(value) {
|
|
44
|
+
const normalized = trimValue(value);
|
|
45
|
+
if (!normalized) {
|
|
46
|
+
return undefined;
|
|
47
|
+
}
|
|
48
|
+
return NB_IMAGE_REGISTRY_OPTIONS.includes(normalized)
|
|
49
|
+
? normalized
|
|
50
|
+
: undefined;
|
|
51
|
+
}
|
|
52
|
+
export function normalizeNbImageVariant(value) {
|
|
53
|
+
const normalized = trimValue(value);
|
|
54
|
+
if (!normalized) {
|
|
55
|
+
return undefined;
|
|
56
|
+
}
|
|
57
|
+
return NB_IMAGE_VARIANT_OPTIONS.includes(normalized)
|
|
58
|
+
? normalized
|
|
59
|
+
: undefined;
|
|
60
|
+
}
|
|
61
|
+
export function resolveOfficialDockerRegistry(value) {
|
|
62
|
+
const registry = normalizeNbImageRegistry(value) ?? DEFAULT_NB_IMAGE_REGISTRY;
|
|
63
|
+
return OFFICIAL_DOCKER_REGISTRY_REPOSITORIES[registry];
|
|
64
|
+
}
|
|
65
|
+
export function inferNbImageRegistryFromRepository(value) {
|
|
66
|
+
const repository = trimValue(value);
|
|
67
|
+
return Object.entries(OFFICIAL_DOCKER_REGISTRY_REPOSITORIES).find(([, candidate]) => candidate === repository)?.[0];
|
|
68
|
+
}
|
|
69
|
+
function hasKnownVariantSuffix(tag) {
|
|
70
|
+
return (tag.endsWith(DOCKER_IMAGE_FULL_NO_NGINX_SUFFIX) ||
|
|
71
|
+
tag.endsWith(DOCKER_IMAGE_NO_NGINX_SUFFIX) ||
|
|
72
|
+
tag.endsWith(DOCKER_IMAGE_FULL_SUFFIX));
|
|
73
|
+
}
|
|
20
74
|
export function shouldUseFullDockerImageTag(registry) {
|
|
21
75
|
return OFFICIAL_FULL_IMAGE_REGISTRIES.has(trimValue(registry));
|
|
22
76
|
}
|
|
23
|
-
export function normalizeDockerImageTag(registry, version) {
|
|
77
|
+
export function normalizeDockerImageTag(registry, version, options) {
|
|
24
78
|
const tag = trimValue(version) || DEFAULT_DOCKER_VERSION;
|
|
25
|
-
if (
|
|
79
|
+
if (hasKnownVariantSuffix(tag)) {
|
|
26
80
|
return tag;
|
|
27
81
|
}
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
82
|
+
const explicitVariant = normalizeNbImageVariant(options?.variant) ?? normalizeNbImageVariant(options?.defaultVariant);
|
|
83
|
+
const inferredVariant = shouldUseFullDockerImageTag(registry) ? DEFAULT_NB_IMAGE_VARIANT : 'standard';
|
|
84
|
+
const variant = explicitVariant ?? inferredVariant;
|
|
85
|
+
switch (variant) {
|
|
86
|
+
case 'standard':
|
|
87
|
+
return tag;
|
|
88
|
+
case 'no-nginx':
|
|
89
|
+
return `${tag}${DOCKER_IMAGE_NO_NGINX_SUFFIX}`;
|
|
90
|
+
case 'full':
|
|
91
|
+
return `${tag}${DOCKER_IMAGE_FULL_SUFFIX}`;
|
|
92
|
+
case 'full-no-nginx':
|
|
93
|
+
return `${tag}${DOCKER_IMAGE_FULL_NO_NGINX_SUFFIX}`;
|
|
94
|
+
}
|
|
31
95
|
}
|
|
32
96
|
export function resolveDockerImageRef(registry, version, options) {
|
|
33
97
|
const resolvedRegistry = trimValue(registry) || options?.defaultRegistry || DEFAULT_DOCKER_REGISTRY;
|
|
34
98
|
const rawVersion = trimValue(version) || options?.defaultVersion || DEFAULT_DOCKER_VERSION;
|
|
35
|
-
const normalizedTag = normalizeDockerImageTag(resolvedRegistry, rawVersion
|
|
99
|
+
const normalizedTag = normalizeDockerImageTag(resolvedRegistry, rawVersion, {
|
|
100
|
+
variant: options?.variant,
|
|
101
|
+
defaultVariant: options?.defaultVariant,
|
|
102
|
+
});
|
|
36
103
|
return `${resolvedRegistry}:${normalizedTag}`;
|
|
37
104
|
}
|
|
105
|
+
function extractDockerImageTag(imageRef) {
|
|
106
|
+
const ref = trimValue(imageRef);
|
|
107
|
+
const lastSlashIndex = ref.lastIndexOf('/');
|
|
108
|
+
const lastColonIndex = ref.lastIndexOf(':');
|
|
109
|
+
if (lastColonIndex <= lastSlashIndex) {
|
|
110
|
+
return undefined;
|
|
111
|
+
}
|
|
112
|
+
return ref.slice(lastColonIndex + 1) || undefined;
|
|
113
|
+
}
|
|
114
|
+
export function resolveDockerImageContainerPort(imageRef) {
|
|
115
|
+
const tag = extractDockerImageTag(imageRef);
|
|
116
|
+
return tag?.endsWith(DOCKER_IMAGE_NO_NGINX_SUFFIX) ? '13000' : '80';
|
|
117
|
+
}
|
|
118
|
+
export function resolveBuiltinDbImage(dbDialect, options) {
|
|
119
|
+
const dialect = trimValue(dbDialect) || 'postgres';
|
|
120
|
+
const configuredRegistry = normalizeNbImageRegistry(options?.registry) ??
|
|
121
|
+
inferNbImageRegistryFromRepository(options?.registry) ??
|
|
122
|
+
DEFAULT_NB_IMAGE_REGISTRY;
|
|
123
|
+
const defaults = configuredRegistry === 'aliyun' ? ALIYUN_BUILTIN_DB_IMAGES : DEFAULT_BUILTIN_DB_IMAGES;
|
|
124
|
+
return defaults[dialect] ?? defaults.postgres;
|
|
125
|
+
}
|