Skip to content

Latest commit

 

History

History
335 lines (263 loc) · 19.9 KB

README.md

File metadata and controls

335 lines (263 loc) · 19.9 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 both container management & metric visualization.
Explore the docs »

View Demo · Report Bug · Request Feature



Table of Contents


  1. About Docketeer
  2. Installation
  3. In Development
  4. Contributing
  5. License
  6. Authors

About The Project

DockerTypescriptJavaScriptReactReduxRTKNodeExpressPostgresMySQLGrafanaPrometheusHelmKubernetesJestViteGitHTML5CSS3SASS


Logo

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, along with Kubernetes cluster 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.
  • It aims to simplify the development process for projects that use Docker containers.
  • Allows you to filter through both your running and stopped container logs.
  • Docketeer provides an easy-to-use command-line interface for managing Docker containers, images, and networks.
  • With Docketeer, developers can quickly create, start, stop, and delete containers, as well as manage Docker networks and images.
  • Docketeer includes a variety of features, including automatic container naming, customizable configurations, and support for multiple Docker Compose - files.
  • Docketeer offers Node and kubelet metrics visualizations for your Kubernetes clusters, along with an easy set up process to get your cluster connected to the application.
  • Docketeer also offers built-in support for popular development frameworks like Rails and Node.js, making it easy to get started with these technologies.
  • Docketeer is highly customizable, and developers can configure it to suit their specific needs.
  • 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

The local configuration for Docketeer was setup to be as simple as possible for the end-user.
Follow the steps below to get started with Docketeer.

Prerequisites:

You must have Docker Desktop installed!

STEP 1 — Clone the repository

git clone https://github.com/open-source-labs/Docketeer.git

STEP 2 — Docker compose up

Making sure you're in your Docketeer directory, run:

docker compose up

STEP 2.5 — Need to set up your Kubernetes cluster to work with Docketeer?

Open up a new tab in your terminal, run the following command, and then navigate to localhost:4001/api/k8:

npm run dev

If you haven't set up Prometheus-Operator with us before, click the first button to install.
Otherwise, you can skip the first button and go on with the next two!
P.S. Make sure to keep this terminal open!

STEP 3 — Navigate to localhost:4000 to sign-up & login!

http://localhost:4000

(back to top)

In Development

  • Support for more development frameworks and languages, such as Next.JS.
  • Improved support for Docker networking, including more advanced configurations and better integration with other network tools.
  • Expand Docker networking capabilities within Docketeer to provide more sophisticated networking configurations and better interoperability with other network tools.
  • Develop more advanced container configuration options within Docketeer, such as load balancing or high availability setups.
  • Integrate Docketeer with popular development tools like IDEs or continuous integration/delivery systems for better automation and workflow efficiency.
  • Add support for more advanced Docker features, like multi-stage builds or Docker secrets, to expand the capabilities of Docketeer.
  • Develop integration with cloud services like AWS or Azure to simplify the deployment of Docker-based applications.
  • Display additional metrics for Kubernetes clusters.

See the open issues for a full list of proposed features (and known issues).

(back to top)

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.txt for more information.

(back to top)

Authors

(back to top)

Show Your Support

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