diff --git a/13_AUTHOR.md b/CONTACT.md similarity index 98% rename from 13_AUTHOR.md rename to CONTACT.md index e3696662..afaae654 100644 --- a/13_AUTHOR.md +++ b/CONTACT.md @@ -1,4 +1,4 @@ -# Author +# Contact diff --git a/12_DONATE.md b/DONATE.md similarity index 100% rename from 12_DONATE.md rename to DONATE.md diff --git a/08_CONFIGURATION.md b/docs/guides/administrator/Configuration.md similarity index 100% rename from 08_CONFIGURATION.md rename to docs/guides/administrator/Configuration.md diff --git a/09_DEPLOY.md b/docs/guides/administrator/Deploy.md similarity index 100% rename from 09_DEPLOY.md rename to docs/guides/administrator/Deploy.md diff --git a/06_ADMINISTRATOR_GUIDE.md b/docs/guides/administrator/Readme.md similarity index 86% rename from 06_ADMINISTRATOR_GUIDE.md rename to docs/guides/administrator/Readme.md index c1618c01..c69da29c 100644 --- a/06_ADMINISTRATOR_GUIDE.md +++ b/docs/guides/administrator/Readme.md @@ -1,12 +1,12 @@ -# Administrator Guide 🖥️ +# Administrator Guide This guide is for **system administrators** who are deploying and managing CyMaIS infrastructure. ## Setting Up CyMaIS 🏗️ Follow these guides to install and configure CyMaIS: -- [Setup Guide](07_SETUP_GUIDE.md) -- [Configuration Guide](08_CONFIGURATION.md) -- [Deployment Guide](09_DEPLOY.md) +- [Setup Guide](SETUP_GUIDE.md) +- [Configuration Guide](CONFIGURATION.md) +- [Deployment Guide](DEPLOY.md) ## Key Responsibilities 🔧 - **User Management** - Configure LDAP, Keycloak, and user permissions. diff --git a/03_SECURITY_GUIDELINES.md b/docs/guides/administrator/Security_Guidelines.md similarity index 57% rename from 03_SECURITY_GUIDELINES.md rename to docs/guides/administrator/Security_Guidelines.md index 64761e3a..32f54a6b 100644 --- a/03_SECURITY_GUIDELINES.md +++ b/docs/guides/administrator/Security_Guidelines.md @@ -2,33 +2,7 @@ CyMaIS is designed with security in mind. However, while following our guidelines can greatly improve your system’s security, no IT system can be 100% secure. Please report any vulnerabilities as soon as possible. ---- - -## 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: +Additional to the user securitry guidelines administrators have additional responsibilities to secure the entire system: - **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.) diff --git a/07_SETUP_GUIDE.md b/docs/guides/administrator/Setup_Guide.md similarity index 100% rename from 07_SETUP_GUIDE.md rename to docs/guides/administrator/Setup_Guide.md diff --git a/05_CUSTOMER_GUIDE.md b/docs/guides/customer/Readme.md similarity index 97% rename from 05_CUSTOMER_GUIDE.md rename to docs/guides/customer/Readme.md index 5608f6b1..b113ada1 100644 --- a/05_CUSTOMER_GUIDE.md +++ b/docs/guides/customer/Readme.md @@ -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! diff --git a/10_DEVELOPER_GUIDE.rst b/docs/guides/developer/index.rst similarity index 88% rename from 10_DEVELOPER_GUIDE.rst rename to docs/guides/developer/index.rst index fea09d30..7578c366 100644 --- a/10_DEVELOPER_GUIDE.rst +++ b/docs/guides/developer/index.rst @@ -7,8 +7,8 @@ Explore CyMaIS Solutions ------------------------ CyMaIS offers various solutions for IT infrastructure automation. Learn more about the available applications: -- :doc:`roles/application_glosar` -- :doc:`roles/application_categories` +- :doc:`../../../roles/application_glosar` +- :doc:`../../../roles/application_categories` 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: -- :doc:`roles/ansible_role_glosar` +- :doc:`../../../roles/ansible_role_glosar` Contributing to CyMaIS ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -37,8 +37,8 @@ Contribution Guidelines For detailed guidelines, refer to: -- :doc:`CONTRIBUTING` -- :doc:`CODE_OF_CONDUCT` +- :doc:`../../../CONTRIBUTING` +- :doc:`../../../CODE_OF_CONDUCT` Community & Support ------------------- diff --git a/11_INVESTOR_INFORMATIONS.md b/docs/guides/investors/Readme.md similarity index 96% rename from 11_INVESTOR_INFORMATIONS.md rename to docs/guides/investors/Readme.md index 836efb03..ac5f4d10 100644 --- a/11_INVESTOR_INFORMATIONS.md +++ b/docs/guides/investors/Readme.md @@ -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.** diff --git a/10_ENTERPRISE_SOLUTIONS.md b/docs/guides/user/Enterprise_Solutions.md similarity index 96% rename from 10_ENTERPRISE_SOLUTIONS.md rename to docs/guides/user/Enterprise_Solutions.md index 3a1f759b..1f8b31f0 100644 --- a/10_ENTERPRISE_SOLUTIONS.md +++ b/docs/guides/user/Enterprise_Solutions.md @@ -1,4 +1,4 @@ -# Enterprise Solutions 🏢 +# Enterprise Solutions **CyMaIS** provides powerful **enterprise-grade IT infrastructure solutions**, enabling businesses to scale securely and efficiently. diff --git a/04_USER_GUIDE.md b/docs/guides/user/Readme.md similarity index 99% rename from 04_USER_GUIDE.md rename to docs/guides/user/Readme.md index dbf3b5fd..6f50289f 100644 --- a/04_USER_GUIDE.md +++ b/docs/guides/user/Readme.md @@ -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. diff --git a/docs/guides/user/Security_Guidelines.md b/docs/guides/user/Security_Guidelines.md new file mode 100644 index 00000000..7f1fafc9 --- /dev/null +++ b/docs/guides/user/Security_Guidelines.md @@ -0,0 +1,23 @@ +# Security Guidelines + +CyMaIS is designed with security in mind. However, while following our guidelines can greatly improve your system’s 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/) +--- \ No newline at end of file diff --git a/01_FEATURES.md b/docs/overview/Features.md similarity index 100% rename from 01_FEATURES.md rename to docs/overview/Features.md diff --git a/02_VISION.md b/docs/overview/Vision.md similarity index 100% rename from 02_VISION.md rename to docs/overview/Vision.md