Stuff for the nodejs port

.github/workflows/elasticsearch-image-builder.yml

@@ -0,0 +1,25 @@
+# name: Build Docker Images
+# on:
+#   push:
+#     paths:
+#       - "images/elasticsearch/**"
+#       - ".github/workflows/**"
+# jobs:
+#   build:
+#     if: github.ref == 'refs/heads/master' && needs.unit-tests.result == 'success'
+#     runs-on: ubuntu-22.04
+#     strategy:
+#       matrix:
+#         elastic-version:
+#           - "7.17.15"
+#     env:
+#       DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+#       DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+#     steps:
+#       - uses: actions/checkout@v2
+#         with:
+#           fetch-depth: 100
+#       - name: "Build elasticsearch@${{ matrix.elastic-version }}"
+#         run: |
+#           cd images/elasticsearch/${{ matrix.elastic-version }}
+#           curl "https://raw.githubusercontent.com/pelias/ci-tools/master/build-docker-images.sh" | bash -

.gitignore

@@ -0,0 +1,4 @@
+projects/*/data
+.DS_Store
+node_modules
+package-lock.json

README.md

@@ -1,7 +1,30 @@
+<p align="center">
+  <img height="100" src="https://raw.githubusercontent.com/pelias/design/master/logo/pelias_github/Github_markdown_hero.png">
+</p>
+<h3 align="center">A modular, open-source search engine for our world.</h3>
+<p align="center">Pelias is a geocoder powered completely by open data, available freely to everyone.</p>
+<p align="center">
+<a href="https://en.wikipedia.org/wiki/MIT_License"><img src="https://img.shields.io/github/license/pelias/api?style=flat&color=orange" /></a>
+<a href="https://hub.docker.com/u/pelias"><img src="https://img.shields.io/docker/pulls/pelias/api?style=flat&color=informational" /></a>
+<a href="https://gitter.im/pelias/pelias"><img src="https://img.shields.io/gitter/room/pelias/pelias?style=flat&color=yellow" /></a>
+</p>
+<p align="center">
+	<a href="https://github.com/pelias/docker">Local Installation</a> ·
+        <a href="https://geocode.earth">Cloud Webservice</a> ·
+	<a href="https://github.com/pelias/documentation">Documentation</a> ·
+	<a href="https://gitter.im/pelias/pelias">Community Chat</a>
+</p>
+<details open>
+<summary>What is Pelias?</summary>
+<br />
+Pelias 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.
+<br /><br />
+We 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.
+</details>
 
 # Pelias in Docker
 
-This repository contains a framework for downloading/preparing and building the [Pelias Geocoder](https://github.com/pelias/pelias) using Docker and [Docker Compose](https://github.com/docker/compose#docker-compose).
+This repository contains a framework for downloading/preparing and building the [Pelias Geocoder](https://github.com/pelias/pelias) using Docker and [Docker Compose](https://github.com/docker/compose#docker-compose-v2).
 
 ## Projects
 
@@ -13,10 +36,21 @@ Once you have successfully completed a small build you can use this as a base to
 
 ## Prerequisites
 
-You will need to have a [modern version of `docker`](https://docs.docker.com/engine/release-notes/) and a [modern version of `docker-compose`](https://github.com/docker/compose/blob/master/CHANGELOG.md) installed before continuing. If you are not using the latest version, please mention that in any bugs reports.
+You will need to have a [modern version of `docker`](https://docs.docker.com/engine/release-notes/) and a [modern version of `docker compose`](https://github.com/docker/compose/releases) installed before continuing. If you are not using the latest version, please mention that in any bugs reports.
 
 This project supports Linux and Mac OSX operatings systems. Windows is currently [not supported](https://github.com/pelias/docker/issues/124).
 
+### Permissions
+
+In order to ensure security, Pelias docker containers, and the `pelias` helper script, will not run as a root user!
+
+Be sure you are running as a non-root user and that this user can execute `docker` commands. See the Docker documentation article [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) to do this.
+
+## Requirements for Linux
+- Install `util-linux` using your distribution's package manager
+  - Alpine Linux: `sudo apk add util-linux`
+  - Debian/Ubuntu: `sudo apt-get install util-linux` 
+
 ## Requirements for Mac OSX
 - install GNU coreutils with [Homebrew](https://brew.sh/): `brew install coreutils`.
 - Max-out Docker computing resources( `Memory-RAM and CPUs-Cores` ) dedicated to Docker in `Docker > Preferences > Advanced`.
@@ -27,36 +61,45 @@ Scripts can easily download tens of GB of geographic data, so ensure you have en
 
 At least 8GB RAM is required.
 
+## How long will it take?
+
+You should be able to get started with the default Portland-metro area build in under an hour with a fast internet connection.
+
+On a machine with ~32 CPU cores, a full planet build can be done in under a day with the right settings.
+
+The interpolation build (`pelias prepare interpolation`), which is [single threaded](https://github.com/pelias/interpolation/issues/264) will take 6+ days
+for the full planet. We generally recommend skipping it when you are first
+getting started.
+
+For more info on time estimates and hardware requirements for large build see our [full planet considerations](https://github.com/pelias/documentation/blob/master/full_planet_considerations.md) documentation.
+
 ## Quickstart build script
 
 The following shell script can be used to quickly get started with a Pelias build.
 
-Feel free to modify the code and data locations to suit your needs.
-
 ```bash
 #!/bin/bash
 set -x
 
-# create directories
-mkdir /code /data
-
-# set proper permissions. make sure the user matches your `DOCKER_USER` setting in `.env`
-chown 1000:1000 /code /data
+# change directory to the where you would like to install Pelias
+# cd /path/to/install
 
-# clone repo
-cd /code
-git clone https://github.com/pelias/docker.git
-cd docker
+# clone this repository
+git clone https://github.com/pelias/docker.git && cd docker
 
 # install pelias script
-ln -s "$(pwd)/pelias" /usr/local/bin/pelias
+# this is the _only_ setup command that should require `sudo`
+sudo ln -s "$(pwd)/pelias" /usr/local/bin/pelias
 
-# cwd
+# cd into the project directory
 cd projects/portland-metro
 
-# configure environment
+# create a directory to store Pelias data files
+# see: https://github.com/pelias/docker#variable-data_dir
+# note: use 'gsed' instead of 'sed' on a Mac
+mkdir ./data
 sed -i '/DATA_DIR/d' .env
-echo 'DATA_DIR=/data' >> .env
+echo 'DATA_DIR=./data' >> .env
 
 # run build
 pelias compose pull
@@ -72,7 +115,6 @@ pelias compose up
 pelias test run
 ```
 
-
 ## Installing the Pelias helper script
 
 This repository makes use of a helper script to make basic management of the Pelias Docker images easy.
@@ -84,8 +126,14 @@ You can find the `pelias` file in the root of this repository.
 Advanced users may have a preference how this is done on their system, but a basic example would be to do something like:
 
 ```bash
-git clone https://github.com/pelias/docker.git ~/pelias
-ln -s ~/pelias/pelias /usr/local/bin/pelias
+# change directory to the where you would like to install Pelias
+# cd /path/to/install
+
+# clone this repository
+git clone https://github.com/pelias/docker.git && cd docker
+
+# install pelias script
+sudo ln -s "$(pwd)/pelias" /usr/local/bin/pelias
 ```
 
 Once the command is correctly installed you should be able to run the following command to confirm the pelias command is available on your path:
@@ -135,7 +183,6 @@ Then use your text editor to modify the `.env` file to reflect your new path, it
 ```bash
 COMPOSE_PROJECT_NAME=pelias
 DATA_DIR=/tmp/pelias
-DOCKER_USER=1000
 ```
 
 You can then list the environment variables to ensure they have been correctly set:
@@ -152,9 +199,7 @@ Note: changing the `COMPOSE_PROJECT_NAME` variable is not advisable unless you k
 
 ### Variable: DOCKER_USER
 
-All processes in Pelias containers are run as non-root users. By default, the UID of the processes will be `1000`, which is the first user ID on _most_ Linux systems and is likely to be a good option. However, if restricting file permissions in your data directory to a different user or group is important, this can be overridden by setting the `DOCKER_USER` variable.
-
-This variable can take just a UID or a UID:GID combination such as `1000:1000`. See the [docker-compose](https://docs.docker.com/compose/compose-file/#domainname-hostname-ipc-mac_address-privileged-read_only-shm_size-stdin_open-tty-user-working_dir) and [docker run](https://docs.docker.com/engine/reference/run/#user) documentation on controlling Docker container users for more information.
+This variable is no longer used, and will be ignored. If you still have it in your `.env` file, you can safely remove it.
 
 ## CLI commands
 
@@ -169,11 +214,11 @@ Usage: pelias [command] [action] [options]
   compose   logs                     display container logs
   compose   ps                       list containers
   compose   top                      display the running processes of a container
-  compose   exec                     execute an arbitrary docker-compose command
-  compose   run                      execute a docker-compose run command
-  compose   up                       start one or more docker-compose service(s)
-  compose   kill                     kill one or more docker-compose service(s)
-  compose   down                     stop all docker-compose service(s)
+  compose   exec                     execute an arbitrary docker compose command
+  compose   run                      execute a docker compose run command
+  compose   up                       start one or more docker compose service(s)
+  compose   kill                     kill one or more docker compose service(s)
+  compose   down                     stop all docker compose service(s)
   download  wof                      (re)download whosonfirst data
   download  oa                       (re)download openaddresses data
   download  osm                      (re)download openstreetmap data
@@ -193,6 +238,7 @@ Usage: pelias [command] [action] [options]
   import    osm                      (re)import openstreetmap data
   import    polylines                (re)import polylines data
   import    transit                  (re)import transit data
+  import    csv                      (re)import csv data
   import    all                      (re)import all data
   prepare   polylines                export road network from openstreetmap into polylines format
   prepare   interpolation            build interpolation sqlite databases
@@ -205,20 +251,20 @@ Usage: pelias [command] [action] [options]
 
 ### Compose commands
 
-The compose commands are available as a shortcut to running `docker-compose` directly, they will also ensure that your environment is correctly configured.
+The compose commands are available as a shortcut to running `docker compose` directly, they will also ensure that your environment is correctly configured.
 
-See the docker-compose documentation for more info: https://docs.docker.com/compose/overview/
+See the docker compose documentation for more info: https://docs.docker.com/compose/overview/
 
 ```bash
 pelias compose pull                     update all docker images
 pelias compose logs                     display container logs
 pelias compose ps                       list containers
 pelias compose top                      display the running processes of a container
-pelias compose exec                     execute an arbitrary docker-compose command
-pelias compose run                      execute a docker-compose run command
-pelias compose up                       start one or more docker-compose service(s)
-pelias compose kill                     kill one or more docker-compose service(s)
-pelias compose down                     stop all docker-compose service(s)
+pelias compose exec                     execute an arbitrary docker compose command
+pelias compose run                      execute a docker compose run command
+pelias compose up                       start one or more docker compose service(s)
+pelias compose kill                     kill one or more docker compose service(s)
+pelias compose down                     stop all docker compose service(s)
 ```
 
 ### Download commands
@@ -360,3 +406,7 @@ Once all the importers have completed and the Pelias services are running, you c
 ### Interpolation
 
 - http://localhost:4300/demo/#13/45.5465/-122.6351
+
+### Libpostal
+
+- http://localhost:4400/parse?address=1730+ne+26th+ave,+portland,+or

cmd/compose.js

@@ -0,0 +1,8 @@
+module.exports = {
+  command: 'compose <cmd>',
+  describe: 'shortcuts to running docker compose directly',
+  builder: (yargs) => yargs
+    .commandDir('compose')
+    .usage('$0 <cmd> [args]')
+    .demandCommand(1, '')
+}

cmd/compose/down.js

@@ -0,0 +1,10 @@
+const child = require('child_process')
+const options = { stdio: 'inherit' }
+
+module.exports = {
+  command: 'down',
+  describe: 'stop all docker-compose service(s)',
+  handler: (argv) => {
+    child.spawnSync(oldOrNewCompose(), ['down'], options)
+  }
+}

cmd/compose/exec.js

@@ -0,0 +1,10 @@
+const child = require('child_process')
+const options = { stdio: 'inherit', shell:true }
+
+module.exports = {
+  command: 'exec',
+  describe: 'execute an arbitrary docker-compose command',
+  handler: (argv) => {
+    child.spawnSync(oldOrNewCompose(), argv._.slice(1), options)
+  }
+}

cmd/compose/kill.js

@@ -0,0 +1,10 @@
+const child = require('child_process')
+const options = { stdio: 'inherit' }
+
+module.exports = {
+  command: 'kill',
+  describe: 'kill one or more docker-compose service(s)',
+  handler: (argv) => {
+    child.spawnSync(oldOrNewCompose(), argv._.slice(1), options)
+  }
+}

cmd/compose/logs.js

@@ -0,0 +1,11 @@
+const child = require('child_process')
+const oldOrNewCompose = require('./oldOrNewCompose')
+const options = { stdio: 'inherit' , shell: true}
+
+module.exports = {
+  command: 'logs',
+  describe: 'display container logs',
+  handler: (argv) => {
+    child.spawnSync(oldOrNewCompose(), argv._.slice(1), options)
+  }
+}

cmd/compose/oldOrNewCompose.js

@@ -0,0 +1,10 @@
+const child = require('child_process')
+const oldOrNewCompose = require('./oldOrNewCompose')
+const options = { stdio: 'ignore', shell:true }
+
+module.exports = function oldOrNewCompose(){
+    if(child.spawnSync('docker compose version', options).status==0){
+        return 'docker compose';
+    }
+    return 'docker-compose'
+}

cmd/compose/ps.js

@@ -0,0 +1,11 @@
+const child = require('child_process')
+const oldOrNewCompose = require('./oldOrNewCompose')
+const options = { stdio: 'inherit' , shell: true}
+
+module.exports = {
+  command: 'ps',
+  describe: 'list containers',
+  handler: (argv) => {
+    child.spawnSync(oldOrNewCompose(), argv._.slice(1), options)
+  }
+}

cmd/compose/pull.js

@@ -0,0 +1,11 @@
+const child = require('child_process')
+const oldOrNewCompose = require('./oldOrNewCompose')
+const options = { stdio: 'inherit' , shell: true}
+
+module.exports = {
+  command: 'pull',
+  describe: 'update all docker images',
+  handler: (argv) => {
+    child.spawnSync(oldOrNewCompose(), ['pull'], options)
+  }
+}

cmd/compose/run.js

@@ -0,0 +1,18 @@
+const child = require('child_process')
+const oldOrNewCompose = require('./oldOrNewCompose')
+const env = require('../../lib/env')()
+const options = { stdio: 'inherit' , shell: true}
+
+function net_init() {
+  const net = `${env.COMPOSE_PROJECT_NAME}_default`
+  child.spawnSync('docker', ['network', 'create', net], { stdio: 'ignore' })
+}
+
+module.exports = {
+  command: 'run',
+  describe: 'execute a docker-compose run command',
+  handler: (argv) => {
+    net_init()
+    child.spawnSync(oldOrNewCompose(), ['run', '--rm', ...argv._.slice(2)], options)
+  }
+}

cmd/compose/top.js

@@ -0,0 +1,11 @@
+const child = require('child_process')
+const oldOrNewCompose = require('./oldOrNewCompose')
+const options = { stdio: 'inherit' , shell: true}
+
+module.exports = {
+  command: 'top',
+  describe: 'display the running processes of a container',
+  handler: (argv) => {
+    child.spawnSync(oldOrNewCompose(), argv._.slice(1), options)
+  }
+}

cmd/compose/up.js

@@ -0,0 +1,11 @@
+const child = require('child_process')
+const oldOrNewCompose = require('./oldOrNewCompose')
+const options = { stdio: 'inherit', shell:true }
+
+module.exports = {
+  command: 'up',
+  describe: 'start one or more docker compose service(s)',
+  handler: (argv) => {
+    child.spawnSync(oldOrNewCompose(), ['up', '-d', ...argv._.slice(2)], options)
+  }
+}