Check against your doze

NATS

Bring your ownNot signed by doze

Messaging and streams. doze runs your NATS: the nats-server you installed, the nats container, or an archive you pin.

doze add nats · port 4222

Not a module: doze runs your NATS. There is no doze/nats in the registry. doze add nats writes a service block, takes the first way that works on your machine, and names the other two.

Three ways to run it, and the block each writes

Installed

first choice

$ doze add nats --as installed

Runs the nats-server on your PATH. If there is none: nats-server is not on your PATH: install it, or use --as container or --as download

doze.hcl

service "nats" {
  run  = "nats-server -a $HOST -p $PORT -sd $DATA"
  port = 4222
}

Container

if nats-server isn't installed

$ doze add nats --as container

A container is just a command that stays in the foreground. Needs Docker or a compatible runtime.

doze.hcl

service "nats" {
  # a container: a container is just a command, and `run` stays in the foreground
  run  = "docker run --rm -p $HOST:$PORT:4222 nats"
  port = 4222
}

Download

pinned by sha256

$ doze add nats --as download

You fill in the archive URL and the real run line; doze fetches it once and pins its checksum in doze.lock.

doze.hcl: fill in download and run

service "nats" {
  # fetched once, pinned in doze.lock by its checksum, and run from the archive
  download = "https://example.com/nats-darwin-arm64.tar.gz" # fill this in
  run      = "./nats --port $PORT"
  port     = 4222
}

terminal: plain doze add, on a machine without nats-server

$ doze add nats
→ nats is not a doze module — adding it as a service
  nats-server is not installed — the block runs it as a container
  other ways: --as installed · --as container · --as download

  use it from an app:  NATS_ADDR = service.nats.address

$HOST, $PORT and $DATA are filled in at run time.

What doze still gives it

A name: nats.<stack>.doze, and your own domain over https if you set one.
A port, held by doze while nats-server is asleep.
Sleep and wake: it wakes when a client connects and sleeps when nothing has for a while. Data stays in $DATA.
Logs in doze logs nats and in the app, next to everything else.

What it doesn't

No signature. doze didn't build nats-server or the image, so it doesn't sign them. A download is pinned by sha256 in doze.lock: a changed file is refused, but nobody vouched for the first one.
No pinned version for installed or container. You get whatever nats-server is on the PATH, or whatever nats points at today.
No declared databases or users. A module converges those from doze.hcl; a service is just a process.

The other tools doze add knows

Each gets the same three ways where it can. rabbitmq, opensearch and clickhouse have no known run line, so installed falls back to the container.

Name	What it is	Runs from	Port
mongo	The document database	mongod · mongo:7	27017
mailpit	Catches outgoing email; web inbox on the next port	mailpit · axllent/mailpit	1025
minio	S3-compatible object storage (doze AWS has S3 too)	minio · minio/minio	9000
meilisearch	Typo-tolerant search engine	meilisearch · getmeili/meilisearch	7700
memcached	The classic in-memory cache	memcached · memcached	11211
rabbitmq	AMQP message broker	container rabbitmq:3	5672
opensearch	Search and log analytics	container opensearchproject/opensearch	9200
clickhouse	Column-store analytics database	container clickhouse/clickhouse-server	8123

Anything else: doze add <name> writes a download block to fill in. What that looks like