From 281413d571c68a24569e160456ce23f385752f1a Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Sun, 16 Mar 2025 23:57:42 +0100 Subject: [PATCH] Refactored documentation --- 01_FEATURES.md | 19 +++++++++++++++++++ VISION.md => 02_VISION.md | 0 03_INSTALLATION.md | 9 +++++++++ SETUP.md => 04_SETUP.md | 10 +++++----- 05_ENTERPRISE.md | 14 ++++++++++++++ README.md | 35 ----------------------------------- index.rst | 2 +- roles/categories.rst | 2 +- sphinx/local_md_files.py | 12 +++++------- 9 files changed, 54 insertions(+), 49 deletions(-) create mode 100644 01_FEATURES.md rename VISION.md => 02_VISION.md (100%) create mode 100644 03_INSTALLATION.md rename SETUP.md => 04_SETUP.md (83%) create mode 100644 05_ENTERPRISE.md diff --git a/01_FEATURES.md b/01_FEATURES.md new file mode 100644 index 00000000..52c4b0ff --- /dev/null +++ b/01_FEATURES.md @@ -0,0 +1,19 @@ +# Features + +**CyMaIS - Cyber Master Infrastructure Solution** revolutionizes IT infrastructure management, making it simpler, safer, and more adaptable for businesses of all sizes. Here's how it can benefit your organization: + +1. **Effortless Setup and Management**: CyMaIS makes setting up and managing IT systems a breeze. Whether you're using Linux servers or personal computers, our tool automates the process, saving you time and effort. + +2. **Everything You Need in One Place**: From the basics of system setup to advanced features like VPN and Docker, CyMaIS provides a complete range of tools. It's like having an IT expert at your fingertips, offering solutions for every need. + +3. **Tailored to Your Business**: We understand that every business is unique. That's why CyMaIS is designed to be flexible, with customizable options to fit your specific requirements, whether you're a start-up, a growing business, or an established enterprise. + +4. **Stay Ahead with Proactive Monitoring**: Our tool doesn't just set up your IT infrastructure; it keeps it running smoothly. With automated updates and proactive monitoring, you can rest assured that your systems are always up-to-date and performing optimally. + +5. **Uncompromised Security and Reliability**: Protecting your data is our top priority. CyMaIS comes with robust security features and comprehensive backup solutions, giving you peace of mind that your business's sensitive information is safe and secure. + +6. **User-Friendly with Expert Support**: While familiarity with Docker, Linux, and Ansible enhances your experience with CyMaIS, it's not a requirement. Our comprehensive roles for servers and end-user PCs simplify the setup process. With these intuitive tools and our detailed guides, managing your IT infrastructure becomes more accessible, even if you're not a seasoned IT professional. Plus, our support team is always ready to assist you, bridging any knowledge gaps and ensuring a smooth operation of your systems. + +7. **Open Source Trust and Transparency**: With CyMaIS, you benefit from the reliability and security of open-source software. Our tool is transparent, community-driven, and aligned with the highest standards of software ethics and security. + +CyMaIS is more than just an IT solution; it's a commitment to empowering your business with the technology it needs to thrive in today’s digital landscape, effortlessly and securely. \ No newline at end of file diff --git a/VISION.md b/02_VISION.md similarity index 100% rename from VISION.md rename to 02_VISION.md diff --git a/03_INSTALLATION.md b/03_INSTALLATION.md new file mode 100644 index 00000000..cfd252b4 --- /dev/null +++ b/03_INSTALLATION.md @@ -0,0 +1,9 @@ +# Installation + +CyMaIS can be easily installed using [Kevin's Package Manager](https://github.com/kevinveenbirkenbach/package-manager). Once you have the package manager set up, simply run: + +```bash +pkgmgr install cymais +``` + +This command will install CyMaIS on your system with the alias **cymais**. \ No newline at end of file diff --git a/SETUP.md b/04_SETUP.md similarity index 83% rename from SETUP.md rename to 04_SETUP.md index fb13d5e4..17acf6eb 100644 --- a/SETUP.md +++ b/04_SETUP.md @@ -67,28 +67,28 @@ To deploy CyMaIS on your servers, use an Ansible playbook that targets your serv ### Configure All Servers ```bash -ansible-playbook -i /path/to/your/inventory/servers.yml /path/to/cymais/playbook.servers.yml --ask-vault-pass +ansible-playbook -i /path/to/your/inventory/servers.yml "$(pkgmgr path cymais)playbook.servers.yml" --ask-vault-pass ``` ### Configure a Specific Server For example, to target a server named `galaxyserver`: ```bash -ansible-playbook -i /path/to/your/inventory/servers.tmp /path/to/cymais/playbook.servers.yml --limit galaxyserver --ask-vault-pass +ansible-playbook -i /path/to/your/inventory/servers.tmp "$(pkgmgr path cymais)playbook.servers.yml" --limit galaxyserver --ask-vault-pass ``` ### Run in Temporary Mode Without Update ```bash -ansible-playbook -i /path/to/your/inventory/servers.tmp /path/to/cymais/playbook.servers.yml --limit galaxyserver -e "mode_update=false" --ask-vault-pass +ansible-playbook -i /path/to/your/inventory/servers.tmp "$(pkgmgr path cymais)playbook.servers.yml" --limit galaxyserver -e "mode_update=false" --ask-vault-pass ``` ### Run Without Update and Backup ```bash -ansible-playbook -i /path/to/your/inventory/servers.tmp /path/to/cymais/playbook.servers.yml --limit galaxyserver -e "mode_update=false" -e "mode_backup=false" --ask-vault-pass +ansible-playbook -i /path/to/your/inventory/servers.tmp "$(pkgmgr path cymais)playbook.servers.yml" --limit galaxyserver -e "mode_update=false" -e "mode_backup=false" --ask-vault-pass ``` ### Run with Cleanup and Debug (Using a Vault Password File) ```bash -ansible-playbook -i /path/to/your/inventory/servers.tmp /path/to/cymais/playbook.servers.yml --limit galaxyserver -e "mode_update=false" -e "mode_backup=false" -e "mode_cleanup=true" -e "enable_debug=true" -v --vault-password-file /path/to/your/vault_pass.txt +ansible-playbook -i /path/to/your/inventory/servers.tmp "$(pkgmgr path cymais)playbook.servers.yml" --limit galaxyserver -e "mode_update=false" -e "mode_backup=false" -e "mode_cleanup=true" -e "enable_debug=true" -v --vault-password-file /path/to/your/vault_pass.txt ``` --- diff --git a/05_ENTERPRISE.md b/05_ENTERPRISE.md new file mode 100644 index 00000000..c70a301b --- /dev/null +++ b/05_ENTERPRISE.md @@ -0,0 +1,14 @@ +# Enterprise Solutions + + +My name is Kevin Veen-Birkenbach and I'm glad to assist you in the implementation of your secure and scalable IT infrastrucutre solution with CyMaIS. + +My expertise in server administration, digital corporate infrastructure, custom software, and information security, all underpinned by a commitment to Open Source solutions, guarantees that your IT setup meets the highest industry standards. + +Discover how CyMaIS can transform your IT landscape. + +Contact me for more details: + +🌍 Website: [www.CyberMaster.Space](https://cybermaster.space)
+📧 Email: [kevin@veen.world](mailto:kevin@veen.world)
+☎️ Phone: [+ 49 178 179 80 23](tel:00491781798023) \ No newline at end of file diff --git a/README.md b/README.md index 528b2d9f..7ce90c98 100644 --- a/README.md +++ b/README.md @@ -14,41 +14,6 @@ Our intuitive interface, coupled with in-depth documentation, makes it accessibl With CyMaIS, setting up a secure, scalable, and robust IT infrastructure is not just faster and easier, but also aligned with the best industry practices, ensuring that your organization stays ahead in the ever-evolving digital landscape. -## Key Benefits of CyMaIS for Your Business - -**CyMaIS - Cyber Master Infrastructure Solution** revolutionizes IT infrastructure management, making it simpler, safer, and more adaptable for businesses of all sizes. Here's how it can benefit your organization: - -1. **Effortless Setup and Management**: CyMaIS makes setting up and managing IT systems a breeze. Whether you're using Linux servers or personal computers, our tool automates the process, saving you time and effort. - -2. **Everything You Need in One Place**: From the basics of system setup to advanced features like VPN and Docker, CyMaIS provides a complete range of tools. It's like having an IT expert at your fingertips, offering solutions for every need. - -3. **Tailored to Your Business**: We understand that every business is unique. That's why CyMaIS is designed to be flexible, with customizable options to fit your specific requirements, whether you're a start-up, a growing business, or an established enterprise. - -4. **Stay Ahead with Proactive Monitoring**: Our tool doesn't just set up your IT infrastructure; it keeps it running smoothly. With automated updates and proactive monitoring, you can rest assured that your systems are always up-to-date and performing optimally. - -5. **Uncompromised Security and Reliability**: Protecting your data is our top priority. CyMaIS comes with robust security features and comprehensive backup solutions, giving you peace of mind that your business's sensitive information is safe and secure. - -6. **User-Friendly with Expert Support**: While familiarity with Docker, Linux, and Ansible enhances your experience with CyMaIS, it's not a requirement. Our comprehensive roles for servers and end-user PCs simplify the setup process. With these intuitive tools and our detailed guides, managing your IT infrastructure becomes more accessible, even if you're not a seasoned IT professional. Plus, our support team is always ready to assist you, bridging any knowledge gaps and ensuring a smooth operation of your systems. - -7. **Open Source Trust and Transparency**: With CyMaIS, you benefit from the reliability and security of open-source software. Our tool is transparent, community-driven, and aligned with the highest standards of software ethics and security. - -CyMaIS is more than just an IT solution; it's a commitment to empowering your business with the technology it needs to thrive in today’s digital landscape, effortlessly and securely. - -## Professional CyMaIS Implementation - - -My name is Kevin Veen-Birkenbach and I'm glad to assist you in the implementation of your secure and scalable IT infrastrucutre solution with CyMaIS. - -My expertise in server administration, digital corporate infrastructure, custom software, and information security, all underpinned by a commitment to Open Source solutions, guarantees that your IT setup meets the highest industry standards. - -Discover how CyMaIS can transform your IT landscape. - -Contact me for more details: - -🌍 Website: [www.CyberMaster.Space](https://cybermaster.space)
-📧 Email: [kevin@veen.world](mailto:kevin@veen.world)
-☎️ Phone: [+ 49 178 179 80 23](tel:00491781798023) - ## License This project is licensed from Kevin Veen-Birkenbach. The full license is available in the [LICENSE.md](./LICENSE.md) of this repository. diff --git a/index.rst b/index.rst index 50658d53..af003507 100644 --- a/index.rst +++ b/index.rst @@ -1,4 +1,4 @@ -Cyber Master Infrastructure Solution documentation +Overview =========================================================== .. toctree:: diff --git a/roles/categories.rst b/roles/categories.rst index e94d5413..a05e35ec 100644 --- a/roles/categories.rst +++ b/roles/categories.rst @@ -1,4 +1,4 @@ -Applications by Category +Application Categories ========================= .. roles-overview:: \ No newline at end of file diff --git a/sphinx/local_md_files.py b/sphinx/local_md_files.py index db3053bf..eb74cff9 100644 --- a/sphinx/local_md_files.py +++ b/sphinx/local_md_files.py @@ -75,11 +75,7 @@ def group_headings(headings): return tree def sort_tree(tree): - """ - Sorts a list of headings (and their children) first by their 'priority' (default 1) - and then by the natural sort key of their text. - """ - tree.sort(key=lambda x: (x.get('priority', 1), natural_sort_key(x['text']))) + tree.sort(key=lambda x: (x.get('priority', 1), natural_sort_key(x.get('filename', x['text'])))) def collect_nav_items(dir_path, base_url, current_depth, max_depth): """ @@ -150,7 +146,7 @@ def add_local_md_headings(app, pagename, templatename, context, doctree): filepath = os.path.join(abs_dir, file) headings = extract_headings_from_file(filepath) basename, _ = os.path.splitext(file) - # Set priority: index/readme files get priority 0. + # Setze Priorität: "index" und "readme" erhalten Priorität 0. if basename.lower() in ['index', 'readme']: priority = 0 else: @@ -162,8 +158,10 @@ def add_local_md_headings(app, pagename, templatename, context, doctree): 'text': heading['text'], 'link': file_link, 'anchor': heading['anchor'], - 'priority': priority + 'priority': priority, + 'filename': basename # Neues Feld zur Sortierung }) + # Combine current directory items with subdirectory nav items. # If an index or readme from the current directory exists, it will be included only once. all_items = local_md_headings + nav_items