diff --git a/README.md b/README.md index a492b8d7..c07a4000 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,47 @@ - # 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) +--- + ![CyMaIS Logo](assets/img/logo.png) ## 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 ๐Ÿ“– -- **[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 +**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. + +--- ## Key Features ๐ŸŽฏ -- **Automated IT deployment** ๐Ÿ“ฆ - Pre-built roles for server and PC setups -- **Enterprise-ready security** ๐Ÿ”’ - Supports LDAP, Keycloak, 2FA, and encrypted storage -- **Scalability & flexibility** ๐Ÿ“ˆ - Modular approach for small teams to large enterprises -- **Backup & recovery solutions** ๐Ÿ’พ - Automate data security and prevent loss -- **Infrastructure monitoring & maintenance** ๐Ÿ“Š - Keep your system running optimally + +* **Automated Deployment** ๐Ÿ“ฆ + Turn up servers and workstations in minutes with ready-made Ansible roles. + +* **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). +--- + ## Get Started ๐Ÿš€ ### 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: ```sh cymais --help - ``` \ No newline at end of file + ``` +--- + +## 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)**.