mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-07-18 14:34:24 +02:00
97 lines
5.0 KiB
Markdown
97 lines
5.0 KiB
Markdown
# IT-Infrastructure Automation Framework 🚀
|
||
|
||
**🔐 One login. ♾️ Infinite application**
|
||
|
||
*Automate the Provisioning of All Your Servers and Workstations with a Single Open‑Source Script!*
|
||
|
||
|
||
---
|
||
|
||
## 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.
|
||
|
||
| 📚 | 🔗 |
|
||
|---|---|
|
||
| 🌐 Try It Live | [](https://cymais.cloud) |
|
||
| 🔧 Request Your Setup | [](https://cybermaster.space) |
|
||
| 📖 About This Project | [](https://github.com/sponsors/kevinveenbirkenbach) [](https://github.com/kevinveenbirkenbach/cymais/actions/workflows/test-container.yml?query=branch%3Amaster) [](https://github.com/kevinveenbirkenbach/cymais) |
|
||
| ☕️ Support Us | [](https://www.patreon.com/c/kevinveenbirkenbach) [](https://buymeacoffee.com/kevinveenbirkenbach) [](https://s.veen.world/paypaldonate) [](https://github.com/sponsors/kevinveenbirkenbach) |
|
||
|
||
---
|
||
|
||
## Key Features 🎯
|
||
|
||
* **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.
|
||
|
||
* **Application Ecosystem** 🚀
|
||
A curated suite of self-hosted apps—from **project management**, **version control**, and **CI/CD** to **chat**, **video conferencing**, **CMS**, **e-learning**, **social networking**, and **e-commerce**—all seamlessly integrated.
|
||
|
||
More informations about the features you will find [here](docs/overview/Features.md).
|
||
|
||
---
|
||
|
||
## Get Started 🚀
|
||
|
||
### Use it online 🌐
|
||
|
||
Try [CyMaIS.Cloud](https://cymais.cloud) – sign up in seconds, explore the platform, and discover what our solution can do for you! 🚀🔧✨
|
||
|
||
### Install locally 💻
|
||
1. **Install CyMaIS** via [Kevin's Package Manager](https://github.com/kevinveenbirkenbach/package-manager)
|
||
2. **Setup CyMaIS** using:
|
||
```sh
|
||
pkgmgr install cymais
|
||
```
|
||
3. **Explore Commands** with:
|
||
```sh
|
||
cymais --help
|
||
```
|
||
---
|
||
|
||
### Setup with Docker🚢
|
||
|
||
Get CyMaIS up and running inside Docker in just a few steps. For detailed build options and troubleshooting, see the [Docker Guide](docs/Docker.md).
|
||
|
||
```bash
|
||
# 1. Build the Docker image: the Docker image:
|
||
docker build -t cymais:latest .
|
||
|
||
# 2. Run the CLI interactively:
|
||
docker run --rm -it cymais:latest 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)**.
|