Skip to content

Latest commit

 

History

History
355 lines (298 loc) · 23.7 KB

README.md

File metadata and controls

355 lines (298 loc) · 23.7 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo
https://docketeer.io/

Docketeer is a developer-friendly application that provides a single interface for container and network management as well as metric visualization.
Explore the code & contribute here!»
See the extension version's code here!»

Report Bug · Request Feature


Table of Contents

  1. About Docketeer
  2. Installation
  3. In Development
  4. Documentation
  5. Contributing
  6. License
  7. Authors
  8. Troubleshooting

About The Project

DockerTypescriptJavaScriptReactReduxRTKNodeExpressRedisPostgresGrafanaPrometheusJestViteGitHTML5CSS3SASSD3MUI


Container Page Demo:

Containers Page

Network Page Demo:

Network Page

Image Page Demo:

Image Page

Container Metrics Page Demo:

Container Metrics Page

Kubernetes Page Demo:

Kubernates Metrics Page

Snapshot Demo:

demo gif

Process logs Demo:

Process log gif

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

(back to top)

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.

(back to top)

Installation

Open your Docker Desktop and search 'Docketeer' and install the extension!

If you would like to install from the Github, see DevGettingStarted

In Development

  • More advanced container configuration options within Docketeer.
  • 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/disconnnect button under networks button in Containers Tab
  • Adding additional key metrics to the snapshot functionality
  • Setup a error catcher to alert Users of errors that are in the Docker Container Log.
  • Implement functionality that alerts users when certain metrics reach critical threshold.

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

(back to top)

Documentation

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

  • API
  • Assets
  • Changelogs (V1-V17)
  • Features
    • Configuration.md
    • Models.md
  • DevGettingStarted.md
  • DevWorkingWithGrafana.md
  • KnownIssues.md

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

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.


Read More


License

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

(back to top)

Show Your Support

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

Contributors

(back to top)