Skip to main content

Installation

Premora installs as a single self-contained box: one container image (the omnibus) plus its sidecars, run with Docker Compose. Installing is two steps — get the premora CLI, then use it to install Premora. The only host prerequisite is Docker; see Requirements.

1. Get the installer​

The premora CLI is a single self-contained binary (no Node.js or package manager required). Install it from the Premora distribution server:

curl -fsSL https://dist.premora.dev/install.sh | sh

This detects your OS/architecture, downloads the binary, verifies its checksum, and installs it to /usr/local/bin/premora. Then confirm your host is ready:

premora doctor          # checks Docker + Docker Compose are present

:::note No public package managers The installer is served from Premora's own distribution server, not npm or a public registry — the same trust boundary as your license. For air-gapped sites, copy the premora binary for your platform from the offline media instead of running the bootstrap. :::

2. Install your license​

You receive a signed license key from Premora. Save it so the CLI (and the running system) can use it:

premora license install ./premora-license.key
premora license show        # confirm customer, tier, and expiry

3. Install Premora​

premora core install --license ./premora-license.key

The CLI downloads the license-gated install bundle from the distribution server, loads the omnibus image, and brings the stack up with docker compose up -d. When it finishes:

  • API gateway (the API): http://localhost:8080
  • Web client: http://localhost:4102

Air-gapped install​

No outbound internet — install from offline media (USB). The bundle already contains the image:

premora core install --offline-media /mnt/usb/premora-offline --license ./premora-license.key

On-prem registry / custom distribution host​

Point the CLI at an internal mirror of the distribution server:

premora core install --catalog https://premora.internal.example.com --license ./premora-license.key
# or set PREMORA_DIST_URL=https://premora.internal.example.com

4. Verify the install​

cd ~/.premora/install        # the unpacked bundle
docker compose ps            # every service Up; the one-shot "migrate" exited 0
curl -fsS http://localhost:8080/health

Then open the web client at http://localhost:4102 and continue to First run.

Equivalent direct bundle flow​

premora core install wraps a bundle you can also run by hand:

tar -xzf premora-install-<version>.tar.gz
cd premora-install-<version>
cp .env.example .env         # fill in PREMORA_LICENSE_TOKEN + any overrides
./up.sh                      # docker load images/*.tar  +  docker compose up -d

./down.sh stops it; ./upgrade.sh applies a newer bundle.

Adding connectors​

Connectors are licensed à la carte and install without reinstalling Premora:

premora connector list                 # what's available + entitled for your license
premora connector install confluence   # license- and compatibility-gated

Restart the stack (./up.sh, or docker compose up -d in the install dir) to activate a newly installed connector. See the integration catalog.

Upgrades & support​

premora update                # pull + apply a newer build (license-gated)
premora core upgrade --license ./premora-license.key
premora support collect       # gather a diagnostics bundle for support

See Upgrades & support.