diff --git a/README.md b/README.md index 18a5ee4..4d77500 100644 --- a/README.md +++ b/README.md @@ -1 +1,57 @@ -# Dockhand +
+
+
+ Modern Docker Management UI +
+ ++ Website • + Documentation • + License +
+ +--- + +## About + +Dockhand is a modern, efficient Docker management application providing real-time container management, Compose stack orchestration, and multi-environment support. + +### Features + +- **Container Management**: Start, stop, restart, and monitor containers in real-time +- **Compose Stacks**: Visual editor for Docker Compose deployments +- **Git Integration**: Deploy stacks from Git repositories with webhooks and auto-sync +- **Multi-Environment**: Manage local and remote Docker hosts +- **Terminal & Logs**: Interactive shell access and real-time log streaming +- **File Browser**: Browse, upload, and download files from containers +- **Authentication**: SSO via OIDC, local users, and optional RBAC (Enterprise) + +## Tech Stack + +- **Frontend**: SvelteKit 2, Svelte 5, shadcn-svelte, TailwindCSS +- **Backend**: Bun runtime with SvelteKit API routes +- **Database**: SQLite or PostgreSQL via Drizzle ORM +- **Docker**: Dockerode library + +## License + +Dockhand is licensed under the [Business Source License 1.1](LICENSE.txt) (BSL 1.1). + +### What this means: + +- **Free for**: Personal use, internal business use, non-profits, education, evaluation +- **Not allowed**: Offering Dockhand as a commercial SaaS/hosted service +- **Converts to Apache 2.0**: On January 1, 2029 + +See [LICENSE.txt](LICENSE.txt) for full terms. + +## Links + +- **Website**: [https://dockhand.io](https://dockhand.io) +- **Documentation**: [https://dockhand.io/docs](https://dockhand.io/docs) + +--- + +© 2025-2026 Finsys / Jarek Krochmalski