An open API service indexing awesome lists of open source software.

https://github.com/ryvieos/ryvie

Your own cloud
https://github.com/ryvieos/ryvie

docker home-server personal-cloud self-hosted sso

Last synced: 10 days ago
JSON representation

Your own cloud

Awesome Lists containing this project

README

          


Ryvie

Ryvie · Personal Cloud OS


Your personal cloud.

A source-available, self-hosted personal cloud OS that turns any VPS or physical machine into your own private cloud. No command line, no need to know what a server is. Your apps, your files, your data, free and fully under your control. A privacy-first alternative to CasaOS, Umbrel and Nextcloud.


English · Français


Version
License
Stars
Forks
Issues
Last commit
PRs Welcome
Website


Website ·
Documentation ·
Download ·
Report a bug ·
Contribute


Ryvie self-hosted personal cloud dashboard


⭐ If you like Ryvie, star the repo. It genuinely helps the project gain visibility!

---

## Table of contents

- [Why Ryvie?](#-why-ryvie)
- [Features](#-features)
- [Installation](#-installation)
- [Tech stack](#-tech-stack)
- [Architecture](#-architecture)
- [Requirements](#-requirements)
- [Contributing](#-contributing)
- [License](#-license)
- [Team](#-team)

---

## ✨ Why Ryvie?

Mainstream clouds (Google Drive, iCloud, Dropbox…) are convenient, but they **rent you access to your own data** and store it on servers you don't control. Ryvie flips that model. You self-host everything and own your data.

- **Your own server, no command line.** Install dozens of open-source apps and services (photos, drive, CRM, automation…) in one click, never touching a terminal.
- **Your data stays home.** On your own hardware, encrypted, never sold.
- **As simple as a smartphone.** A grid launcher, not a Linux admin console.
- **Multi-user with permissions.** Create accounts for your family or team, each with its own access and rights, through centralized SSO.
- **Reachable anywhere.** Built-in private VPN tunnel (Netbird) and public-address generation, with no port forwarding and no router config.
- **Deploy anywhere.** On a VPS or a physical machine at home, via the Ryvie OS.

> Ryvie brings the power of a self-hosted server with the simplicity of a smartphone.

**Compared to other self-hosted platforms**, think of Ryvie as a [CasaOS](https://github.com/IceWhaleTech/CasaOS) or [Umbrel](https://github.com/getumbrel/umbrel) alternative, but with built-in centralized SSO, managed RAID storage, an integrated VPN and a private AI gateway out of the box.

---

## 🚀 Features

| Feature | Description |
|---|---|
| **Grid launcher** | Responsive, smartphone-style UI: drag & drop, folders, widgets (weather, CPU/RAM, storage). |
| **Self-hosted app store** | Dozens of open-source apps and services installable in one click, no command line (auto-detects manifests, icons, ports). |
| **Multi-user management** | Multiple accounts with roles and permissions; centralized SSO (Keycloak + LDAP) shared by all your apps. |
| **Remote access + public IP** | Private VPN tunnel (Netbird) and public-address generation to expose your apps, with no port forwarding or router setup. |
| **Managed RAID storage** | Create/migrate RAID arrays (mdadm), SMART monitoring, hot-grow, move Docker across disks/partitions, all from the UI. |
| **Private AI gateway** | Connect one LLM provider (via LiteLLM) once, shared across your apps, your key never exposed. Toggle off to save RAM. |
| **Real-time monitoring** | Live system status over Socket.IO. |
| **Customization** | Per-user themes, wallpaper and layout. |
| **Flexible deployment** | On a VPS or a physical machine, via the Ryvie OS. |

---

## 💻 Installation

> **Full guide: [ryvie.fr/docs](https://ryvie.fr/docs)**

1. **Install the Ryvie OS.** Download the image from [ryvie.fr](https://ryvie.fr) and install it on a VPS or a physical machine (mini-PC, server, old desktop…).
2. **Install the Ryvie Desktop client.** Available for macOS, Windows and Linux at [ryvie.fr](https://ryvie.fr).
3. **Sign in.** Open the client, connect to your instance, and manage your apps, grid and storage.

---

## 🛠️ Tech stack


React
TypeScript
Node.js
Express
Electron
Socket.IO
Docker
Keycloak
Caddy

---

## 🏗️ Architecture


Ryvie architecture diagram

- **Backend** (`Ryvie-Back/`): Express + Socket.IO API, Docker orchestration, SSO (Keycloak/LDAP), RAID storage, AI gateway.
- **Frontend** (`Ryvie-Front/`): React 18 + Electron for a smooth desktop experience.
- **Data** (`/data/`): configuration, app manifests and user storage (portable bind-mounts).
- **Reverse proxy**: Caddy (app routing, TLS, same-origin).

---

## 📋 Requirements

| Resource | Minimum | Recommended |
|---|---|---|
| **CPU** | 4 cores | 4+ cores |
| **RAM** | 8 GB | 16 GB |
| **Storage** | 50 GB | SSD/NVMe + disk(s) for `/data` |

---

## 🤝 Contributing

Contributions are welcome!

**Before contributing**, read the [Contributing guide](CONTRIBUTING.md) and sign the [CLA](CLA.md) (automated via the CLA Assistant bot).

- **[Contributing guide](CONTRIBUTING.md)**: how to set up the environment and propose changes.
- **[CLA](CLA.md)**: Contributor License Agreement (required for any contribution).
- **Issues**: report a bug or suggest an idea with as much detail as possible.
- **Pull requests**: create a dedicated branch and clearly explain your changes.

The CLA protects both you (you keep ownership of your code) and the project (maintenance and evolution).

---

## 📄 License

Distributed under the **Ryvie Source-Available License (RSAL) v1.1**. See [`LICENSE`](LICENSE) for details.

---

## ⚠️ Disclaimer

This project is provided **"as is"**, without warranty of any kind. The Ryvie team cannot be held responsible for damages, data loss or downtime resulting from the use of the platform.

---

## 👥 Team

- **Jules Maisonnave** ([@maisonnavejul](https://github.com/maisonnavejul)) · *Initial work & Lead Development*
- **Driss Bendahan** ([@thegreenprogrammer](https://github.com/thegreenprogrammer)) · *Infrastructure & DevOps*
- **Paul Quiquempois** ([@Loghin01](https://github.com/Loghin01)) · *Development & CI/CD*


Made with ❤️ by the Ryvie team · ryvie.fr

A single star makes a real difference for the project's visibility.