razvanbotea/nexxus-api repository overview

⁠nexxus-docker

These are base images meant to be extended. A deployment builds FROM a base image, supplies its own config, adds any custom adapters, and sets the env vars its config needs.

Image tags track nexxus-api⁠ releases (see Docker Hub tags⁠).

⁠What the API image contains

• Node 24 (Alpine), the compiled nexxus-api server + its production dependencies.
• The built-in adapters (WinstonNexxusLogger, NexxusElasticsearchDb, NexxusRabbitMq).
• Runs as a non-root user (nexxus, uid/gid 1001) under tini as PID 1.

It ships no config — starting it without one is a deliberate, fatal error. You provide the config; the server reads it from $NXX_CONF_PATH.

Backing services required at runtime: Elasticsearch, RabbitMQ, and Redis must be reachable at the hosts named in your config.

⁠Quick start

⁠Option A — bind-mount a config

docker run --rm -p 5000:5000 \
  -v "$PWD/api.conf.json:/etc/nexxus/api.conf.json:ro" \
  razvanbotea/nexxus-api:0.0.4

⁠Option B — build a deployment image

Bake your config (and any custom adapters) into your own image on top of the base. See example.Dockerfile⁠ for a complete, commented template:

FROM razvanbotea/nexxus-api:0.0.4

# 1. Provide the config at the path the server reads
COPY --chown=nexxus:nexxus api.conf.json /etc/nexxus/api.conf.json

# 2. (optional) add custom adapters, then reference them in the config
# RUN npm install @myorg/nexxus-postgres-adapter

# 3. (optional) tune the runtime
# ENV NODE_OPTIONS=--max-old-space-size=768

docker build -t my-nexxus-api .
docker run --rm -p 5000:5000 my-nexxus-api

A starter config is in example.conf.json⁠; the full config reference lives in the nexxus-api README⁠.

⁠Configuration

⁠Environment variables

⁠Custom adapters

Logger / database / message-queue adapters are chosen in the config's app section. Built-ins resolve by class name; custom adapters are npm packages npm installed into the image and referenced by package name:

{ "app": { "logger": "@myorg/nexxus-datadog-logger" } }

⁠A note on the port

EXPOSE is metadata only — the actual listen port comes from app.port in the config (default 5000). Publish the port that matches your config: -p <host>:<app.port>.

⁠Building the base image yourself

docker build -t nexxus-api ./api

Build args (--build-arg):

The Node version and the nexxus-api release are intentionally fixed in the Dockerfile (not build args) — they move on a release basis.

⁠License

MPL-2.0⁠