Skip to content
Skills Library
DevOps & cloud · Automation

cmf-server

/cmf-server

Use when deploying the CMF Server locally with Docker Compose, or connecting to an existing shared CMF Server. Covers creating the .env file, starting the container stack, verifying the web UI, and pointing cmflib clients at the server. If a server is already running and credentials are available, skip to the connection section.

Repository
cmf ↗
Licence
Apache-2.0
Last repository change
15.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
3
Scripts
0
HTML comments
0
URLs in SKILL.md
13
Deprecation

No signals detected. Repository changed on 15.10.2026, without references to retired models or APIs.

Licence

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

What it does and when to use it

Use when deploying the CMF Server locally with Docker Compose, or connecting to an existing shared CMF Server. Covers creating the .env file, starting the container stack, verifying the web UI, and pointing cmflib clients at the server. If a server is already running and credentials are available, skip to the connection section.

Original author description

Use when deploying the CMF Server locally with Docker Compose, or connecting to an existing shared CMF Server. Covers creating the .env file, starting the container stack, verifying the web UI, and pointing cmflib clients at the server. If a server is already running and credentials are available, skip to the connection section.

How it works

  1. Local deployment
  2. Connecting to an existing CMF Server
  3. Manage the server
  4. Upgrade
  5. Troubleshooting
Original SKILL.md headings · 114 lines, 425 words
SKILL.md preview
---
name: cmf-server
description: >
  Use when deploying the CMF Server locally with Docker Compose, or connecting to an
  existing shared CMF Server. Covers creating the .env file, starting the container
  stack, verifying the web UI, and pointing cmflib clients at the server. If a server
  is already running and credentials are available, skip to the connection section.
version: 1.0.0
---

First check: **is a CMF Server already running?** If yes, skip to [Connecting to an existing server](#connecting-to-an-existing-cmf-server).

## Local deployment

### Prerequisites
- Docker Engine + Docker Compose plugin
- Host IP or hostname (for `REACT_APP_CMF_API_URL`)
- Ports 80 and 443 free (configurable)

### Step 1 — Clone CMF

```bash
git clone https://github.com/HewlettPackard/cmf
cd cmf
```

### Step 2 — Create `.env`

```env
CMF_DATA_DIR=./data
NGINX_HTTP_PORT=80
NGINX_HTTPS_PORT=443
REACT_APP_CMF_API_URL=http://<your-server-ip>:80

POSTGRES_USER=myuser
POSTGRES_PASSWORD=mypassword    # change in production
POSTGRES_DB=mlmd
POSTGRES_HOST=postgres
POSTGRES_PORT=5432

MCP_EXTERNAL_PORT=8382
```

See [references/env-variables.md](references/env-variables.md) for full variable descriptions and common customizations.

### Step 3 — Start

```bash
docker compose -f docker-compose-server.yml up -d
docker compose -f docker-compose-server.yml ps   # all services should be healthy within ~60s
```

Services started: `postgres`, `server` (CMF API), `ui` (React), `tensorboard`, `nginx`, `mcp`.

### Step 4 — Verify

```bash
curl http://<your-server-ip>:80/apiv1.0/pipelines
# {"pipelines": []}
```

Open `http://<your-server-ip>:80` in a browser — CMF web UI should load.

### Step 5 — Point clients at the server

On each client machine:
```bash
cmf init local \
  --path /path/to/artifact-storage \
  --git-remote-url https://github.com/your-org/your-repo.git \
  --cmf-server-url http://<your-server-ip>:80
```

---

## Connecting to an existing CMF Server

```bash
cmf init local \
  --path /path/to/artifact-storage \
  --git-remote-url https://github.com/your-org/your-repo.git \
  --cmf-server-url http://<server-url>:<port>

cmf init show                       # verify the URL is set
cmf metadata pull -p my_pipeline    # confirm access
```

The CMF Server uses network-level access control (no built-in username/password by default). If your deployment has an auth proxy, ask the administrator for credentials.

---

## Manage the server

```bash
docker compose -f docker-compose-server.yml stop    # stop (data preserved)
docker compose -f docker-compose-server.yml start   # restart
docker compose -f docker-compose-server.yml down    # remove containers (data preserved in CMF_DATA_DIR)

# Destructive — backup CMF_DATA_DIR first!
docker compose -f docker-compose-server.yml down -v && rm -rf ./data
```

## Upgrade

```bash
git pull
docker compose -f docker-compose-server.yml build --no-cache
docker compose -f docker-compose-server.yml up -d
```

## Troubleshooting

- **`REACT_APP_CMF_API_URL` not set** — required; set to the host's IP/hostname
- **Port 80 in use** — change `NGINX_HTTP_PORT` and update `REACT_APP_CMF_API_URL` to match
- **`postgres` not healthy** — check `docker compose -f docker-compose-server.yml logs postgres`; usually a `CMF_DATA_DIR` permissions issue
- **UI loads but API calls fail** — use the host IP, not `localhost`, in `REACT_APP_CMF_API_URL`; must be reachable from the browser
- **MCP server not reachable** — check `MCP_EXTERNAL_PORT` in `.env` and confirm it is not blocked by a firewall; test with `curl http://<server-ip>:<MCP_EXTERNAL_PORT>/health`
- **Clients cannot push metadata** — confirm `cmf init show` shows the correct server URL; verify with `curl http://<server-ip>:80/apiv1.0/pipelines`

---

**Docs:** [Installation Guide](https://hewlettpackard.github.io/cmf/setup/) · [CMF Client Guide](https://hewlettpackard.github.io/cmf/cmf_client/) · [Web UI Reference](https://hewlettpackard.github.io/cmf/ui/lineage/)
Files in this package (3)
  • SKILL.md 4 KB
  • sources.md 1 KB
  • references/env-variables.md 2 KB

Versions

The database has no other skills named cmf-server.

Database snapshot: 13.11.2026 · package version aa258ead4514 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100cmf
    Use when working with the Common Metadata Framework (CMF) — initializing CMF in a project, instrumenting ML pipeline code, syncing metadata and artifacts with a CMF Server, querying lineage and artifacts, or setting up the CMF MCP server for AI assistant integration. Routes to…
  • 100cmf-mcp
    Use when setting up the CMF MCP server so an AI coding assistant can query CMF metadata using natural language, or when the CMF MCP server is already running and the user wants to use it from their coding agent. Covers Docker deployment, per-agent configuration (Claude Code,…
  • 90deploy-docker-compose
    Run the Omnigent server as a Docker compose stack (server + Postgres) on any Docker host — your laptop, a VPS, EC2 by hand, or as the base layer of any container-platform deploy. Invoke when the user wants to build the image, bring up the compose stack, debug the stack on a host…
  • 100generating-docker-compose-files
    Execute use when you need to work with Docker Compose. This skill provides Docker Compose file generation with comprehensive guidance and automation. Trigger with phrases like "generate docker-compose", "create compose file", or "configure multi-container app".
  • 100generating-docker-compose-files
    Execute use when you need to work with Docker Compose. This skill provides Docker Compose file generation with comprehensive guidance and automation. Trigger with phrases like "generate docker-compose", "create compose file", or "configure multi-container app".
  • 100run-mcp-local
    Run the FutureSearch HTTP MCP server locally with Docker Compose and optionally expose it via Cloudflare tunnel. Use when starting/stopping the local MCP server, debugging startup issues, connecting Claude.ai or Claude Desktop to a local instance, or checking server logs.…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.