Docketeer

<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->

<a name="readme-top"></a>

<!-- PROJECT SHIELDS --> <!-- *** I'm using markdown "reference style" links for readability. *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). *** See the bottom of this document for the declaration of the reference variables *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links --> <div align="center" width="100%">

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url]

</div> <!-- PROJECT LOGO --> <!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/open-source-labs/Docketeer"> <img src="assets/extended-dark.png" alt="Logo" width="550" height="auto"> </a> <br /> https://docketeer.io/ <br/> <br /> <p align="center"> Docketeer is a developer-friendly application that provides a single interface for container and network management as well as metric visualization. <br /> <a href="https://github.com/open-source-labs/Docketeer"><strong>Explore the code & contribute here!»</strong></a><br /> <a href="https://github.com/open-source-labs/docketeer-extension"><strong>See the extension version's code here!»</strong></a> <br /> <br /> <br /> <a href="https://github.com/open-source-labs/Docketeer#about-the-project">View Demo</a> · <a href="https://github.com/open-source-labs/Docketeer/issues">Report Bug</a> · <a href="https://github.com/open-source-labs/Docketeer/issues">Request Feature</a> </p> </div> <br /> <!-- TABLE OF CONTENTS --> <br />

Table of Contents

<ol> <br /> <li> <a href="#about-the-project">About Docketeer</a></li> <li><a href="#installation">Installation</a></li> <li><a href="#in-development">In Development</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#authors">Authors</a></li> <li><a href="#troubleshooting">Troubleshooting</a></li> </ol> <!-- ABOUT THE PROJECT --> <br />

About The Project

<div align="center" width="100%">

[![Docker][Docker]][Docker-url][![Typescript][TS.js]][TS-url][![JavaScript][JavaScript]][JavaScript-url][![React][React.js]][React-url][![Redux][Redux]][Redux-url][![RTK][RTK]][RTK-url][![Node][Node.js]][Node-url][![Express][Express]][Express-url][![Postgres][Postgres]][Postgres-url][![MySQL][MySQL]][MySQL-url][![Grafana][Grafana]][Grafana-url][![Prometheus][Prometheus]][Prometheus-url][![Helm][Helm]][Helm-url][![Kubernetes][Kubernetes]][Kubernetes-url][![Jest][Jest]][Jest-url][![Vite][Vite]][Vite-url][![Git][Git]][Git-url][![HTML5][HTML5]][HTML5-url][![CSS3][CSS3]][CSS3-url][![SASS][SASS]][SASS-url][![D3][D3]][D3-url]

</div> <br /> <div align="center"> <img alt="Logo" src="assets/docketeer-peek.gif" width="fit" height="auto"> </div> <br />

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!

<p align="right">(<a href="#readme-top">back to top</a>)</p>

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.
• Allows you to filter through both your running and stopped container logs.
• Docketeer provides an easy-to-use GUI 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 full networking capabilities: create and manage networks without touching the terminal.
• Docketeer offers Node and kubelet metric 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.

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- INSTALLATION -->

Installation

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

Prerequisites:

You must have Docker Desktop installed and running! <br></br>

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 3 — Navigate to localhost:4000 to sign-up & login!

http://localhost:4000

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Setting up Docketeer to work with a Kubernetes cluster

Prerequisites: you must be running a Kubernetes cluster/kube, have kubectl and helm installed.

Open up a new tab in your terminal. Run

npm install

Docketeer is using d3-sankey for data visualization, which is currently not being actively maintained. Running npm install would install patch-package and make sure to input y when you see the following prompt:

Need to install the following packages:
  patch-package@7.0.2
Ok to proceed? (y) 

and

npm run dev

Then, navigate to localhost:4001/api/k8:

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

<!-- IN DEVELOPMENT -->

In Development

• [ ] Support for more development frameworks and languages, such as Next.JS.
• [ ] 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.
• [ ] Implement the Kubernetes metric monitoring from the browser version to the extension version.
• [ ] Display additional metrics for Kubernetes clusters.

See <a href="#troubleshooting">Troubleshooting</a> and open issues for a list of known issues.

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- CONTRIBUTING -->

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.

<br />

<b>Read More</b>

• Docketeer XIV: Coming Home
• Docketeer XIII: A Tool for Docker!
• Docketeer XII: Now Ready for Launch!
• Introducing Docketeer XI | The Latest Version Ready for Takeoff with a Splash!
• Enjoy the sleek new look of Docketeer X
• Docketeer is here to make a splash!
• Docketeer is here! You’re WHALEcome!