Compare commits

..
2 Commits
Author SHA1 Message Date
angel a11f0e99e5 Making it clearer 2026-07-08 16:42:07 +00:00
angel 5fcff0f561 Made instructions clearer 2026-07-08 16:41:18 +00:00
7 changed files with 62 additions and 2 deletions
Regular → Executable
+60
View File
@@ -12,6 +12,8 @@ Docker is an incredible tool for containerization, but managing everything stric
This repository provides a streamlined, "plug-and-play" Docker Compose configuration to get your own instance of Dockhand up and running in seconds. This repository provides a streamlined, "plug-and-play" Docker Compose configuration to get your own instance of Dockhand up and running in seconds.
![Example of Dockhand](images/Screenshot_20260708_120518.png)
--- ---
## Features of this Repo ## Features of this Repo
@@ -38,6 +40,8 @@ Getting started is designed to be as simple as possible. Just run the following
3. **To Access the logs if needed** 3. **To Access the logs if needed**
```bash ```bash
docker compose logs docker compose logs
```
---
## Accessing the Dashboard ## Accessing the Dashboard
@@ -45,3 +49,59 @@ Once the container is running, open your web browser and navigate to:
```text ```text
http://<YOUR_SERVER_IP>:3000 http://<YOUR_SERVER_IP>:3000
```
---
## Setting up the First Environment
Follow these steps to connect Dockhand to your local Docker host and start monitoring your containers:
### Step 1: Access the Dashboard
When you first log into Dockhand, you will be greeted by an empty dashboard indicating that no environments have been configured yet. Click on the **Go to Settings** button in the center of the screen, or click **Settings** at the bottom of the left sidebar.
<!-- INSERT SCREENSHOT_20260708_120347.png HERE -->
![Step 1](images/Screenshot_20260708_120347.png)
---
### Step 2: Add an Environment
Once inside the Settings panel, ensure you are on the **Environments** tab. Click the blue **+ Add environment** button located on the right side of the screen.
<!-- INSERT SCREENSHOT_20260708_120407.png HERE -->
![Step 2](images/Screenshot_20260708_120407.png)
---
### Step 3: Configure the Unix Socket
An "Add environment" modal will appear. Configure it with the following details:
* **Name:** Give it a recognizable name (e.g., `local`).
* **Connection type:** Select **Unix socket** from the dropdown menu.
* **Socket path:** Leave this as the default `/var/run/docker.sock` (Dockhand will auto-detect it).
Click **Test connection** at the bottom left of the modal. Once you see the green **Connected!** toast notification in the bottom right corner, click the blue **+ Add** button.
<!-- INSERT SCREENSHOT_20260708_120427.png HERE -->
![Step 3](images/Screenshot_20260708_120427.png)
---
### Step 4: Verify Environment Overview
You will be redirected back to the main Dashboard view. Your local environment card will now be visible, showing real-time CPU utilization, memory usage, and the total count of running vs. stopped containers.
<!-- INSERT SCREENSHOT_20260708_120457.png HERE -->
![Step 4](images/Screenshot_20260708_120457.png)
---
### Step 5: Explore Running Containers
Click on the **Containers** tab in the left sidebar. You will see a complete, live list of all containers running on your host (including the `dockhand` container itself), along with individual uptime stats, IP allocations, internal ports, and resource metrics.
<!-- INSERT SCREENSHOT_20260708_120518.png HERE -->
![Step 5](images/Screenshot_20260708_120518.png)
# Conclusion
Congratulations on making it this far. You have successfully deployed Dockhand and connected it to your local Docker environment. All the containers you have deployed on the host you deployed Dockhand on should appear here. As you can see you can explore Stacks, Images, Volumes, etc. You can even go into Stacks, click Create Stack, and paste a docker-compose.yml content and deploy it right from here.
![Example Compose](images/Screenshot_20260708_123812.png)
Of course on the test machine I deployed this to the only container running is the Dockhand I just deployed. Hence why it looks empty. Now all thats left is for you to explore and see what it can do. See if it fits you needs. I will be doing a separate git repo for the Hawser Agent which can be used to connect Dockhand to other nodes.
Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB