Dockman - The Missing Docker Dashboard 🐳

A powerful Docker management tool designed for DevOps teams.

🚀 Features

Terminal UI (TUI)

• Real-time container monitoring
• CPU, Memory, and Network stats
• Interactive container management
• Log streaming
• Quick actions (stop, restart, exec)

CLI Commands

• Container management
• Bulk operations
• System pruning
• Health checks
• Log aggregation

Web Dashboard

• Real-time metrics
• Resource usage graphs
• Container logs
• Network mapping
• Volume management

📦 Installation

Using NPM

npm install -g dockman-cli

Using Docker

docker run -d \
  --name dockman \
  -p 3000:3000 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v dockman-data:/app/data \
  yourusername/dockman

From Source

git clone https://github.com/Refaellevi20/dockman.git
cd dockman
npm install
npm link

🛠️ Usage

TUI Mode

# Launch TUI
dockman-tui

# Navigation:
# ↑/↓    - Select container
# Enter  - Show details
# s      - Stop container
# r      - Restart container
# l      - View logs
# q      - Quit

CLI Mode

# List containers
dockman ls

# Stop specific container
dockman stop <container-id>

# Restart all web containers
dockman bulk -r --filter web

# View container logs
dockman logs <container-id>

# Show container stats
dockman stats <container-id>

# Prune system
dockman prune

Web Dashboard

Open http://localhost:3000 in your browser

🔧 Configuration

Environment Variables

DOCKMAN_PORT=3000          # Web dashboard port
DOCKMAN_LOG_LEVEL=info     # Logging level
DOCKMAN_REFRESH_RATE=2000  # Stats refresh rate (ms)
DOCKMAN_DATA_DIR=/app/data # Data directory

Config File (optional)

Create ~/.dockman/config.json:

{
  "defaultView": "tui",
  "containerColors": {
    "running": "green",
    "stopped": "red"
  },
  "notifications": {
    "slack": "webhook_url",
    "email": "[email protected]"
  }
}

🔍 Monitoring & Alerts

Metrics Available

• Container CPU usage
• Memory consumption
• Network I/O
• Disk usage
• Container health status
• Custom healthchecks

Alert Channels

• Slack
• Email
• Webhook
• Custom scripts

🔒 Security

Requirements

• Docker socket access
• Node.js 14+
• Optional: Docker Compose

Best Practices

• Use read-only Docker socket when possible
• Configure proper user permissions
• Enable TLS for web dashboard
• Regular security updates

🤝 Contributing

Development Setup

# Clone repository
git clone https://github.com/Refaellevi20/dockman.git

# Install dependencies
cd dockman
npm install

# Run tests
npm test

# Start development server
npm run dev

Running Tests

# Run all tests
npm test

# Run with coverage
npm run test:coverage

# Run specific test
npm test -- docker.test.js

📚 Documentation

Full documentation available at: https://dockman.readthedocs.io

API Reference

• REST API: http://localhost:3000/api/docs
• WebSocket Events: ws://localhost:3000/events

🆘 Support

• GitHub Issues: https://github.com/Refaellevi20/dockman/issues
• Documentation: https://dockman.readthedocs.io
• Discord: https://discord.gg/dockman
• Email: [email protected]

📜 License

MIT License - see LICENSE file for details