Port Light — Visualize your server's port usage with an…

Pitch

Description

Comments

About this project

Port-Light is a web dashboard designed for homelab enthusiasts, providing a clear view of server port usage through a traffic-light grid. This tool helps manage Docker Compose stacks more effectively, ensuring users can easily track which ports are occupied, configured, or available.

Port-Light is a versatile web dashboard designed to provide a clear view of server port usage in a visually engaging traffic-light format. Tailored for homelab enthusiasts juggling multiple Docker Compose stacks, it helps to effortlessly track which ports are currently in use and which are available.

Key Features

Traffic-Light Grid Visualization: Quickly understand the status of ports across your server through a color-coded grid.
- Blue: In use - Ports actively being utilized or associated with running containers.
- Amber: Configured - Ports declared in Docker Compose but not currently in use.
- Green: Free - Indicates available ports, complete with alternatives if the desired port is occupied.
Integrated Sources: Port-Light consolidates data from various sources into one unified view:
- Host listening tables to check active TCP/UDP ports.
- Docker API to gain insights into container statuses and mappings.
- Docker Compose files to review declared ports.
Search and Filter Options: Easily find ports by number, and filter views based on usage and configuration status.
Multi-Instance Capability: Connect and visualize port occupancy across different Port-Light instances running on the same LAN or via Tailscale.
Customization Options: Adjust settings including UI themes (such as dark mode) and localization options.

Port-Light operates with minimal resource requirements, using a clean and simple frontend built on standard HTML, CSS, and JavaScript. It prioritizes security through optional HTTP Basic Authentication and encourages safe deployment practices to minimize exposure on public networks.

Quick Start

To get started, simply deploy with Docker:

services:
  port-light:
    image: stepaniah/port-light:v0.6.0
    container_name: port-light
    restart: unless-stopped
    ports:
      - "2100:2100"
    volumes:
      - /path/to/your/compose-stacks:/compose:ro
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - /proc:/host/proc:ro
      - ./data:/data
    environment:
      COMPOSE_SCAN_DIR: /compose

Then, open your local dashboard at http://localhost:2100 to start managing your server's port allocation effectively.

Port-Light stands out as an essential tool for those managing multiple services, helping to visualize and control port usage with ease.

Visit Port-Light