diff --git a/README.md b/README.md index a2dd722..d28a0b7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ -# dockhand +# Dockhand Deployment -Basic git repo with the docker compose files and such that allow me to run the new docker container manager called Dockhand. \ No newline at end of file +> ⚠️ **Prerequisite:** This repository assumes you already have Docker and Docker Compose installed on your host system. If you need to install Docker, please follow the [Ben's Cloud Docker Installation Guide](https://wiki.bens-cloud.com/docker-stuff/01-docker-installation) for a brief overview of what Docker is and step-by-step instructions for your Linux distribution of choice. + +--- + +## What is Dockhand? + +Docker is an incredible tool for containerization, but managing everything strictly through the command line can become cumbersome and confusing as your homelab grows. + +**Dockhand** is a rising star in the world of container management, offering a streamlined, user-friendly interface to monitor and manage your Docker environments without relying entirely on the CLI. While industry veterans like Portainer remain solid and reliable choices, Dockhand provides a fresh, modern approach that is rapidly gaining popularity for self-hosters. + +This repository provides a streamlined, "plug-and-play" Docker Compose configuration to get your own instance of Dockhand up and running in seconds. + +--- + +## Features of this Repo + +* **Production-Ready Compose File:** Optimized configuration for a quick spin-up. +* **Git-and-Go Workflow:** Designed to be cloned and deployed immediately with minimal configuration. +* **Persistent Storage:** Pre-configured volumes to ensure your Dockhand data survives container updates. + +--- + +## Quick Start + +Getting started is designed to be as simple as possible. Just run the following commands in your terminal: + +1. **Clone the repository:** + ```bash + git clone [https://github.com/yourusername/dockhand.git](https://github.com/yourusername/dockhand.git) + cd dockhand \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..b83f7c4 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,13 @@ +services: + dockhand: + image: fnsys/dockhand:latest + container_name: dockhand + restart: unless-stopped + ports: + - 3000:3000 + volumes: + - /var/run/docker.sock:/var/run/docker.sock + - dockhand_data:/app/data + +volumes: + dockhand_data: \ No newline at end of file