Skip to main content

Docker

Run FUME locally with Docker. Community runs from the published Docker Hub image. Enterprise usually starts from Outburn-provided private Docker Hub images, with Designer commonly running alongside the server.

Enterprise includes all Community behavior.

Community​

Prerequisites​

  • Docker Desktop (or Docker Engine) with Compose support

FUME Community runs from the published Docker image outburnltd/fume-fhir-converter.

Before you start:

  • Docker Desktop is the app that lets containers run on your computer.
  • Docker Compose is the small compose.yaml file that tells Docker which image to run and which port and settings to use.
  • .env is a plain text settings file. For a first run, you can use the starter file below exactly as written.

Run​

  1. Install Docker Desktop if you do not already have it, then open it and make sure it is running.
  2. Create a new local folder for FUME Community anywhere you like.
  3. In that folder, create a file named compose.yaml with this content:
services:
  fume:
    image: outburnltd/fume-fhir-converter:latest
    ports:
      - "42420:42420"
    env_file:
      - .env
  1. In the same folder, create a file named .env with this content:
# Optional Community runtime settings go here.
# You can leave this file as-is for your first run.
  1. Open a terminal in that folder and run:
docker compose up -d
  1. Open http://localhost:42420/health in your browser to confirm the server is running.

What success looks like​

  • http://localhost:42420/health returns a successful response.
  • The server is available at http://localhost:42420.

Configure​

If you need to change ports or add runtime settings later, update the .env file in your folder and refer to Community runtime settings.

Common next actions​

  • View logs: docker compose logs -f
  • Stop the server: docker compose down
  • Start it again later: docker compose up -d
  • Update to the newest latest image: docker compose pull then docker compose up -d

Enterprise​

Prerequisites​

  • Docker Desktop (or Docker Engine) with Compose support
  • A valid Enterprise license file (*.lic)
  • A Docker Hub API token with access to the private FUME images

Enterprise usually runs from the private server image, with Designer as the optional browser UI that most teams run alongside it.

Before you start:

  • Docker Desktop or Docker Engine provides the runtime that actually runs the containers.
  • Docker Compose is the compose.yaml file that starts the server and Designer together.
  • .env is the simplest way to keep runtime settings in the same folder as your Docker deployment.
  • If you already manage environment variables centrally, you can provide the same values as real environment variables instead of using .env.
  • The same Docker Hub token can pull both private images, and the same .lic file can be used by both containers.

Run​

This is the common local Docker layout for private deployments: keep compose.yaml, .env, and one shared .lic file together in the same folder.

  1. Create a new local folder anywhere you like for the Enterprise deployment.
  2. Save the Outburn-provided license file into that folder. One .lic file can be shared by both the server and Designer.
  3. Open a terminal in that folder and sign in to Docker Hub with the shared token you received from Outburn:
docker login --username outburnltd
  1. In that folder, create a file named compose.yaml with this content:
services:
  server:
    image: outburnltd/fume-enterprise-server:latest
    ports:
      - "42420:42420"
    env_file:
      - .env
    volumes:
      - ./${FUME_LICENSE}:/usr/fume/FUME_Enterprise.lic:ro

  designer:
    image: outburnltd/fume-designer:latest
    ports:
      - "3000:3000"
    env_file:
      - .env
    volumes:
      - ./${FUME_LICENSE}:/usr/fume-designer/FUME_Enterprise.lic:ro
  1. In the same folder, create a file named .env with this content:
# Keep this file next to compose.yaml for a simple folder-based setup.
# If you already manage environment variables elsewhere, provide the same values there instead.

FUME_LICENSE=FUME_Enterprise.lic

# For remote-browser use, replace localhost with a host name or IP that the browser can reach.
FUME_SERVER_URL=http://localhost:42420
  1. Start both services:
docker compose up -d
  1. Verify that the API and Designer are both reachable:
  • Open http://localhost:42420/health to confirm the server is responding.
  • Open http://localhost:3000 to confirm the Designer loads in the browser.

What success looks like​

  • http://localhost:42420 responds and http://localhost:42420/health returns a successful response.
  • http://localhost:3000 opens the Designer.
  • The Designer should point at the same server URL that you set in .env.

Configure​

Common next actions​

  • docker compose logs -f
  • docker compose down
  • docker compose up -d
  • docker compose pull then docker compose up -d

Kubernetes​

If you plan to run Enterprise on Kubernetes, use the FUME Helm chart rather than hand-writing Kubernetes manifests from the Docker example above. The chart already covers the normal private-image deployment pattern: private Docker Hub images, one pull secret, and one shared license secret mounted into both services.