Skip to content

Repository files navigation

Docker Port Tracker

A real-time Docker monitoring application that displays host network information, container port mappings, and Docker networks in a clean web interface.

Features

  • 🖥️ Host Information: View host IP addresses and ports in use
  • 🐳 Container Monitoring: See all running containers with their port mappings
  • 🌐 Network Visualization: Display Docker networks with connected containers
  • 🔄 Auto-Refresh: Updates every 5 seconds automatically
  • 📱 Responsive Design: Works on desktop and mobile devices

Quick Start

Standard Docker Compose

# Start the application
docker-compose up -d

# Access the web interface
open http://localhost:8081

# View logs
docker-compose logs -f

# Stop the application
docker-compose down

Unraid Server

See the Unraid Quick Start Guide or Full Unraid Installation Guide for Unraid-specific instructions.

TL;DR for Unraid:

  1. Copy project to /mnt/user/appdata/PortTracker/
  2. Build images or use Compose Manager
  3. Access at http://your-unraid-ip:3000

Requirements

  • Docker Engine 20.10 or higher
  • Docker Compose 2.0 or higher (or Unraid 6.9+ with Compose Manager)
  • Ports 8081 (frontend) and 8001 (backend) available (configurable in docker-compose.yml)

Architecture

  • Backend: Python FastAPI with Docker SDK
  • Frontend: HTML/CSS/JavaScript with Nginx
  • Deployment: Docker Compose

Security Note

This application requires access to the Docker socket (/var/run/docker.sock). Only run this in trusted environments as Docker socket access is privileged.

Configuration

Edit docker-compose.yml to change:

  • Web interface port (default: 8081)
  • Backend API port (default: 8001)
  • Refresh interval (default: 5 seconds)
  • Network settings

Platform Support

  • Linux - Full support
  • macOS - Full support
  • Windows - Full support (with Docker Desktop)
  • Unraid - Optimized with dedicated templates and compose file

Development

See INSTRUCTIONS.md for detailed development guide and API documentation.

Documentation

License

MIT License

About

Monitor what ports are being used

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages