From 91f870989a51c98a8d99e9d79e0320b186335d83 Mon Sep 17 00:00:00 2001 From: Pavel Sviderski Date: Fri, 24 Jan 2025 16:56:40 +1000 Subject: [PATCH] update README with basic Quick start --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 42 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5d3c81a7..fa47d822 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,44 @@ -# Uncloud +
+ Uncloud logo +

Uncloud

+ A lightweight Docker clustering tool for running web apps on your own servers — from cloud VMs to bare metal.
+ Replace Heroku and Render, no Kubernetes required. +
-Uncloud is a lightweight tool for deploying and managing containerised applications across a network of Docker hosts. It -bridges the gap between simple Docker deployments and complex cloud platforms and container orchestrators like -Kubernetes. +## Quick start -Our goal is to become the go-to self-hosted alternative to platforms like [Fly.io](https://fly.io) and -[Render](https://render.com/). Whether you're using bare metal servers, Raspberry Pis, or cloud VMs, Uncloud transforms -your hardware into a personal cloud platform. +1. Install Uncloud CLI: + +```bash +curl -fsSL https://raw.githubusercontent.com/psviderski/uncloud/main/scripts/install_cli.sh | sh +``` + +2. Initialize your first machine: + +```bash +uc machine init root@your-server-ip +``` + +3. Create a DNS A record pointing `app.example.com` to your server's IP address, then deploy your app with + automatic HTTPS: + +```bash +uc run --name my-app -p app.example.com:8000/https registry/app +``` + +That's it! Your app is now running and accessible at https://app.example.com ✨ + +## Project status + +Uncloud is an open source project I'm ([@psviderski](https://github.com/psviderski)) actively developing. I'd love to +share this journey with you. [Subscribe](https://uncloud.run/) to follow the progress, get early insights into new +features, and be the first to know when it's ready for production use. + +I'd also love your input: + +- 🐛 Found a bug? [Open an issue](https://github.com/psviderski/uncloud/issues) +- 💡 Have ideas? [Join the discussion](https://github.com/psviderski/uncloud/discussions) + +## Motivation + +TBD