Added README.md

This commit is contained in:
Kevin Veen-Birkenbach 2025-07-09 05:25:43 +02:00
parent a0a61ad304
commit 5cd94c1d0a
No known key found for this signature in database
GPG Key ID: 44D8F11FD62F878E

View File

@ -1,29 +1,47 @@
# IT-Infrastructure Automation Framework 🚀 # IT-Infrastructure Automation Framework 🚀
[![GitHub Sponsors](https://img.shields.io/badge/Sponsor-GitHub%20Sponsors-blue?logo=github)](https://github.com/sponsors/kevinveenbirkenbach) [![Patreon](https://img.shields.io/badge/Support-Patreon-orange?logo=patreon)](https://www.patreon.com/c/kevinveenbirkenbach) [![Buy Me a Coffee](https://img.shields.io/badge/Buy%20me%20a%20Coffee-Funding-yellow?logo=buymeacoffee)](https://buymeacoffee.com/kevinveenbirkenbach) [![PayPal](https://img.shields.io/badge/Donate-PayPal-blue?logo=paypal)](https://s.veen.world/paypaldonate) [![GitHub Sponsors](https://img.shields.io/badge/Sponsor-GitHub%20Sponsors-blue?logo=github)](https://github.com/sponsors/kevinveenbirkenbach) [![Patreon](https://img.shields.io/badge/Support-Patreon-orange?logo=patreon)](https://www.patreon.com/c/kevinveenbirkenbach) [![Buy Me a Coffee](https://img.shields.io/badge/Buy%20me%20a%20Coffee-Funding-yellow?logo=buymeacoffee)](https://buymeacoffee.com/kevinveenbirkenbach) [![PayPal](https://img.shields.io/badge/Donate-PayPal-blue?logo=paypal)](https://s.veen.world/paypaldonate)
---
![CyMaIS Logo](assets/img/logo.png) ![CyMaIS Logo](assets/img/logo.png)
## What is CyMaIS? 📌 ## What is CyMaIS? 📌
CyMaIS is an automated, modular infrastructure framework built on Docker, Linux, and Ansible, equally suited for cloud services, local server management, and desktop workstations. At its core lies a web-based desktop with single sign-on—backed by an LDAP directory and OIDC—granting seamless access to an almost limitless portfolio of self-hosted applications. It fully supports ActivityPub applications and is Fediverse-compatible, while integrated monitoring, alerting, cleanup, self-healing, automated updates, and backup solutions provide everything an organization needs to run at scale.
## Guides 📖 **CyMaIS** is an **automated, modular infrastructure framework** built on **Docker**, **Linux**, and **Ansible**, equally suited for cloud services, local server management, and desktop workstations. At its core lies a **web-based desktop with single sign-on**—backed by an **LDAP directory** and **OIDC**—granting **seamless access** to an almost limitless portfolio of self-hosted applications. It fully supports **ActivityPub applications** and is **Fediverse-compatible**, while integrated **monitoring**, **alerting**, **cleanup**, **self-healing**, **automated updates**, and **backup solutions** provide everything an organization needs to run at scale.
- **[User Guide](docs/guides/user/Readme.md)** - For end-users accessing cloud apps like Nextcloud, Matrix, and more.
- **[Administrator Guide](docs/guides/administrator/Readme.md)** - For system administrators deploying CyMaIS. ---
- **[Customer Guide](docs/guides/customer/Readme.md)** - For customers which are interested in an infrastructure setup
- **[Developer Guide](docs/guides/developer/index)** - For developers which are interested in participating
- **[Investor Guide](docs/guides/investor/Readme.md)** - For investors which like to get a share in the project
## Key Features 🎯 ## Key Features 🎯
- **Automated IT deployment** 📦 - Pre-built roles for server and PC setups
- **Enterprise-ready security** 🔒 - Supports LDAP, Keycloak, 2FA, and encrypted storage * **Automated Deployment** 📦
- **Scalability & flexibility** 📈 - Modular approach for small teams to large enterprises Turn up servers and workstations in minutes with ready-made Ansible roles.
- **Backup & recovery solutions** 💾 - Automate data security and prevent loss
- **Infrastructure monitoring & maintenance** 📊 - Keep your system running optimally * **Enterprise-Grade Security** 🔒
Centralized user management via LDAP & OIDC (Keycloak), plus optional 2FA and encrypted storage.
* **Modular Scalability** 📈
Grow from small teams to global enterprises by composing only the services you need.
* **Fediverse & ActivityPub Support** 🌐
Seamlessly integrate Mastodon, Peertube, Matrix and other ActivityPub apps out of the box.
* **Self-Healing & Maintenance** ⚙️
Automated cleanup, container healing, and auto-updates keep infrastructure healthy without human intervention.
* **Monitoring, Alerting & Analytics** 📊
Built-in system, application, and security monitoring with multi-channel notifications.
* **Backup & Disaster Recovery** 💾
Scheduled backups and scripted recovery processes to safeguard your data.
* **Continuous Updates** 🔄
Automatic patching and version upgrades across the stack.
More informations about the features you will find [here](docs/overview/Features.md). More informations about the features you will find [here](docs/overview/Features.md).
---
## Get Started 🚀 ## Get Started 🚀
### Use it online 🌐 ### Use it online 🌐
@ -39,4 +57,15 @@ Give CyMaIS a spin at cymais.cloud sign up in seconds, click around, and see
3. **Explore Commands** with: 3. **Explore Commands** with:
```sh ```sh
cymais --help cymais --help
``` ```
---
## License ⚖️
CyMaIS is distributed under the **CyMaIS NonCommercial License**. Please see [LICENSE.md](LICENSE.md) for full terms.
---
## Professional Setup & Support 💼
For expert installation and configuration visit [cybermaster.space](https://cybermaster.space/) or write to us at **[contact@cymais.cloud](mailto:contact@cymais.cloud)**.