Docker

Run an XPLG product as a container, as a single node or with Docker Compose.

What you will do: run a node with Docker, persist its data, and connect it to dock.

Docker is the fastest path for evaluations and for small non-production deployments. For clusters, prefer Kubernetes (Helm).

Prerequisites

  • Docker Engine and, for multi-container setups, Docker Compose.
  • Host resources from Sizing and capacity planning.
  • A volume or host path for data; never keep data inside the container's writable layer.

Single node

  1. Pull the image:
docker pull <placeholder-image>:<placeholder-version>
  1. Run it with the console port published and data on a named volume:
docker run -d --name xplg-node \
  -p <placeholder-port>:<placeholder-port> \
  -v xplg-data:<placeholder-data-path> \
  -e <placeholder-env-var>=<placeholder-value> \
  <placeholder-image>:<placeholder-version>
  1. Follow the logs until the node reports ready, then open the console on the published port.

Docker Compose

Use Compose when a product needs more than one container, or when you want the configuration in a file:

services:
  xplg:
    image: <placeholder-image>:<placeholder-version>
    ports:
      - "<placeholder-port>:<placeholder-port>"
    volumes:
      - xplg-data:<placeholder-data-path>
    environment:
      <placeholder-env-var>: <placeholder-value>
volumes:
  xplg-data:
docker compose up -d

Connect to dock

Register the deployment from Deployments and paste the token in the console, as described in Register a deployment.

Operations

  • Logs: docker logs xplg-node.
  • Restart: docker restart xplg-node; data on the volume survives.
  • Upgrade: pull the new tag and recreate the container with the same volume; see Upgrades.
  • Backup: back up the volume while the node is stopped or using the product's export.

Next: Kubernetes (Helm)

Verify with XPLG engineering before publishing.