Getting started

This section takes you from nothing to a broker on your machine that answers requests. Andromeda is one program, andromeda, and all it needs beside it is a PostgreSQL server with PostGIS and TimescaleDB.

You can install it in two ways. Docker runs the broker and its PostgreSQL server together from published images, and it is the one to pick unless you plan to change the code. Building from source is for working on Andromeda itself.

Setting it up for real use?

Answer a few questions about your deployment, and the planner writes andromeda.toml, a Compose file, the proxy and PostgreSQL settings, and the steps to run them.

Open the deployment planner→

With the broker running, the Quickstart creates an entity, reads it back, queries and updates it, and gets a first notification. It also shows how to use your own vocabulary and how to work in a tenant. If a build or a first run fails, Troubleshooting lists the usual causes and links to the page that covers each one.

What to expect

The NGSI-LD API listens on port 1056, under /ngsi-ld/v1. On the same port, GET /ngsi-ld/v1/health gives a health report for the broker and its database. The liveness and readiness probes and the Prometheus metrics have a separate management port, 1086, which the Compose file doesn't publish. Monitoring covers them.

Andromeda refuses anything the specification doesn't allow, and the error says why. A client used to a more lenient broker will see 400 responses at first. Strictness explains the rules, and Common refusals lists the ones people meet first.

Licence

Andromeda is licensed under the European Union Public Licence v. 1.2 (EUPL-1.2).