A build of the Addressr service by Mountain Pass, with an embedded OpenSearch server.
  • Shell 72%
  • Dockerfile 28%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Ben Thomson 1ede0a465e
All checks were successful
Release / Release (push) Successful in 21s
feat!: Update README
BREAKING CHANGE: Try and trigger a major release, since the previous
commit did not.
2026-08-31 09:52:08 +08:00
.forgejo/workflows fix: Use repo release token 2026-06-30 15:41:26 +08:00
config/opensearch Initial commit 2026-06-30 15:00:46 +08:00
.gitignore Initial commit 2026-06-30 15:00:46 +08:00
.releaserc.json feat: Initial release 2026-06-30 15:26:12 +08:00
docker-entrypoint.sh Initial commit 2026-06-30 15:00:46 +08:00
Dockerfile feat!: Update Addressr and Opensearch 2026-08-31 09:47:20 +08:00
LICENSE Initial commit 2026-06-30 15:00:46 +08:00
README.md feat!: Update README 2026-08-31 09:52:08 +08:00

Addressr Standalone Image

A Docker build of the Addressr v3 service by Mountain Pass, with an embedded and pre-configured OpenSearch server, to enable this to be run as a single container.

Getting started

The Addressr service contained in this image runs on port 8080. OpenSearch is only accessible within the container and is not exposed to the host machine. Your only requirements to run this image are:

  • Publish port 8080, and
  • Mount a volume to /opt/opensearch/data to persist the OpenSearch database.

A custom entrypoint has been created to load the address information or run the server. To load the address information, run the following command:

docker run -it -v address-data:/opt/opensearch/data source.selfmanager.net.au/manageitpub/address-standalone:latest load

Per the Addressr Quick Start, this will download the G-NAF address data from the Australian Government Data Registry, and will populate the information into the OpenSearch database. You may optionally define a sub-set of states/territories to load by providing a comma-separated list in the COVERED_STATES environment variable. States/territories can be specified as follows:

  • ACT = Australian Capital Territory
  • NSW = New South Wales
  • NT = Northern Territory
  • OT = Other Territories
  • QLD = Queensland
  • SA = South Australia
  • TAS = Tasmania
  • VIC = Victoria
  • WA = Western Australia`

For example, if you only wanted to load addresses for New South Wales and Victoria, you would run the following command:

docker run -it -v address-data:/opt/opensearch/data -e COVERED_STATES=NSW,VIC source.selfmanager.net.au/manageitpub/address-standalone:latest load

Running the server

Once your server is populated with address data, you can run the server with the following command:

docker run -it -p 8080:8080 -v address-data:/opt/opensearch/data source.selfmanager.net.au/manageitpub/address-standalone:latest server

Disclaimer

This project is not affiliated with, or endorsed by, Mountain Pass.