В параметры командной строки добавлена возможность задавать путь к файлу
конфигурации, а все остальные настройки приложения можно указать в нем самом (#30)
This commit is contained in:
51
README.md
51
README.md
@@ -69,26 +69,60 @@ Options:
|
|||||||
--help Показать опции командной строки
|
--help Показать опции командной строки
|
||||||
--host=<ip> Задать имя хоста для веб сервера, по умолчанию: 0.0.0.0
|
--host=<ip> Задать имя хоста для веб сервера, по умолчанию: 0.0.0.0
|
||||||
--port=<port> Задать порт для веб сервера, по умолчанию: 12380
|
--port=<port> Задать порт для веб сервера, по умолчанию: 12380
|
||||||
--app-dir=<dirpath> Задать рабочую директорию, по умолчанию: <execDir>/.inpx-web
|
--config=<filepath> Задать файл конфигурации, по умолчанию: <dataDir>/config.json
|
||||||
|
--data-dir=<dirpath> (или --app-dir) Задать рабочую директорию, по умолчанию: <execDir>/.inpx-web
|
||||||
--lib-dir=<dirpath> Задать директорию библиотеки (с zip-архивами), по умолчанию: там же, где лежит файл приложения
|
--lib-dir=<dirpath> Задать директорию библиотеки (с zip-архивами), по умолчанию: там же, где лежит файл приложения
|
||||||
--inpx=<filepath> Задать путь к файлу .inpx, по умолчанию: тот, что найдется в директории библиотеки
|
--inpx=<filepath> Задать путь к файлу .inpx, по умолчанию: тот, что найдется в директории библиотеки
|
||||||
--recreate Принудительно пересоздать поисковую БД при запуске приложения
|
--recreate Принудительно пересоздать поисковую БД при запуске приложения
|
||||||
|
--unsafe-filter Использовать небезопасный фильтр на свой страх и риск
|
||||||
```
|
```
|
||||||
|
|
||||||
<a id="config" />
|
<a id="config" />
|
||||||
|
|
||||||
### Конфигурация
|
### Конфигурация
|
||||||
При первом запуске в рабочей директории будет создан конфигурационный файл `config.json`:
|
|
||||||
|
По умолчанию, при первом запуске в рабочей директории будет создан конфигурационный файл `config.json`.
|
||||||
|
При необходимости, можно настроить нужный параметр в этом файле вручную. Параметры командной
|
||||||
|
строки имеют больший приоритет, чем настройки из `config.json`.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
{
|
{
|
||||||
|
// рабочая директория приложения, аналог параметра командной строки --data-dir (или --app-dir)
|
||||||
|
// пустая строка: использовать значение по умолчанию - <execDir>/.inpx-web
|
||||||
|
// где execDir - директория файла приложения
|
||||||
|
"dataDir": "",
|
||||||
|
|
||||||
|
// директория для хранения временных файлов
|
||||||
|
// пустая строка: использовать значение по умолчанию - <dataDir>/tmp
|
||||||
|
// специальное значение "${OS}" указывается для использования системного каталога:
|
||||||
|
// "${OS}" => "<os_temporary_dir>/inpx-web"
|
||||||
|
"tempDir": "",
|
||||||
|
|
||||||
|
// директория для хранения логов
|
||||||
|
// пустая строка: использовать значение по умолчанию - <dataDir>/logs
|
||||||
|
"logDir": "",
|
||||||
|
|
||||||
// директория библиотеки (с zip-архивами), аналог параметра командной строки --lib-dir
|
// директория библиотеки (с zip-архивами), аналог параметра командной строки --lib-dir
|
||||||
// пустая строка: использовать значение по умолчанию - директорию файла приложения
|
// пустая строка: использовать значение по умолчанию - директорию файла приложения (execDir)
|
||||||
"libDir": "",
|
"libDir": "",
|
||||||
|
|
||||||
// путь к файлу .inpx, аналог параметра командной строки --inpx
|
// путь к файлу .inpx, аналог параметра командной строки --inpx
|
||||||
// пустая строка: использовать значение по умолчанию - inpx-файл, что найдется в директории библиотеки
|
// пустая строка: использовать значение по умолчанию - inpx-файл, что найдется в директории библиотеки
|
||||||
"inpx": "",
|
"inpx": "",
|
||||||
|
|
||||||
|
// конфигурационный файл для фильра по авторам и книгам (см. ниже)
|
||||||
|
// пустая строка: использовать значение по умолчанию - файл filter.json в директории файла конфигурации
|
||||||
|
"inpxFilterFile": "",
|
||||||
|
|
||||||
|
// разрешить(true)/запретить(false) перезаписывать файл конфигурации, если появились новые параметры для настройки
|
||||||
|
// файл перезаписывается с сохранением всех предыдущих настроек и с новыми по умолчанию
|
||||||
|
// бывает полезно при выходе новых версий приложения
|
||||||
|
"allowConfigRewrite": false,
|
||||||
|
|
||||||
|
// разрешить(true)/запретить(false) использовать небезопасный фильтр (см. ниже)
|
||||||
|
// аналог параметра командной строки --unsafe-filter
|
||||||
|
"allowUnsafeFilter": false,
|
||||||
|
|
||||||
// пароль для ограничения доступа к веб-интерфейсу сервера
|
// пароль для ограничения доступа к веб-интерфейсу сервера
|
||||||
// пустое значение - доступ без ограничений
|
// пустое значение - доступ без ограничений
|
||||||
"accessPassword": "",
|
"accessPassword": "",
|
||||||
@@ -210,9 +244,6 @@ Options:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
При необходимости, можно настроить нужный параметр в этом файле вручную. Параметры командной
|
|
||||||
строки имеют больший приоритет, чем настройки из `config.json`.
|
|
||||||
|
|
||||||
<a id="remotelib" />
|
<a id="remotelib" />
|
||||||
|
|
||||||
### Удаленная библиотека
|
### Удаленная библиотека
|
||||||
@@ -247,8 +278,8 @@ Options:
|
|||||||
### Фильтр по авторам и книгам
|
### Фильтр по авторам и книгам
|
||||||
|
|
||||||
При создании поисковой БД, во время загрузки и парсинга .inpx-файла, имеется возможность
|
При создании поисковой БД, во время загрузки и парсинга .inpx-файла, имеется возможность
|
||||||
отфильтровать авторов и книги, задав определенные критерии. Для этого небходимо создать
|
отфильтровать авторов и книги, задав определенные критерии. По умолчанию, для этого небходимо создать
|
||||||
в рабочей директории (там же, где `config.json`) файл `filter.json` следующего вида:
|
в директории конфигурационного файла (там же, где `config.json`) файл `filter.json` следующего вида:
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"info": {
|
"info": {
|
||||||
@@ -293,8 +324,10 @@ Options:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
Использование `filter` небезопасно, т.к. позволяет выполнить произвольный js-код внутри программы,
|
Использование `filter` небезопасно, т.к. позволяет выполнить произвольный js-код внутри программы,
|
||||||
поэтому запуск приложения в этом случае должен сопровождаться дополнительным параметром командной строки `--unsafe-filter`.
|
поэтому запуск приложения в этом случае должен сопровождаться дополнительным параметром командной строки `--unsafe-filter`
|
||||||
|
или разрешением в конфиге `allowUnsafeFilter`.
|
||||||
Названия атрибутов inpxRec соответствуют названиям в нижнем регистре из структуры structure.info в .inpx-файле.
|
Названия атрибутов inpxRec соответствуют названиям в нижнем регистре из структуры structure.info в .inpx-файле.
|
||||||
|
Файл `filter.json` можно расположить где угодно, что задается параметром `inpxFilterFile` в конфиге.
|
||||||
<a id="https" />
|
<a id="https" />
|
||||||
|
|
||||||
### Настройка https с помощью nginx
|
### Настройка https с помощью nginx
|
||||||
|
|||||||
@@ -10,9 +10,15 @@ module.exports = {
|
|||||||
name: pckg.name,
|
name: pckg.name,
|
||||||
|
|
||||||
execDir,
|
execDir,
|
||||||
|
dataDir: '',
|
||||||
|
tempDir: '',
|
||||||
|
logDir: '',
|
||||||
libDir: '',
|
libDir: '',
|
||||||
inpx: '',
|
inpx: '',
|
||||||
|
inpxFilterFile: '',
|
||||||
|
|
||||||
|
allowConfigRewrite: false,
|
||||||
|
allowUnsafeFilter: false,
|
||||||
accessPassword: '',
|
accessPassword: '',
|
||||||
accessTimeout: 0,
|
accessTimeout: 0,
|
||||||
extendedSearch: true,
|
extendedSearch: true,
|
||||||
|
|||||||
@@ -5,8 +5,14 @@ const fs = require('fs-extra');
|
|||||||
const branchFilename = __dirname + '/application_env';
|
const branchFilename = __dirname + '/application_env';
|
||||||
|
|
||||||
const propsToSave = [
|
const propsToSave = [
|
||||||
|
'dataDir',
|
||||||
|
'tempDir',
|
||||||
|
'logDir',
|
||||||
'libDir',
|
'libDir',
|
||||||
'inpx',
|
'inpx',
|
||||||
|
'inpxFilterFile',
|
||||||
|
'allowConfigRewrite',
|
||||||
|
'allowUnsafeFilter',
|
||||||
'accessPassword',
|
'accessPassword',
|
||||||
'accessTimeout',
|
'accessTimeout',
|
||||||
'extendedSearch',
|
'extendedSearch',
|
||||||
@@ -46,7 +52,7 @@ class ConfigManager {
|
|||||||
return instance;
|
return instance;
|
||||||
}
|
}
|
||||||
|
|
||||||
async init(dataDir) {
|
async init(tempDataDir, configFile) {
|
||||||
if (this.inited)
|
if (this.inited)
|
||||||
throw new Error('already inited');
|
throw new Error('already inited');
|
||||||
|
|
||||||
@@ -63,14 +69,16 @@ class ConfigManager {
|
|||||||
this.branchConfigFile = __dirname + `/${this.branch}.js`;
|
this.branchConfigFile = __dirname + `/${this.branch}.js`;
|
||||||
const config = require(this.branchConfigFile);
|
const config = require(this.branchConfigFile);
|
||||||
|
|
||||||
if (dataDir) {
|
if (!tempDataDir) {
|
||||||
config.dataDir = path.resolve(dataDir);
|
tempDataDir = `${config.execDir}/.${config.name}`;
|
||||||
} else {
|
}
|
||||||
config.dataDir = `${config.execDir}/.${config.name}`;
|
|
||||||
|
if (configFile) {
|
||||||
|
config.configFile = path.resolve(configFile);
|
||||||
|
} else {
|
||||||
|
config.configFile = `${tempDataDir}/config.json`;
|
||||||
}
|
}
|
||||||
|
|
||||||
await fs.ensureDir(config.dataDir);
|
|
||||||
this._userConfigFile = `${config.dataDir}/config.json`;
|
|
||||||
this._config = config;
|
this._config = config;
|
||||||
|
|
||||||
this.inited = true;
|
this.inited = true;
|
||||||
@@ -86,37 +94,31 @@ class ConfigManager {
|
|||||||
Object.assign(this._config, value);
|
Object.assign(this._config, value);
|
||||||
}
|
}
|
||||||
|
|
||||||
get userConfigFile() {
|
|
||||||
return this._userConfigFile;
|
|
||||||
}
|
|
||||||
|
|
||||||
set userConfigFile(value) {
|
|
||||||
if (value)
|
|
||||||
this._userConfigFile = value;
|
|
||||||
}
|
|
||||||
|
|
||||||
async load() {
|
async load() {
|
||||||
try {
|
try {
|
||||||
if (!this.inited)
|
if (!this.inited)
|
||||||
throw new Error('not inited');
|
throw new Error('not inited');
|
||||||
|
|
||||||
if (await fs.pathExists(this.userConfigFile)) {
|
if (await fs.pathExists(this._config.configFile)) {
|
||||||
const data = JSON.parse(await fs.readFile(this.userConfigFile, 'utf8'));
|
const data = JSON.parse(await fs.readFile(this._config.configFile, 'utf8'));
|
||||||
const config = _.pick(data, propsToSave);
|
const config = _.pick(data, propsToSave);
|
||||||
|
|
||||||
this.config = config;
|
this.config = config;
|
||||||
|
|
||||||
//сохраним конфиг, если не все атрибуты присутствуют в файле конфига
|
//сохраним конфиг, если не все атрибуты присутствуют в файле конфига
|
||||||
for (const prop of propsToSave)
|
if (config.allowConfigRewrite) {
|
||||||
|
for (const prop of propsToSave) {
|
||||||
if (!Object.prototype.hasOwnProperty.call(config, prop)) {
|
if (!Object.prototype.hasOwnProperty.call(config, prop)) {
|
||||||
await this.save();
|
await this.save();
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
await this.save();
|
await this.save();
|
||||||
}
|
}
|
||||||
} catch(e) {
|
} catch(e) {
|
||||||
throw new Error(`Error while loading "${this.userConfigFile}": ${e.message}`);
|
throw new Error(`Error while loading "${this._config.configFile}": ${e.message}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -125,7 +127,7 @@ class ConfigManager {
|
|||||||
throw new Error('not inited');
|
throw new Error('not inited');
|
||||||
|
|
||||||
const dataToSave = _.pick(this._config, propsToSave);
|
const dataToSave = _.pick(this._config, propsToSave);
|
||||||
await fs.writeFile(this.userConfigFile, JSON.stringify(dataToSave, null, 4));
|
await fs.writeFile(this._config.configFile, JSON.stringify(dataToSave, null, 4));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
const fs = require('fs-extra');
|
const fs = require('fs-extra');
|
||||||
const path = require('path');
|
const path = require('path');
|
||||||
|
const os = require('os');
|
||||||
|
|
||||||
const express = require('express');
|
const express = require('express');
|
||||||
const http = require('http');
|
const http = require('http');
|
||||||
@@ -13,7 +14,7 @@ let log;
|
|||||||
let config;
|
let config;
|
||||||
let argv;
|
let argv;
|
||||||
let branch = '';
|
let branch = '';
|
||||||
const argvStrings = ['host', 'port', 'app-dir', 'lib-dir', 'inpx'];
|
const argvStrings = ['host', 'port', 'config', 'data-dir', 'app-dir', 'lib-dir', 'inpx'];
|
||||||
|
|
||||||
function showHelp(defaultConfig) {
|
function showHelp(defaultConfig) {
|
||||||
console.log(utils.versionText(defaultConfig));
|
console.log(utils.versionText(defaultConfig));
|
||||||
@@ -24,21 +25,24 @@ Options:
|
|||||||
--help Print ${defaultConfig.name} command line options
|
--help Print ${defaultConfig.name} command line options
|
||||||
--host=<ip> Set web server host, default: ${defaultConfig.server.host}
|
--host=<ip> Set web server host, default: ${defaultConfig.server.host}
|
||||||
--port=<port> Set web server port, default: ${defaultConfig.server.port}
|
--port=<port> Set web server port, default: ${defaultConfig.server.port}
|
||||||
--app-dir=<dirpath> Set application working directory, default: <execDir>/.${defaultConfig.name}
|
--config=<filepath> Set config filename, default: <dataDir>/config.json
|
||||||
|
--data-dir=<dirpath> (or --app-dir) Set application working directory, default: <execDir>/.${defaultConfig.name}
|
||||||
--lib-dir=<dirpath> Set library directory, default: the same as ${defaultConfig.name} executable's
|
--lib-dir=<dirpath> Set library directory, default: the same as ${defaultConfig.name} executable's
|
||||||
--inpx=<filepath> Set INPX collection file, default: the one that found in library dir
|
--inpx=<filepath> Set INPX collection file, default: the one that found in library dir
|
||||||
--recreate Force recreation of the search database on start
|
--recreate Force recreation of the search database on start
|
||||||
|
--unsafe-filter Use filter config at your own risk
|
||||||
`
|
`
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function init() {
|
async function init() {
|
||||||
argv = require('minimist')(process.argv.slice(2), {string: argvStrings});
|
argv = require('minimist')(process.argv.slice(2), {string: argvStrings});
|
||||||
const dataDir = argv['app-dir'];
|
const argvDataDir = argv['data-dir'] || argv['app-dir'];
|
||||||
|
const configFile = argv['config'];
|
||||||
|
|
||||||
//config
|
//config
|
||||||
const configManager = new (require('./config'))();//singleton
|
const configManager = new (require('./config'))();//singleton
|
||||||
await configManager.init(dataDir);
|
await configManager.init(argvDataDir, configFile);
|
||||||
const defaultConfig = configManager.config;
|
const defaultConfig = configManager.config;
|
||||||
|
|
||||||
await configManager.load();
|
await configManager.load();
|
||||||
@@ -46,8 +50,12 @@ async function init() {
|
|||||||
branch = config.branch;
|
branch = config.branch;
|
||||||
|
|
||||||
//dirs
|
//dirs
|
||||||
config.tempDir = `${config.dataDir}/tmp`;
|
config.dataDir = config.dataDir || argvDataDir || `${config.execDir}/.${config.name}`;
|
||||||
config.logDir = `${config.dataDir}/log`;
|
config.tempDir = config.tempDir || `${config.dataDir}/tmp`;
|
||||||
|
if (config.tempDir === '${OS}')
|
||||||
|
config.tempDir = `${os.tmpdir()}/${config.name}`
|
||||||
|
|
||||||
|
config.logDir = config.logDir || `${config.dataDir}/log`;
|
||||||
config.publicDir = `${config.dataDir}/public`;
|
config.publicDir = `${config.dataDir}/public`;
|
||||||
config.publicFilesDir = `${config.dataDir}/public-files`;
|
config.publicFilesDir = `${config.dataDir}/public-files`;
|
||||||
config.rootPathStatic = config.server.root || '';
|
config.rootPathStatic = config.server.root || '';
|
||||||
@@ -127,14 +135,22 @@ async function init() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
config.recreateDb = argv.recreate || false;
|
config.recreateDb = argv.recreate || false;
|
||||||
config.inpxFilterFile = `${config.dataDir}/filter.json`;
|
config.inpxFilterFile = config.inpxFilterFile || `${path.dirname(config.configFile)}/filter.json`;
|
||||||
config.allowUnsafeFilter = argv['unsafe-filter'] || false;
|
config.allowUnsafeFilter = argv['unsafe-filter'] || config.allowUnsafeFilter || false;
|
||||||
|
|
||||||
//web app
|
//web app
|
||||||
if (branch !== 'development') {
|
if (branch !== 'development') {
|
||||||
const createWebApp = require('./createWebApp');
|
const createWebApp = require('./createWebApp');
|
||||||
await createWebApp(config);
|
await createWebApp(config);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//log dirs
|
||||||
|
for (const prop of ['configFile', 'dataDir', 'tempDir', 'logDir']) {
|
||||||
|
log(`${prop}: ${config[prop]}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (await fs.pathExists(config.inpxFilterFile))
|
||||||
|
log(`inpxFilterFile: ${config.inpxFilterFile}`)
|
||||||
}
|
}
|
||||||
|
|
||||||
function logQueries(app) {
|
function logQueries(app) {
|
||||||
|
|||||||
Reference in New Issue
Block a user