Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.2 KB

README.md

File metadata and controls

26 lines (19 loc) · 1.2 KB
Raw

container-info

A tiny Golang API that returns metadata of all Docker containers.

I created this because I wanted a simple way to get the status of the various services that run my home network without returning sensitive information (such as my network configuration, volume bindings or entrypoint arguments).

You can see a live instance of this here, and in use here!

docker-compose example

services:
  container-info:
    image: "ghcr.io/tetra-fox/container-info:latest"
    ports:
      - "3621:8080"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro # So we can get information from Docker!

Endpoints

Method Endpoint Description
GET / Returns the metadata of all containers.
GET /{name(s)} Returns the metadata of the specified container(s). (comma-separated)