mirror of
https://github.com/feathersjs/feathers.git
synced 2025-12-08 19:46:22 +00:00
ae85fa216f
* feat(docs) new docs site started * Minor page edits * feat(footer) fix spacing * empty guides template Co-authored-by: daffl <daff@neyeon.com>
87 lines
4.1 KiB
Markdown
87 lines
4.1 KiB
Markdown
# Configuration
|
||
|
||
[](https://www.npmjs.com/package/@feathersjs/configuration)
|
||
[](https://github.com/feathersjs/feathers/blob/crow/packages/configuration/CHANGELOG.md)
|
||
|
||
```
|
||
npm install @feathersjs/configuration --save
|
||
```
|
||
|
||
`@feathersjs/configuration` is a wrapper for [node-config](https://github.com/lorenwest/node-config) which allows to configure a server side Feathers application.
|
||
|
||
|
||
By default this implementation will look in `config/*` for `default.json` which retains convention. It will be merged with other configuration files in the `config/` folder using the `NODE_ENV` environment variable. So setting `NODE_ENV=production` will merge `config/default.json` with `config/production.json`.
|
||
|
||
As per the [config docs](https://github.com/lorenwest/node-config/wiki/Configuration-Files) you can organize *"hierarchical configurations for your app deployments"*.
|
||
|
||
## Usage
|
||
|
||
The `@feathersjs/configuration` module is an app configuration function that takes a root directory (usually something like `__dirname` in your application) and the configuration folder (set to `config` by default):
|
||
|
||
```js
|
||
const feathers = require('@feathersjs/feathers');
|
||
const configuration = require('@feathersjs/configuration');
|
||
|
||
// Use the application root and `config/` as the configuration folder
|
||
const app = feathers().configure(configuration())
|
||
```
|
||
|
||
> **Note**: Direct access to nested config properties is not supported via `app.get()`. To access a nested config property (e.g. `Customer.dbConfig.host`, use `app.get('Customer').dbConfig.host` or `require('config')` directly and use it [as documented](https://github.com/lorenwest/node-config).
|
||
|
||
## Configuration schema
|
||
|
||
The application configuration can be validated against a [Feathers schema](./schema/index.md) when [app.setup](./application.md#setupserver) (or `app.listen`) is called by passing a schema when initializing `@feathersjs/configuration`:
|
||
|
||
```js
|
||
const feathers = require('@feathersjs/feathers');
|
||
const schema = require('@feathersjs/schema');
|
||
const configuration = require('@feathersjs/configuration');
|
||
|
||
const configurationSchema = schema({
|
||
$id: 'FeathersConfiguration',
|
||
type: 'object',
|
||
additionalProperties: false,
|
||
required: ['port', 'host'],
|
||
properties: {
|
||
port: { type: 'number' },
|
||
host: { type: 'string' }
|
||
}
|
||
});
|
||
|
||
// Use the application root and `config/` as the configuration folder
|
||
const app = feathers().configure(configuration(configurationSchema))
|
||
|
||
// Configuration will only be validated now
|
||
app.listen();
|
||
```
|
||
|
||
|
||
## Environment variables
|
||
|
||
As recommended by node-config, it is possible to override the configuration with custom variables by passing a JSON object in the [`NODE_CONFIG` environment variable](https://github.com/lorenwest/node-config/wiki/Environment-Variables#node_config):
|
||
|
||
```
|
||
$ export NODE_CONFIG='{ "port": 8080, "host": "production.app" }'
|
||
$ node myapp.js
|
||
```
|
||
|
||
Individual environment variables can be used through [Custom Environment Variables](https://github.com/lorenwest/node-config/wiki/Environment-Variables#custom-environment-variables) by creating a `config/custom-environment-variables.json` like this:
|
||
|
||
```js
|
||
{
|
||
"port": "PORT",
|
||
"mongodb": "MONGOHQ_URL"
|
||
}
|
||
```
|
||
|
||
## Configuration directory
|
||
|
||
By default, Feathers will use the `config/` directory in the root of your project’s source directory. To change this, e.g., if you have Feathers installed under the `server/` directory and you want your configuration at `server/config/`, you have to set the `NODE_CONFIG_DIR` environment variable in `app.js` _before_ importing `@feathersjs/configuration`:
|
||
|
||
```
|
||
$ export NODE_CONFIG_DIR=server/config
|
||
$ node myapp.js
|
||
```
|
||
|
||
> __Note:__ The NODE_CONFIG_DIR environment variable isn’t used directly by @feathersjs/configuration but by the [node-config](https://github.com/lorenwest/node-config) module that it uses. For more information on configuring node-config settings, see the [Configuration Files Wiki page](https://github.com/lorenwest/node-config/wiki/Configuration-Files).
|