# Docker Compose Linter (`junipr/docker-compose-linter`) Actor

Lint Docker Compose YAML files for structure, service configuration issues, portability problems, risky defaults, missing health checks, unpinned images, exposed ports, volume concerns, and production-readiness warnings.

- **URL**: https://apify.com/junipr/docker-compose-linter.md
- **Developed by:** [junipr](https://apify.com/junipr) (community)
- **Categories:** SEO tools, E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $4.90 / 1,000 page auditeds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Docker Compose Linter

### Store Positioning

**Store title:** Docker Compose Linter

**Short description:** Lint Docker Compose YAML files for structure, service configuration issues, portability problems, risky defaults, missing health checks, unpinned images, exposed ports, volume concerns, and production-readiness warnings.

**SEO title:** Docker Compose Linter — technical SEO, web, and domain audit

**SEO description:** Lint Docker Compose YAML files for structure, service configuration issues, portability problems, risky defaults, missing health checks, unpinned images, exposed ports, volume concerns, and production-readiness warnings. Use it to find crawlability, indexability, security, metadata, and page-quality issues with evidence-backed rows and audit reports.

**Categories:** SEO\_TOOLS, ECOMMERCE

**Keywords:** docker, compose, linter, web/domain audit

### Pay-Per-Event Pricing

This actor uses pay-per-event pricing. Event prices include Apify platform usage; users are not expected to pay a separate platform-usage pass-through charge for the configured pricing model.

- Tier: W1 — Web/domain audit
- Primary event: `page-audited` at $0.00490 base
- Default max charge: $10.00
- Store discounts: FREE/BRONZE base, SILVER discounted, GOLD deepest approved discount

Event set:

- `actor-start`: base $0.00500, GOLD $0.00400. Docker Compose Linter: charged when actor start is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `page-audited`: base $0.00490, GOLD $0.00392. Docker Compose Linter: charged when page audited is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `record-extracted`: base $0.00372, GOLD $0.00298. Docker Compose Linter: charged when record extracted is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `finding-emitted`: base $0.00372, GOLD $0.00298. Docker Compose Linter: charged when finding emitted is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `audit-report-generated`: base $0.05000, GOLD $0.04000. Docker Compose Linter: charged when audit report generated is completed. The price includes Apify platform usage; no separate usage pass-through is intended.

The actor accepts `actor-start` before work, accepts the primary event before each dataset row, and accepts the configured report event before writing report files. If `maxChargeUsd` or the live PPE limit blocks a charge, the corresponding row or report is not written.

### Public Task Concepts

- Audit Docker Compose controls on a capped public sample
- Find high-priority Docker Compose issues before release
- Validate Docker Compose evidence from supplied pages
- Prioritize Docker Compose fixes with severity and proof
- Export Docker Compose QA rows for client review

Lint Docker Compose YAML files for structure, service configuration issues, portability problems, risky defaults, missing health checks, unpinned images, exposed ports, volume concerns, and production-readiness warnings.

### What it does

- Accept raw Compose YAML, public file URLs, repository file URLs, or uploaded file contents.
- Parse Compose files safely without running containers.
- Inspect services, images, ports, volumes, networks, environment variables, secrets, health checks, restart policies, depends-on usage, build contexts, profiles, and extension fields.
- Emit issue rows with severity, rule ID, YAML path, evidence, and recommendation.
- Generate service inventory and lint summary reports.
- Support strict, balanced, and advisory lint profiles.

### What it does not do

- No container execution, Docker daemon access, image vulnerability scanning, secret exfiltration, or deployment certification.
- No private repository access unless content is supplied.

### Input fields

Primary inputs from the locked actor spec: `composeFiles`, `composeUrls`, `repositoryFileUrls`, `lintProfile`, `enabledRules`, `disabledRules`, `treatWarningsAsFailures`, `includeServiceInventory`, `includePortInventory`, `includeVolumeInventory`, `maxFiles`, `timeoutMs`. `maxChargeUsd` keeps runs capped during production use.

### Output fields

Dataset rows include: `sourceId`, `sourceUrl`, `filePath`, `composeProjectName`, `serviceName`, `ruleId`, `issueCategory`, `severity`, `yamlPath`, `message`, `recommendation`, `evidence`, `lineNumber`, `lintProfile`, `passed`.

### Starter example

Use `examples/input.tiny.json` as a small starter input. Keep the first run capped and review the dataset before increasing limits.

### Public task examples

- Run Docker Compose Linter on supplied sample data: Run Docker Compose Linter on supplied sample data using a small bounded input.
- Generate a Docker Compose Linter QA report: Generate a Docker Compose Linter QA report using a small bounded input.
- Find invalid rows with Docker Compose Linter: Find invalid rows with Docker Compose Linter using a small bounded input.
- Create a capped local endpoint readiness check for Docker Compose Linter: Create a capped local endpoint readiness check for Docker Compose Linter using a small bounded input.
- Prepare Docker Compose Linter output for downstream automation: Prepare Docker Compose Linter output for downstream automation using a small bounded input.

### Public source provenance

The starter input audits Docker's public `awesome-compose` example at immutable commit `30f4b7f6a6c3b0c0ecf4d4efb0de203c48d11562`. Public tasks use five files from that same revision, so each result is traceable to a real upstream Compose configuration.

### Reports

- `docker-compose-lint-report.md`
- `compose-service-inventory.json`
- `compose-port-inventory.csv`
- `compose-volume-inventory.csv`
- `compose-lint-summary.json`

### Limitations and safe use

Start with supplied-input runs, then enable live endpoints only with tight caps, domain allowlists, and no secrets in public examples.

# Actor input Schema

## `composeFiles` (type: `array`):

Compose Files to inspect during the run.

## `composeUrls` (type: `array`):

Public compose URLs to fetch or inspect for Docker Compose Linter.

## `repositoryFileUrls` (type: `array`):

Public repository file URLs to fetch or inspect for Docker Compose Linter.

## `lintProfile` (type: `string`):

Lint Profile controls Docker Compose Linter processing for the supplied inputs; keep values conservative for first runs.

## `enabledRules` (type: `array`):

Rules used by Docker Compose Linter to classify findings and recommendations.

## `disabledRules` (type: `array`):

Rules used by Docker Compose Linter to classify findings and recommendations.

## `treatWarningsAsFailures` (type: `boolean`):

Treat Warnings As Failures controls Docker Compose Linter processing for the supplied inputs; keep values conservative for first runs.

## `includeServiceInventory` (type: `boolean`):

Include service inventory in output rows or reports when available.

## `includePortInventory` (type: `boolean`):

Include port inventory in output rows or reports when available.

## `includeVolumeInventory` (type: `boolean`):

Include volume inventory in output rows or reports when available.

## `maxFiles` (type: `number`):

Maximum files to process in one run; keep defaults low for safe first runs.

## `timeoutMs` (type: `number`):

Maximum time in milliseconds allowed for the Docker Compose Linter operation before it is treated as timed out.

## `maxChargeUsd` (type: `number`):

Maximum estimated PPE charge allowed for the run before the actor stops gracefully.

## Actor input object example

```json
{
  "composeFiles": [],
  "composeUrls": [
    "https://raw.githubusercontent.com/docker/awesome-compose/30f4b7f6a6c3b0c0ecf4d4efb0de203c48d11562/nginx-flask-mysql/compose.yaml"
  ],
  "repositoryFileUrls": [],
  "lintProfile": "strict",
  "enabledRules": [],
  "disabledRules": [],
  "treatWarningsAsFailures": false,
  "includeServiceInventory": true,
  "includePortInventory": true,
  "includeVolumeInventory": true,
  "maxFiles": 1,
  "timeoutMs": 10000,
  "maxChargeUsd": 1
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("junipr/docker-compose-linter").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("junipr/docker-compose-linter").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call junipr/docker-compose-linter --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,junipr/docker-compose-linter"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/gDDD0X23CCws0tCXk/builds/F6kzcjNS1Pgz0w2lg/openapi.json