Restructured mds

This commit is contained in:
Kevin Veen-Birkenbach 2025-04-09 17:57:57 +02:00
parent 72becedee5
commit 385e582fc6
No known key found for this signature in database
GPG Key ID: 44D8F11FD62F878E
15 changed files with 38 additions and 41 deletions

View File

@ -1,4 +1,4 @@
# Author # Contact
<img src="https://cybermaster.space/wp-content/uploads/sites/7/2023/11/FVG_8364BW-scaled.jpg" width="300" style="float: right; margin-left: 30px;"> <img src="https://cybermaster.space/wp-content/uploads/sites/7/2023/11/FVG_8364BW-scaled.jpg" width="300" style="float: right; margin-left: 30px;">

View File

@ -1,12 +1,12 @@
# Administrator Guide 🖥️ # Administrator Guide
This guide is for **system administrators** who are deploying and managing CyMaIS infrastructure. This guide is for **system administrators** who are deploying and managing CyMaIS infrastructure.
## Setting Up CyMaIS 🏗️ ## Setting Up CyMaIS 🏗️
Follow these guides to install and configure CyMaIS: Follow these guides to install and configure CyMaIS:
- [Setup Guide](07_SETUP_GUIDE.md) - [Setup Guide](SETUP_GUIDE.md)
- [Configuration Guide](08_CONFIGURATION.md) - [Configuration Guide](CONFIGURATION.md)
- [Deployment Guide](09_DEPLOY.md) - [Deployment Guide](DEPLOY.md)
## Key Responsibilities 🔧 ## Key Responsibilities 🔧
- **User Management** - Configure LDAP, Keycloak, and user permissions. - **User Management** - Configure LDAP, Keycloak, and user permissions.

View File

@ -2,33 +2,7 @@
CyMaIS is designed with security in mind. However, while following our guidelines can greatly improve your systems security, no IT system can be 100% secure. Please report any vulnerabilities as soon as possible. CyMaIS is designed with security in mind. However, while following our guidelines can greatly improve your systems security, no IT system can be 100% secure. Please report any vulnerabilities as soon as possible.
--- Additional to the user securitry guidelines administrators have additional responsibilities to secure the entire system:
## For End Users
For optimal personal security, we **strongly recommend** the following:
- **Use a Password Manager**
Use a reliable password manager such as [KeePass](https://keepass.info/) 🔐. (Learn more about [password managers](https://en.wikipedia.org/wiki/Password_manager) on Wikipedia.) KeePass is available for both smartphones and PCs, and it can automatically generate strong, random passwords.
- **Enable Two-Factor Authentication (2FA)**
Always enable 2FA whenever possible. Many password managers (like KeePass) can generate [TOTP](https://en.wikipedia.org/wiki/Time-based_One-Time_Password) tokens, adding an extra layer of security even if your password is compromised.
Synchronize your password database across devices using the [Nextcloud Client](https://nextcloud.com/) 📱💻.
- **Use Encrypted Systems**
We recommend running CyMaIS only on systems with full disk encryption. For example, Linux distributions such as [Manjaro](https://manjaro.org/) (based on ArchLinux) with desktop environments like [GNOME](https://en.wikipedia.org/wiki/GNOME) provide excellent security. (Learn more about [disk encryption](https://en.wikipedia.org/wiki/Disk_encryption) on Wikipedia.)
- **Beware of Phishing and Social Engineering**
Always verify email senders, avoid clicking on unknown links, and never share your passwords or 2FA codes with anyone. (Learn more about [Phishing](https://en.wikipedia.org/wiki/Phishing) and [Social Engineering](https://en.wikipedia.org/wiki/Social_engineering_(security)) on Wikipedia.)
Following these guidelines will significantly enhance your personal security—but remember, no system is completely immune to risk.
A tutorial how to setup secure password management you will find [here](https://blog.veen.world/blog/2025/04/04/%f0%9f%9b%a1%ef%b8%8f-keepassxc-cymais-cloud-the-ultimate-guide-to-cross-device-password-security/)
---
## For Administrators
Administrators have additional responsibilities to secure the entire system:
- **Deploy on an Encrypted Server** - **Deploy on an Encrypted Server**
It is recommended to install CyMaIS on an encrypted server to prevent hosting providers from accessing end-user data. For a practical guide on setting up an encrypted server, refer to the [Hetzner Arch LUKS repository](https://github.com/kevinveenbirkenbach/hetzner-arch-luks) 🔐. (Learn more about [disk encryption](https://en.wikipedia.org/wiki/Disk_encryption) on Wikipedia.) It is recommended to install CyMaIS on an encrypted server to prevent hosting providers from accessing end-user data. For a practical guide on setting up an encrypted server, refer to the [Hetzner Arch LUKS repository](https://github.com/kevinveenbirkenbach/hetzner-arch-luks) 🔐. (Learn more about [disk encryption](https://en.wikipedia.org/wiki/Disk_encryption) on Wikipedia.)

View File

@ -1,4 +1,4 @@
# Customer Guide 📋 # Customer Guide
Are you looking for a **reliable IT infrastructure** for your business or organization? **CyMaIS** is here to help! Are you looking for a **reliable IT infrastructure** for your business or organization? **CyMaIS** is here to help!

View File

@ -7,8 +7,8 @@ Explore CyMaIS Solutions
------------------------ ------------------------
CyMaIS offers various solutions for IT infrastructure automation. Learn more about the available applications: CyMaIS offers various solutions for IT infrastructure automation. Learn more about the available applications:
- :doc:`roles/application_glosar` - :doc:`../../../roles/application_glosar`
- :doc:`roles/application_categories` - :doc:`../../../roles/application_categories`
For Developers For Developers
-------------- --------------
@ -18,7 +18,7 @@ Understanding Ansible Roles
CyMaIS is powered by **Ansible** roles to automate deployments. Developers can explore the technical details of our roles here: CyMaIS is powered by **Ansible** roles to automate deployments. Developers can explore the technical details of our roles here:
- :doc:`roles/ansible_role_glosar` - :doc:`../../../roles/ansible_role_glosar`
Contributing to CyMaIS Contributing to CyMaIS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -37,8 +37,8 @@ Contribution Guidelines
For detailed guidelines, refer to: For detailed guidelines, refer to:
- :doc:`CONTRIBUTING` - :doc:`../../../CONTRIBUTING`
- :doc:`CODE_OF_CONDUCT` - :doc:`../../../CODE_OF_CONDUCT`
Community & Support Community & Support
------------------- -------------------

View File

@ -1,4 +1,4 @@
# Investor Information 💰 # Investor Guide
🚀 **CyMaIS is seeking investors** to expand its reach and continue development. With an increasing demand for automated IT solutions, **CyMaIS has the potential to revolutionize IT infrastructure management.** 🚀 **CyMaIS is seeking investors** to expand its reach and continue development. With an increasing demand for automated IT solutions, **CyMaIS has the potential to revolutionize IT infrastructure management.**

View File

@ -1,4 +1,4 @@
# Enterprise Solutions 🏢 # Enterprise Solutions
**CyMaIS** provides powerful **enterprise-grade IT infrastructure solutions**, enabling businesses to scale securely and efficiently. **CyMaIS** provides powerful **enterprise-grade IT infrastructure solutions**, enabling businesses to scale securely and efficiently.

View File

@ -1,4 +1,4 @@
# User Guide 📖 # User Guide
Welcome to **CyMaIS**! This guide is designed for **end-users** who want to use cloud services, email, and collaboration tools securely and efficiently. Whether you're an **enterprise user** or an **individual**, CyMaIS provides a wide range of services tailored to your needs. Welcome to **CyMaIS**! This guide is designed for **end-users** who want to use cloud services, email, and collaboration tools securely and efficiently. Whether you're an **enterprise user** or an **individual**, CyMaIS provides a wide range of services tailored to your needs.

View File

@ -0,0 +1,23 @@
# Security Guidelines
CyMaIS is designed with security in mind. However, while following our guidelines can greatly improve your systems security, no IT system can be 100% secure. Please report any vulnerabilities as soon as possible.
For optimal personal security, we **strongly recommend** the following:
- **Use a Password Manager**
Use a reliable password manager such as [KeePass](https://keepass.info/) 🔐. (Learn more about [password managers](https://en.wikipedia.org/wiki/Password_manager) on Wikipedia.) KeePass is available for both smartphones and PCs, and it can automatically generate strong, random passwords.
- **Enable Two-Factor Authentication (2FA)**
Always enable 2FA whenever possible. Many password managers (like KeePass) can generate [TOTP](https://en.wikipedia.org/wiki/Time-based_One-Time_Password) tokens, adding an extra layer of security even if your password is compromised.
Synchronize your password database across devices using the [Nextcloud Client](https://nextcloud.com/) 📱💻.
- **Use Encrypted Systems**
We recommend running CyMaIS only on systems with full disk encryption. For example, Linux distributions such as [Manjaro](https://manjaro.org/) (based on ArchLinux) with desktop environments like [GNOME](https://en.wikipedia.org/wiki/GNOME) provide excellent security. (Learn more about [disk encryption](https://en.wikipedia.org/wiki/Disk_encryption) on Wikipedia.)
- **Beware of Phishing and Social Engineering**
Always verify email senders, avoid clicking on unknown links, and never share your passwords or 2FA codes with anyone. (Learn more about [Phishing](https://en.wikipedia.org/wiki/Phishing) and [Social Engineering](https://en.wikipedia.org/wiki/Social_engineering_(security)) on Wikipedia.)
Following these guidelines will significantly enhance your personal security—but remember, no system is completely immune to risk.
A tutorial how to setup secure password management you will find [here](https://blog.veen.world/blog/2025/04/04/%f0%9f%9b%a1%ef%b8%8f-keepassxc-cymais-cloud-the-ultimate-guide-to-cross-device-password-security/)
---