Skip to content

Update README.md #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drk1rd merged 1 commit into from
Jun 16, 2025
Merged

Update README.md #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 55 additions & 63 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,95 +1,79 @@
# ☁️ **HomeCloud** — *Cloud, Owned by You.*
# ☁️ HomeCloud — The Cloud, Owned by You

Bring the power of the cloud to your own hardware — **no third parties, no lock-in, no hidden costs.**
HomeCloud is an open-source, self-hosted cloud platform for **compute, storage, networking, and databases** — all in one click.
**An open-source, self-hosted cloud platform** for compute, storage, networking, and databases — all in one click. No third parties. No vendor lock-in. No surprise billing.

---

## 🔥 **Why HomeCloud?**

💡 **Take Control** — Your data stays yours. No vendors, no surveillance.
💰 **Slash Costs** — No pay-as-you-go billing. Your hardware, your rules.
🚀 **One-Click Deployments** — Launch services in seconds, no sysadmin degree needed.
🌍 **Open-Source Freedom** — Built by the community, for the community.

[✨ Learn more about HomeCloud](https://homecloud.suryansh.one/files/but,%20why_.pdf)
> 🛡 Built with privacy, transparency, and sovereignty at its core.

---

## 🛠️ **Core Features**
## 🔥 Why HomeCloud?

🔹 **Compute:** Spin up containers, VMs, or apps locally.
🔹 **Storage:** Self-hosted object storage (S3-compatible).
🔹 **Databases:** One-click PostgreSQL, Redis, and more.
🔹 **Networking:** Handle traffic with powerful routing & load balancing.

✨ **More features in the pipeline — stay tuned!**
* **💡 Take Back Control** — Your data stays *yours*. No surveillance, no dependency on external providers.
* **💰 Eliminate Cloud Costs** — Forget unpredictable bills. Use your own hardware with full control.
* **🚀 One-Click Deployments** — Launch services instantly without a sysadmin degree.
* **🌍 Community-First & Open-Source** — Released under AGPL-3.0, developed with and for the community.

---

## 🧰 **Installation Scripts & Releases (Experimental)**
## 🛠️ Core Features

🚧 **Current Status:** Experimental — We're working hard to make it easy for you to set up HomeCloud with minimal effort! Currently, these installation scripts are in their early stages and may have bugs or require manual configuration for certain systems.
| Feature | Description |
| ------------- | ------------------------------------------------------ |
| 🖥️ Compute | Run containers, VMs, or apps locally on your hardware. |
| 💾 Storage | Built-in object storage (S3-compatible). |
| 🧠 Databases | Launch PostgreSQL, Redis, and others with one click. |
| 🌐 Networking | Native traffic routing, SSL, and load balancing. |

🔹 **What’s Included?**
- **Installation Scripts** — Easy-to-use scripts for installing HomeCloud on various platforms (Linux/macOS/Windows).
- **Automated Checks** — The script will ensure that all requirements are met and installed before setting up HomeCloud.
- **Automatic Binary Download** — For Linux and macOS, the correct version of HomeCloud will be downloaded and set up for you.
> 💡 Upcoming: Serverless functions, hardware integrations, monitoring tools, and more.

⚠️ **Note:**
- These scripts are **NOT YET FULLY STABLE** and are part of our early efforts to simplify the installation process.
- If you run into issues, please report them via our GitHub **[Issues](https://github.com/homecloudhq/homecloud/issues)**, and we’ll work on a fix.
---

### 🖥️ **How to Run the Installation Scripts**
## 🚧 Installation (Experimental)

1. **Windows**
- Download and run the `scripts/install.ps1` PowerShell script to install HomeCloud.
- The script checks if Docker is installed and prompts you to install it if missing.
- To run, simply execute the following command in PowerShell:
### Windows

```powershell
Invoke-WebRequest -Uri "https://homecloud.drk1rd.systems/scripts/install.ps1" -OutFile "install.ps1"
.\install.ps1
```
```powershell
Invoke-WebRequest -Uri "https://homecloud.drk1rd.systems/scripts/install.ps1" -OutFile "install.ps1"
.\install.ps1
```

2. **Linux/macOS**
- Download and run the `scripts/install.sh` shell script to install HomeCloud.
- The script checks for Docker and installs it if not already present.
- To run the script, open your terminal and execute the following commands:
### Linux / macOS

```bash
curl -LO https://homecloud.drk1rd.systems/scripts/install.sh
chmod +x install.sh
./install.sh
```
```bash
curl -LO https://homecloud.drk1rd.systems/scripts/install.sh
chmod +x install.sh
./install.sh
```

- **Upcoming releases will focus on stability and more user-friendly setup.**
> ⚠️ *Experimental*: These installers are in early stages and may require manual configuration.

---

## 🗺️ **Roadmap**
## 🗺️ Roadmap

We’re building HomeCloud in phases — here’s what’s next:

🔧 **Phase 1:** Core services — Compute, Storage, Networking 🔃
⚡ **Phase 2:** Serverless functions & event-driven architecture 🔃
📊 **Phase 3:** Monitoring, logging, and performance insights
🔌 **Phase 4:** Hardware integrations and edge computing support
* ✅ **Phase 1:** Core cloud stack — Compute, Storage, Networking
* 🔄 **Phase 2:** Serverless architecture & event-driven services
* 🔄 **Phase 3:** Observability — Monitoring, logging, alerts
* 🔄 **Phase 4:** Edge compute & hardware integrations

📍 **[Explore the full roadmap](https://github.com/orgs/homecloudhq/projects/1/views/1)**

---

## 🛡️ **License**
## 💸 Sustainability & Support

HomeCloud is a community project, currently unfunded and maintained by volunteers.

HomeCloud is released under **GNU AGPL-3.0** — keeping it open and community-driven.
**If you modify or share HomeCloud publicly, your changes must stay open too.**

📜 **[Read the full license](./LICENSE)**
### 💛 Ways to Support

* [ ] Sponsor development via GitHub Sponsors / Open Collective (Coming Soon)
* [ ] Contribute infrastructure, bugfixes, or UX improvements
* [ ] Share HomeCloud with your communities!

---

## 💪 **Get Involved**
## 🤝 Get Involved

We’re building HomeCloud for the community — and we’d love for you to join us:

Expand All @@ -100,7 +84,15 @@ We’re building HomeCloud for the community — and we’d love for you to join
🔹 **By contributing, you agree to our** [**Contributor License Agreement (CLA)**](./CLA.md).

---

⚡ **HomeCloud — The Cloud, On Your Terms.**

---
## 🛡 License

HomeCloud is released under **GNU AGPL-3.0** — keeping it open, transparent, and libre.
If you deploy or modify it publicly, share your changes too.

---

## ⚡ HomeCloud — The Cloud, On Your Terms.

---