Docker Run

This guide covers using basic docker run commands to run the Sombra server. This is not recommended for production environments, as docker run commands lack automatic container restart capabilities if connections are lost, memory issues occur, or other failures happen.

We recommend using this approach for testing and evaluation only. For production deployments, refer to the Helm deployment option.

Please see Step 1 of the quickstart guide for instructions on accessing the Sombra Docker image.

Please see Step 2 of the quickstart guide for instructions on registering a new Sombra cluster.

Use the following docker run command to deploy Sombra:

# Values from the copyable snippet from Step 2
SOMBRA_ID=xxx
SOMBRA_REVERSE_TUNNEL_API_KEY=zzz
ORGANIZATION_URI=nnn
TRANSCEND_URL=https://api.transcend.io

# Generate a JWT key for this container instance
# If you are hosting multiple container instances, make sure you use the same key across all container instances
JWT_ECDSA_KEY=$(openssl ecparam -genkey -name secp384r1 -noout | (base64 --wrap=0 2>/dev/null || base64 -b 0))

# Use one of these options depending on your authentication method from Step 1
DOCKER_IMAGE=829095311197.dkr.ecr.eu-west-1.amazonaws.com/sombra:latest
# DOCKER_IMAGE=docker.transcend.io/sombra:latest

docker run \
  -e TRANSCEND_URL="$TRANSCEND_URL" \
  -e SOMBRA_ID="$SOMBRA_ID" \
  -e JWT_ECDSA_KEY="$JWT_ECDSA_KEY" \
  -e SOMBRA_REVERSE_TUNNEL_API_KEY="$SOMBRA_REVERSE_TUNNEL_API_KEY" \
  -e ORGANIZATION_URI="$ORGANIZATION_URI" \
  "$DOCKER_IMAGE"

After the container has been running for a minute or so, look for a log message containing Successfully synced configuration with transcend backend. This confirms that:

  1. Your Sombra cluster can communicate with the Transcend backend
  2. Your API key is valid
  3. The Transcend backend can communicate with your Sombra cluster

Go to the Sombra Gateways page in the Transcend Admin Dashboard and use the "Test Gateway Connection" button to verify connectivity.