/
index.js
320 lines (280 loc) · 8.65 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
/* eslint-disable import/order */
'use strict';
const fs = require('fs');
const path = require('path');
require('../../require-main');
const packageInstall = require('./package-install');
const { paths } = require('../constants');
// check to make sure dependencies are installed
try {
fs.accessSync(paths.currentPackage, fs.constants.R_OK);
} catch (e) {
if (e.code === 'ENOENT') {
console.warn('package.json not found.');
console.log('Populating package.json...');
packageInstall.updatePackageFile();
packageInstall.preserveExtraneousPlugins();
try {
fs.accessSync(path.join(paths.nodeModules, 'colors/package.json'), fs.constants.R_OK);
require('colors');
console.log('OK'.green);
} catch (e) {
console.log('OK');
}
} else {
throw e;
}
}
try {
fs.accessSync(path.join(paths.nodeModules, 'semver/package.json'), fs.constants.R_OK);
const semver = require('semver');
const defaultPackage = require('../../install/package.json');
const checkVersion = function (packageName) {
const { version } = JSON.parse(fs.readFileSync(path.join(paths.nodeModules, packageName, 'package.json'), 'utf8'));
if (!semver.satisfies(version, defaultPackage.dependencies[packageName])) {
const e = new TypeError(`Incorrect dependency version: ${packageName}`);
e.code = 'DEP_WRONG_VERSION';
throw e;
}
};
checkVersion('nconf');
checkVersion('async');
checkVersion('commander');
checkVersion('colors');
} catch (e) {
if (['ENOENT', 'DEP_WRONG_VERSION', 'MODULE_NOT_FOUND'].includes(e.code)) {
console.warn('Dependencies outdated or not yet installed.');
console.log('Installing them now...\n');
packageInstall.updatePackageFile();
packageInstall.installAll();
require('colors');
console.log('OK'.green + '\n'.reset);
} else {
throw e;
}
}
require('colors');
const nconf = require('nconf');
const { program } = require('commander');
const yargs = require('yargs');
const pkg = require('../../package.json');
const file = require('../file');
const prestart = require('../prestart');
program.configureHelp(require('./colors'));
program
.name('./nodebb')
.description('Welcome to NodeBB')
.version(pkg.version)
.option('--json-logging', 'Output to logs in JSON format', false)
.option('--log-level <level>', 'Default logging level to use', 'info')
.option('--config <value>', 'Specify a config file', 'config.json')
.option('-d, --dev', 'Development mode, including verbose logging', false)
.option('-l, --log', 'Log subprocess output to console', false);
// provide a yargs object ourselves
// otherwise yargs will consume `--help` or `help`
// and `nconf` will exit with useless usage info
const opts = yargs(process.argv.slice(2)).help(false).exitProcess(false);
nconf.argv(opts).env({
separator: '__',
});
prestart.setupWinston();
// Alternate configuration file support
const configFile = path.resolve(paths.baseDir, nconf.get('config') || 'config.json');
const configExists = file.existsSync(configFile) || (nconf.get('url') && nconf.get('secret') && nconf.get('database'));
prestart.loadConfig(configFile);
prestart.versionCheck();
if (!configExists && process.argv[2] !== 'setup') {
require('./setup').webInstall();
return;
}
process.env.CONFIG = configFile;
// running commands
program
.command('start')
.description('Start the NodeBB server')
.action(() => {
require('./running').start(program.opts());
});
program
.command('slog', null, {
noHelp: true,
})
.description('Start the NodeBB server and view the live output log')
.action(() => {
require('./running').start({ ...program.opts(), log: true });
});
program
.command('dev', null, {
noHelp: true,
})
.description('Start NodeBB in verbose development mode')
.action(() => {
process.env.NODE_ENV = 'development';
global.env = 'development';
require('./running').start({ ...program.opts(), dev: true });
});
program
.command('stop')
.description('Stop the NodeBB server')
.action(() => {
require('./running').stop(program.opts());
});
program
.command('restart')
.description('Restart the NodeBB server')
.action(() => {
require('./running').restart(program.opts());
});
program
.command('status')
.description('Check the running status of the NodeBB server')
.action(() => {
require('./running').status(program.opts());
});
program
.command('log')
.description('Open the output log (useful for debugging)')
.action(() => {
require('./running').log(program.opts());
});
// management commands
program
.command('setup [config]')
.description('Run the NodeBB setup script, or setup with an initial config')
.option('--skip-build', 'Run setup without building assets')
.action((initConfig) => {
if (initConfig) {
try {
initConfig = JSON.parse(initConfig);
} catch (e) {
console.warn('Invalid JSON passed as initial config value.'.red);
console.log('If you meant to pass in an initial config value, please try again.\n');
throw e;
}
}
require('./setup').setup(initConfig);
});
program
.command('install')
.description('Launch the NodeBB web installer for configuration setup')
.action(() => {
require('./setup').webInstall();
});
program
.command('build [targets...]')
.description(`Compile static assets ${'(JS, CSS, templates, languages)'.red}`)
.option('-s, --series', 'Run builds in series without extra processes')
.action((targets, options) => {
if (program.opts().dev) {
process.env.NODE_ENV = 'development';
global.env = 'development';
}
require('./manage').build(targets.length ? targets : true, options);
})
.on('--help', () => {
require('../meta/aliases').buildTargets();
});
program
.command('activate [plugin]')
.description('Activate a plugin for the next startup of NodeBB (nodebb-plugin- prefix is optional)')
.action((plugin) => {
require('./manage').activate(plugin);
});
program
.command('plugins')
.action(() => {
require('./manage').listPlugins();
})
.description('List all installed plugins');
program
.command('events [count]')
.description('Outputs the most recent administrative events recorded by NodeBB')
.action((count) => {
require('./manage').listEvents(count);
});
program
.command('info')
.description('Outputs various system info')
.action(() => {
require('./manage').info();
});
// reset
const resetCommand = program.command('reset');
resetCommand
.description('Reset plugins, themes, settings, etc')
.option('-t, --theme [theme]', 'Reset to [theme] or to the default theme')
.option('-p, --plugin [plugin]', 'Disable [plugin] or all plugins')
.option('-w, --widgets', 'Disable all widgets')
.option('-s, --settings', 'Reset settings to their default values')
.option('-a, --all', 'All of the above')
.action((options) => {
const valid = ['theme', 'plugin', 'widgets', 'settings', 'all'].some(x => options[x]);
if (!valid) {
console.warn('\n No valid options passed in, so nothing was reset.'.red);
resetCommand.help();
}
require('./reset').reset(options, (err) => {
if (err) {
return process.exit(1);
}
process.exit(0);
});
});
// user
program
.addCommand(require('./user')());
// upgrades
program
.command('upgrade [scripts...]')
.description('Run NodeBB upgrade scripts and ensure packages are up-to-date, or run a particular upgrade script')
.option('-m, --package', 'Update package.json from defaults', false)
.option('-i, --install', 'Bringing base dependencies up to date', false)
.option('-p, --plugins', 'Check installed plugins for updates', false)
.option('-s, --schema', 'Update NodeBB data store schema', false)
.option('-b, --build', 'Rebuild assets', false)
.on('--help', () => {
console.log(`\n${[
'When running particular upgrade scripts, options are ignored.',
'By default all options are enabled. Passing any options disables that default.',
`Only package and dependency updates: ${'./nodebb upgrade -mi'.yellow}`,
`Only database update: ${'./nodebb upgrade -s'.yellow}`,
].join('\n')}`);
})
.action((scripts, options) => {
require('./upgrade').upgrade(scripts.length ? scripts : true, options);
});
program
.command('upgrade-plugins', null, {
noHelp: true,
})
.alias('upgradePlugins')
.description('Upgrade plugins')
.action(() => {
require('./upgrade-plugins').upgradePlugins((err) => {
if (err) {
throw err;
}
console.log('OK'.green);
process.exit();
});
});
program
.command('help [command]')
.description('Display help for [command]')
.action((name) => {
if (!name) {
return program.help();
}
const command = program.commands.find(command => command._name === name);
if (command) {
command.help();
} else {
console.log(`error: unknown command '${command}'.`);
program.help();
}
});
if (process.argv.length === 2) {
program.help();
}
program.executables = false;
program.parse();