🚀 docker-success-status

A lightweight, zero-dependency status dashboard for Docker containers. It allows you to track build steps (Build, Test, Lint) and visualize results in a simple web UI.

✨ Features

• ⚡ Zero dependencies — pure Node.js, no heavy installs
• 📊 Pipeline history — logs build/test steps
• ❌ Error tracking — highlights failed steps
• 🌍 Client-side time localization
• 🐳 Docker-friendly — supports graceful shutdown (SIGTERM, SIGINT)
• 🔌 Simple CLI interface

📦 Installation

Global install

npm install -g docker-success-status

Or use with npx

npx docker-success-status

🚀 Quick Start

Run the server:

docker-success-status

Open in browser:

http://localhost:3000

🐳 Usage in Docker

Example Dockerfile:

FROM node:20-slim

WORKDIR /app

# Install package
RUN npm install -g docker-success-status

# Build step (log success)
RUN npm run build && docker-success-status --log "Build: Success"

# Test step (log failure and stop build)
RUN npm test || (docker-success-status --error "Tests: Failed" && exit 1)

# Start dashboard
EXPOSE 3000
CMD ["docker-success-status"]

⚙️ CLI Usage

Log success

docker-success-status --log "Build completed"

Log error

docker-success-status --error "Tests failed"

Start server

docker-success-status

🔧 Configuration

Environment Variables

| Variable | Description | Default | | ------------- | --------------------------- | --------------------------------- | | PORT | Web server port | 3000 | | STATUS_FILE | Path to status history file | /tmp/docker-status-history.json |

🧠 How It Works

1. Logging phase (during docker build)

Each command:

docker-success-status --log "Step name"

writes a record into a JSON file.

2. Serving phase (container runtime)

When container starts:

docker-success-status

• reads stored logs
• launches HTTP server
• renders status dashboard

3. UI behavior

• timestamps are converted to your local timezone
• failed steps are highlighted
• data persists inside container lifecycle

🔍 Health Check

curl http://localhost:3000/health

Response:

{
  "status": "running",
  "steps": [
    { "message": "Build: Success", "type": "success", "timestamp": "..." }
  ]
}

🧪 Local Testing

docker-success-status --log "Build: Success"
docker-success-status --error "Tests: Failed"
docker-success-status

📌 Use Cases

• Docker build pipelines
• CI/CD visualization
• Local development debugging
• Lightweight status dashboards

📄 License

MIT