Permalink
Branch: master
Find file Copy path
6a766d2 Oct 30, 2018
1 contributor

Users who have contributed to this file

42 lines (24 sloc) 1.62 KB

Pelias Sofware requirements

This is the list of all software requirements for Pelias. We highly recommend using our Docker images to avoid having to even attempt to correctly install all our dependencies yourself.

Node.js

Most Pelias code is written in Node.js.

Version 8 or newer is required, version 10 is recommended for improved performance.

Pelias generally only adds support for even numbered LTS Node.js versions. However we gladly accept patches and bug reports regarding issues with any Node.js version that has not reached end-of-life.

Elasticsearch

Version 2.4 or 5.6

The core data storage for Pelias is Elasticsearch. We recommend the latest in the 2.4 release line.

Support for Elasticsearch 5 is new and should not yet be considered production-ready.

Elasticsearch 6 support will follow once Elasticsearch 5 has been the recommended version for some time.

SQLite

Version 3.11 or newer

Some components of Pelias need a relational database, and Elasticsearch does not provide good relational support. We use SQLite in these cases since it's simple to manage and quite performant.

Libpostal

Pelias relies heavily on the Libpostal address parser. Libpostal requires about 4GB of disk space to download all the required data.

Windows Support

Pelias is not well tested on Windows, but we do wish to support it, and will accept patches to fix any issues with Windows support.