Skip to content

Download Application

You can download the application for your specific operating system by clicking on the appropriate button below.

Downloads

  • Download for Mac
  • Right-click the PKG and select Open (to bypass macOS quarantine, see Apple documentation).
  • If the app installs to/Users/runner/work/nui/nui/build/bin/nui-app.app, move it to your Applications folder.

Releases

Check the complete releases list accessing the Github Releases page.

Deploying with Docker

If you prefer to deploy the application using Docker, you can do so by following the steps below.

  1. Pull the Docker image from the Hub

    docker pull ghcr.io/nats-nui/nui:latest

    docker pull ghcr.io/nats-nui/nui:edge

  2. Run the Docker image, mapping the necessary volumes:

    docker run -p 31311:31311 -v /<database-path>:/db -v /<nats-credentials-path>:/nats-creds:ro ghcr.io/nats-nui/nui

Needed volumes:

  • -v /path/to/your/database:/db to persist the db folder used by nui.

Optional volumes:

  • -v /path/to/your/nats/credentials.creds:/nats-creds:ro (needed only if you use creds / jwt authentication) to map your local directory with creds files to container one in read-only.
  • -v /path/to/your/nats-cli/contexts:/nats-cli-contexts:ro to map local cli contexts inside NUI. Is then possible (with --nats-cli-contexts=/nats-cli-contexts entrypoint flag) to auto import the contexts in NUI at startup.

Please note that if you are using creds authentication or manually import contexts in dockerized container, from the UI you should add the paths relative to the container filesystem, not your host one (eg /nats-creds.creds, /nats-cli-contexts)

Deploying on K8S (Experimental)

An Helm chart is provided to deploy NUI on K8S. To install a release:

helm repo add nats-nui https://nats-nui.github.io/k8s/helm/charts
helm install nats-nui/nui
Refer the nats-nui/k8s Github repository for values customization

To deploy NUI on K8S refer the related repo with istructions