Find us on GitHub

SaaS

No credit card required

Self hosted

  1. Install addressr
    npm install @mountainpass/addressr -g
    NOTE: If you are running windows, you'll need to use wsl
  2. Start opensearch. For example run:
    docker pull opensearchproject/opensearch:1.2.4docker pull opensearchproject/opensearch:1.2.4
docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" -e "plugins.security.disabled=true" opensearchproject/opensearch:1.2.4
  3. Start API server. In a second window run:
    export ELASTIC_PORT=9200
export ELASTIC_HOST=localhost
addressr-server-2
  4. Setup the env vars for the data loader. In a third window run:
    export ELASTIC_PORT=9200
export ELASTIC_HOST=localhost
export ADDRESSR_INDEX_TIMEOUT=30s
export ADDRESSR_INDEX_BACKOFF=1000
export ADDRESSR_INDEX_BACKOFF_INCREMENT=1000
export ADDRESSR_INDEX_BACKOFF_MAX=10000
    1. Optional - enable geocodes by setting the following env vars for the data loader. NOTE: with geocodes enabled, indexing takes much longer and needs much more memory. Only use turn them on if you need them. You can always add them later.
    export ADDRESSR_ENABLE_GEO=1
export NODE_OPTIONS=--max_old_space_size=8196
    1. Optional - limit the addresses to a single state by setting the COVERED_STATES env var for the data loader. This dramatically speeds up indexing. For example:
    COVERED_STATES=VIC,SA
    Valid values are:
    • ACT
    • NSW
    • NT
    • OT
    • QLD
    • SA
    • TAS
    • VIC
    • WA
  5. Run data Loader
    addressr-loader
  6. OK, so we stretched the truth a bit with the "Quick Start" heading. The truth is that it takes quite a while to download, store and index the 13+ million addresses from data.gov.au. So make a coffee, or tea, or find something else to do and come back in about an hour when it's done.
  7. Search for an address
    curl -i http://localhost:8080/addresses?q=LEVEL+25,+TOWER+3
  8. An updated G-NAF is released every 3 months. Put addressr-loader in a cron job or similar to keep addressr regularly updated
  9. Wire you address form up to the address-server api.

How it Works

architectural diagram

System requirements

Open Search:

opensearch ≥ 1.2.4 with 1.4GiB of memory

Addressr Loader

Default

Node JS >= 12.11.0 with 1GiB of memory

With Geocoding enabled

Node JS >= 12.11.0 with 8GiB of memory

Addressr Server

Node JS >= 12.11.0 with 64MiB of memory