Skip to content

Latest commit

 

History

History
485 lines (381 loc) · 27.8 KB

README.md

File metadata and controls

485 lines (381 loc) · 27.8 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo
https://dogketeer.com/

Docketeer is a developer-friendly application that provides a single interface for container and network management as well as metric visualization.

Docketeer Web App

Report Bug · Request Feature


Table of Contents

  1. About Docketeer
  2. Features
  3. Installation
  4. Documentation
  5. Demo
  6. Contributing
  7. License

About The Project

Docketeer is an open source initiative comprised of contributions from dozens of talented and passionate software engineers. Our application provides a simple interface to manage Docker resources & visualize both host and container metrics. Docketeer is a containerized application that can be deployed alongside your application cluster with hardly any effort. To learn more about Docketeer and how to get started, continue reading!

Features

  • Docketeer is a Docker developer tool that's available as an open-source project on GitHub or as an extension on Docker Desktop.
  • It aims to simplify the development process for projects that use Docker containers.
  • Visualize and compare previously saved health metric snapshots to offer users a comprehensive understanding of historical performance.
  • Allows you to filter through both your running and stopped container logs.
  • Provides image vulnerability data for each image for enhanced understanding of the security of used images
  • Docketeer provides an easy-to-use GUI for managing Docker containers, images, and networks.
  • With Docketeer, developers can quickly start, stop, and delete containers, as well as manage run Docker images.
  • Docketeer offers the ability to create, delete, and attach containers to networks.
  • It's a community-maintained project, with frequent updates and bug fixes.
  • Docketeer is licensed under the MIT license, meaning it can be used and modified freely, even for commercial projects.
  • Read, modify, and save Prometheus configurations all within the extension

(back to top)

What's New in Version 20.0.0?

New Features Status
Setup an error catch to alert Users of errors that are in the Docker Container Log. ✅
Optimize frontend rendering performance with lazy loading to reduce initial bundle size and eliminating redundant re-renders. ✅
Complete update of all dependencies. Docketeer v20.0.0 is now fully compatible with Docker Desktop v4.40 as of 04/16/25. ✅
Improved frontend styling and global styling making it easier to make future improvements ✅
  • ✅ = Ready to use
In Development Status
CI/CD pipeline for Docketeer repo. ⏳
Improve test coverage with additional unit tests and integration tests. ⏳
Optimize frontend rendering performance with lazy loading to reduce initial bundle size and eliminating redundant re-renders. ⏳
Add support for more advanced Docker features, like multi-stage builds or Docker secrets, to expand the capabilities of Docketeer. ⏳
Add the ability to control Docker containers deployed in AWS. ⏳
Develop aggregation service to collect and cache data from prometheus data sources. ⏳
Implement endpoint scraping of any kubernetes cluster running prometheus. (Read more) ⏳
Work on improving the connect/disconnect button under networks button in Containers Tab. ⏳
Adding additional key metrics to the snapshot functionality. ⏳
Implement functionality that alerts users when certain metrics reach critical threshold. ⏳
Add functionality to load previously saved Prometheus configurations to the current container ⏳
Reduce memory consumption of the application ⏳
  • ⏳ = In progress

See the Known Issues Docs for a list of known issues.

(back to top)

🚀 Installation Guide for Docketeer v20.0.0

Docketeer is a Docker Desktop Extension for real-time container monitoring using Prometheus, Grafana, and cAdvisor. With updated dependencies, Docketeer v20.0.0 is now compatible with Docker Desktop v4.40 as of 04/18/25.

✅ Prerequisites

  1. Install Docker Desktop
    • Download Docker Desktop
    • Follow the install steps for macOS or Windows.
    • Verify installation: 
      docker --version
    • Latest stable version of Docker Desktop is 4.40

🧩 Install Docketeer as an Extension

  1. Open Docker Desktop.
  2. Go to the Extensions tab.
  3. Search for Docketeer.
  4. Click Install.

For local development or contributing, follow the steps below.

  • Documentation
    • ---

    🛠 Local Development: Browser Mode

    🔧 1. Enable Docker Extension Developer Mode

    • Open Docker Desktop → Settings > Extensions → Disable Allow only extensions distributed through the Docker Marketplace

    Docker Settings

    ---

    🌐 2. Run Docketeer in Browser Mode

    This will launch the full environment (frontend, backend, Postgres, Prometheus, Grafana, cAdvisor, etc.)

    To run clean with no cache:

    make browser-new
    • Docketeer UI → http://localhost:4000
    • Grafana → http://localhost:49155
    • Prometheus → http://localhost:49156
    • cAdvisor → http://localhost:49158

    🛑 3. Power Down

    Stop and clean up all containers and volumes in Docker Desktop first before running ' make browser-down'

    Run in terminal:

    make browser-down

    This will clear all dangling resources

    Run in terminal:

    make pruneAll

    ⚠️ Troubleshooting (e.g. Vite package not found)

    If connnection to docker daemon is lost, may have to restart computer for a full reset. But, try running this sequence of Makefile commands

    Run in terminal:

    make browser-down

    Run in terminal:

    make pruneAll

    Check Docker Desktop to make sure Containers, Images, Volumes, Builds are cleared. If not cleared may have to quit and re-open Docker Desktop.

    Run in terminal:

    make browser-new

    📦 Running the Docker Desktop Extension

    🧩 1. Install the extension locally

    make extension-dev

    🛑 3. Uninstall Extension

    Run in terminal:

    make remove-dev-extension

    Run in terminal:

    make pruneAll

    Documentation

    For more details, please read the docs folder, which covers the following:

    Helpful Development Documents

    When you are ready to launch, make sure to follow the instructions under Makefile.


    (back to top)

    🗂 Project Structuring

    File Purpose
    docker-compose-browser.yaml Full browser-mode dev environment
    docker-compose-dev.yaml Minimal extension test in dev mode
    docker-compose-prod.yaml Production-ready extension deployment config
    dockerfile.dev Dockerfile for dev builds (hot reload support)
    dockerfile.prod Dockerfile for production extension build
    Makefile CLI automation: build, run, down, clean

    (back to top)


    Demo

    Navigation

    Navigation

    Container Page:

    Containers Page

    (back to top)

    Image Page:

    Image Page

    Snapshot Metrics:

    Snapshot Metrics

    (back to top)

    Container Metrics Page:

    Container Metrics Page

    Process Logs:

    Process Logs

    (back to top)

    Kubernetes Page (In Development):

    Kubernates Metrics Page

    Network:

    Network

    (back to top)

    Configuration Page:

    Configuration Page

    (back to top)

    Read More


    (back to top)

    Show Your Support

    Please ⭐️ this project if you found it helpful, thank you!

    Contributing

    Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

    If you have a suggestion that would make this better, please fork the repository and create a pull request. You can also simply open an issue describing your contribution. Don't forget to give the project a star! Thanks again!

    1. Fork the project and clone onto your local machine
    2. Create your Feature Branch (git checkout -b feature/NewFeatureName)
    3. Commit your Changes (git commit -m '(feature/bugfix/style/etc.): [commit message here]')
    4. Push to the Branch (git push origin feature/NewFeatureName)
    5. Open a Pull Request
    6. Create an issue on GitHub (as mentioned above!)

    Read our contributing guide for more information on how to purpose bugfixes and improvements to Docketeer.

    Need ideas for improvement? Check our known issues for possible improvements / fixes!

    (back to top)

    Contributors

    License

    Distributed under the MIT License. See License for more information.

    (back to top)