\n\nWhat is Pelias?\n \nPelias is a search engine for places worldwide, powered by open data. It turns addresses and place names into geographic coordinates, and turns geographic coordinates into places and addresses. With Pelias, you're able to turn your users' place searches into actionable geodata and transform your geodata into real places.\n
\nWe think open data, open source, and open strategy win over proprietary solutions at any part of the stack and we want to ensure the services we offer are in line with that vision. We believe that an open geocoder improves over the long-term only if the community can incorporate truly representative local knowledge.\n\n\n# Pelias Configuration\n\nThis repository defines standard configuration for all parts of the Pelias geocoder. It contains tools for Pelias packages to read from configuration in a standardized way, and for Pelias users to set up their own configuration.\n\n\n[](https://nodei.co/npm/pelias-config)\n\n## Installation\n\n```bash\n$ npm install pelias-config\n```\n\n## Usage\n\nCreate a new Pelias config:\n\n```javascript\nvar config = require('pelias-config');\n\n// use the default settings\nvar settings = config.defaults;\n```\n\n#### development settings\n\n```javascript\nvar config = require('pelias-config');\n\n// generate development specific settings\nvar settings = config.generate();\n```\n\n#### local config\n\nthe easiest way to get a custom config is to create a file named `~/pelias.json`.\n\nyou can copy the example file from here: https://github.com/pelias/config/blob/master/config/local.json\n\nthis file will be checked for settings whenever you run imports and will override the defaults; it is particularly useful for specifying datasource paths during development.\n\n#### production settings\n\nsysadmin and ops engineers can override the default settings on the server by launching any code which requires this module by supplying an ENV var with the path to their custom json config.\n\n```bash\n$ PELIAS_CONFIG=/path/to/settings/file.json node app.js\n```\n\nNote: by default the merge is deep (it replaces the defaults with any properties that are present in the env config).\nThe developer can disable deep merging to use only local configuration settings.\n\n```javascript\nvar config = require('pelias-config');\n\n// shallow merge config settings from a path supplied in the env var\nvar settings = config.generate( false );\n\n// deep merge config settings from a path supplied in the env var\nvar settings = config.generate( true );\nvar settings = config.generate();\n```\n\nYou can test the result of merging your env config with the following bash oneliner:\n```bash\nnpm install pelias-config; \\\nPELIAS_CONFIG=/path/config.json \\\nnode -e \"console.log( JSON.stringify(require('pelias-config').generate(), null, 2) );\";\n```\n\n### Validation\n\nAside from `deep`, the `generate` function takes an additional parameter named `schema` that uses [Joi](https://www.npmjs.com/package/joi) to validate that the configuration is useable. An error is thrown if the generated configuration does not validate against the schema.\n\n### Exporting & Debugging\n\nThe generated config will be a standard Javascript object:\n\n```javascript\nvar config = require('pelias-config'),\n settings = config.generate();\n\nconsole.log(JSON.stringify(settings, null, 2));\n// {\n// \"api\": {\n// ...\n// },\n// \"imports\": {\n// ...\n// }\n// }\n```\n\nYou can pretty print the generated config with any package you like or with `JSON.stringify`.\nUsing the third parameter to `JSON.stringify` for indentation may be helpful:\n\n```javascript\nvar config = require('pelias-config'),\n settings = config.generate();\n\nconsole.log( JSON.stringify(settings, null, 2) );\n```\n\n## NPM Module\n\nThe `pelias-config` npm module can be found here:\n\n[https://npmjs.org/package/pelias-config](https://npmjs.org/package/pelias-config)\n\n## Contributing\n\nPlease fork and pull request against upstream master on a feature branch.\n\nPretty please; provide unit tests and script fixtures in the `test` directory.\n\n### Running Unit Tests\n\n```bash\n$ npm test\n```\n\n### Continuous Integration\n\nCI tests every release against all supported Node.js versions.\n","readmeFilename":"README.md"}
![](\"https://raw.githubusercontent.com/pelias/design/master/logo/pelias_github/Github_markdown_hero.png\"){kind=logo}
\n![](\"https://github.com/pelias/config/workflows/Continuous%20Integration/badge.svg\"){kind=icon}
\n![](\"https://img.shields.io/github/license/pelias/config?style=flat&color=orange\")
![](\"https://img.shields.io/gitter/room/pelias/pelias?style=flat&color=yellow\")