mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-07-18 14:34:24 +02:00
Added README.md
This commit is contained in:
parent
a0a61ad304
commit
5cd94c1d0a
55
README.md
55
README.md
@ -1,29 +1,47 @@
|
|||||||
|
|
||||||
# IT-Infrastructure Automation Framework 🚀
|
# IT-Infrastructure Automation Framework 🚀
|
||||||
|
|
||||||
[](https://github.com/sponsors/kevinveenbirkenbach) [](https://www.patreon.com/c/kevinveenbirkenbach) [](https://buymeacoffee.com/kevinveenbirkenbach) [](https://s.veen.world/paypaldonate)
|
[](https://github.com/sponsors/kevinveenbirkenbach) [](https://www.patreon.com/c/kevinveenbirkenbach) [](https://buymeacoffee.com/kevinveenbirkenbach) [](https://s.veen.world/paypaldonate)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## 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 🌐
|
||||||
@ -40,3 +58,14 @@ Give CyMaIS a spin at cymais.cloud – sign up in seconds, click around, and see
|
|||||||
```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)**.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user