48 lines
2.0 KiB
Markdown
48 lines
2.0 KiB
Markdown
# Dockhand Deployment
|
|
|
|
> ⚠️ **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
|
|
|
|
2. **Deploy the container using Docker Compose**
|
|
```bash
|
|
docker compose up -d
|
|
|
|
3. **To Access the logs if needed**
|
|
```bash
|
|
docker compose logs
|
|
|
|
## Accessing the Dashboard
|
|
|
|
Once the container is running, open your web browser and navigate to:
|
|
|
|
```text
|
|
http://<YOUR_SERVER_IP>:3000
|