Node.js настройка конфигураций, специфичных для среды, которые будут использоваться с everyauth
Я использую node.js + express.js + everyauth.js. Я переместил всю свою логику everyauth в файл модуля
var login = require('./lib/everyauthLogin');
внутри этого я загружаю свой файл конфигурации oAuth с помощью комбинаций клавиш/секрета:
var conf = require('./conf');
.....
twitter: {
consumerKey: 'ABC',
consumerSecret: '123'
}
Эти коды различны для разных сред: разработка/стадия/производство, поскольку обратные вызовы относятся к разным URL-адресам.
Qu. Как установить эти параметры в конфигурации среды для фильтрации через все модули или я могу передать путь непосредственно в модуль?
Установить в env:
app.configure('development', function(){
app.set('configPath', './confLocal');
});
app.configure('production', function(){
app.set('configPath', './confProduction');
});
var conf = require(app.get('configPath'));
Пропустить
app.configure('production', function(){
var login = require('./lib/everyauthLogin', {configPath: './confProduction'});
});
? надеюсь, что имеет смысл
Ответы
Ответ 1
Мое решение,
загрузите приложение, используя
NODE_ENV=production node app.js
Затем установите config.js
как функцию, а не объект
module.exports = function(){
switch(process.env.NODE_ENV){
case 'development':
return {dev setting};
case 'production':
return {prod settings};
default:
return {error or other settings};
}
};
Затем в соответствии с решением Jans загрузите файл и создайте новый экземпляр, который мы могли бы передать при необходимости, в этом случае process.env.NODE_ENV
является глобальным, поэтому не нужно.
var Config = require('./conf'),
conf = new Config();
Затем мы можем получить доступ к свойствам объекта конфигурации точно так же, как раньше
conf.twitter.consumerKey
Ответ 2
У вас также может быть JSON файл с NODE_ENV как верхний уровень. IMO, это лучший способ выразить настройки конфигурации (в отличие от использования script, который возвращает настройки).
var config = require('./env.json')[process.env.NODE_ENV || 'development'];
Пример для env.json:
{
"development": {
"MONGO_URI": "mongodb://localhost/test",
"MONGO_OPTIONS": { "db": { "safe": true } }
},
"production": {
"MONGO_URI": "mongodb://localhost/production",
"MONGO_OPTIONS": { "db": { "safe": true } }
}
}
Ответ 3
Очень полезным решением является использование конфигурационного модуля.
после установки модуля:
$ npm install config
Вы можете создать конфигурационный файл default.json. (вы можете использовать JSON или JS-объект, используя расширение .json5)
Например
$ vi config/default.json
{
"name": "My App Name",
"configPath": "/my/default/path",
"port": 3000
}
Эта конфигурация по умолчанию может быть переопределена файлом конфигурации среды или локальным файлом конфигурации для локальной среды разработки:
production.json может быть:
{
"configPath": "/my/production/path",
"port": 8080
}
development.json может быть:
{
"configPath": "/my/development/path",
"port": 8081
}
На вашем локальном ПК у вас может быть local.json, который переопределяет всю среду, или вы можете иметь определенную локальную конфигурацию как local-production.json или локального development.json.
Полный список порядка загрузки.
Внутри приложения
В вашем приложении вам нужно только указать конфигурацию и необходимый атрибут.
var conf = require('config'); // it loads the right file
var login = require('./lib/everyauthLogin', {configPath: conf.get('configPath'));
Загрузить приложение
загрузите приложение, используя:
NODE_ENV=production node app.js
или установить правильную среду с навсегда или pm2
Навсегда:
NODE_ENV=production forever [flags] start app.js [app_flags]
PM2 (через оболочку):
export NODE_ENV=staging
pm2 start app.js
PM2 (через .json):
process.json
{
"apps" : [{
"name": "My App",
"script": "worker.js",
"env": {
"NODE_ENV": "development",
},
"env_production" : {
"NODE_ENV": "production"
}
}]
}
И затем
$ pm2 start process.json --env production
Это решение очень чистое и упрощает настройку различных конфигурационных файлов для среды Production/Staging/Development и для локальных настроек.
Ответ 4
Как мы это делаем, передаем аргумент при запуске приложения со средой. Например:
node app.js -c dev
В app.js мы загружаем dev.js
в качестве нашего файла конфигурации. Вы можете проанализировать эти параметры с помощью optparse-js.
Теперь у вас есть некоторые основные модули, которые зависят от этого файла конфигурации. Когда вы пишете их как таковые:
var Workspace = module.exports = function(config) {
if (config) {
// do something;
}
}
(function () {
this.methodOnWorkspace = function () {
};
}).call(Workspace.prototype);
И вы можете вызвать его, затем в app.js
, например:
var Workspace = require("workspace");
this.workspace = new Workspace(config);
Ответ 5
Элегантным способом является использование файла .env
для локального переопределения производственных параметров.
Нет необходимости в переключателях командной строки. Нет необходимости во всех этих запятых и скобках в файле config.json
. См. мой ответ здесь
Пример: на моей машине файл .env
таков:
NODE_ENV=dev
TWITTER_AUTH_TOKEN=something-needed-for-api-calls
Мой локальный .env
переопределяет любые переменные среды. Но на промежуточных или производственных серверах (возможно, они находятся на heroku.com) переменные среды предварительно настроены на этап NODE_ENV=stage
или production NODE_ENV=prod
.
Ответ 6
Как сделать это более элегантным способом с nodejs-config.
Этот модуль может установить конфигурационную среду на основе имени вашего компьютера. После этого при запросе конфигурации вы получите значение, специфичное для среды.
Например, предположим, что у вас есть две машины разработки с именем pc1 и pc2 и производственная машина с именем pc3. Когда вы запрашиваете значения конфигурации в вашем коде в pc1 или pc2, вы должны получить конфигурацию среды разработки и в pc3 вы должны получить конфигурацию среды "производства". Это может быть достигнуто следующим образом:
- Создайте базовый файл конфигурации в каталоге config, скажем, "app.json" и добавьте в него необходимые конфигурации.
- Теперь просто создайте папки в каталоге конфигурации, соответствующие вашему названию среды, в данном случае "разработка" и "производство".
- Затем создайте файлы конфигурации, которые вы хотите переопределить, и укажите параметры для каждой среды в каталогах среды (обратите внимание, что вам не нужно указывать все параметры, которые находятся в базовом файле конфигурации, но только параметры, которые вы хотите переопределение. Файлы конфигурации среды будут "каскадироваться" над базовыми файлами.).
Теперь создайте новый экземпляр конфигурации со следующим синтаксисом.
var config = require('nodejs-config')(
__dirname, // an absolute path to your applications 'config' directory
{
development: ["pc1", "pc2"],
production: ["pc3"],
}
);
Теперь вы можете получить любое значение конфигурации, не беспокоясь о такой среде:
config.get('app').configurationKey;
Ответ 7
Вкратце
Такая настройка проста и элегантна:
env.json
{
"development": {
"facebook_app_id": "facebook_dummy_dev_app_id",
"facebook_app_secret": "facebook_dummy_dev_app_secret",
},
"production": {
"facebook_app_id": "facebook_dummy_prod_app_id",
"facebook_app_secret": "facebook_dummy_prod_app_secret",
}
}
common.js
var env = require('env.json');
exports.config = function() {
var node_env = process.env.NODE_ENV || 'development';
return env[node_env];
};
app.js
var common = require('./routes/common')
var config = common.config();
var facebook_app_id = config.facebook_app_id;
// do something with facebook_app_id
Для запуска в режиме производства:
$ NODE_ENV=production node app.js
Подробнее
Это решение от: http://himanshu.gilani.info/blog/2012/09/26/bootstraping-a-node-dot-js-app-for-dev-slash-prod-environment/, проверьте его более подробно.