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.
Version 12
Most Pelias code is written in Node.js, so this is one of the most core dependencies of the project.
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.
We recommend you always use the latest minor and patch release of whichever major release line you choose.
We strive to support any minor or patch version of our supported major release lines of Node.js, but on occasion this may not be possible and we'll offer additional guidance.
Version 7.5+
We recommend the latest in the Elasticsearch 7 release line. Elasticsearch 8 is also supported.
The core data storage for Pelias is Elasticsearch, and Elasticsearch makes major breaking changes from release to release, so it's important to track these versions carefully.
We generally strive to support the newest and second newest version of Elasticsearch. Due to the way Elasticsearch manages breaking changes, it's usually only possible to fully support two Elasticsearch versions at a time.
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.
Pelias relies heavily on the Libpostal address parser. Libpostal requires about 4GB of disk space to download all the required data.
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.