diff --git a/COMMON_APPLICATIONS.md b/COMMON_APPLICATIONS.md index a55d9058..37a3cdda 100644 --- a/COMMON_APPLICATIONS.md +++ b/COMMON_APPLICATIONS.md @@ -4,7 +4,7 @@ This section outlines the common applications tailored for both servers and end- ## Base Setup Key for initial system configuration, this section includes hostname setting, systemd journal management, locale configurations, and swapfile handling. Essential for both server and end-user setups, it ensures a solid foundation for system operations. -- **[Hostname](./roles/hostname/)**: Sets the system's hostname. +- **[Hostname](roles/hostname/)**: Sets the system's hostname. - **[Journalctl](./roles/journalctl/)**: Configures systemd journal settings. - **[Locales](./roles/locales/)**: Configures system locales. - **[System-Swapfile](./roles/system-swapfile/)**: Configures swapfile creation and management. diff --git a/LICENSE.md b/LICENSE.md index 084e0e6f..a141e5df 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,10 +1,11 @@ -# License Agreement - CyMaIS NonCommercial License (CNCL) +# License Agreement +## CyMaIS NonCommercial License (CNCL) -## Definitions +### Definitions - **"Software":** Refers to *"[CyMaIS - Cyber Master Infrastructure Solution](https://cymais.cloud/)"* and its associated source code. - **"Commercial Use":** Any use of the Software intended for direct or indirect financial gain, including but not limited to sales, rentals, or provision of services. -## Provisions +### Provisions 1. **Attribution of the Original Licensor:** In any distribution or publication of the Software or derivative works, the original licensor, *Kevin Veen-Birkenbach, Email: [license@veen.world](mailto:license@veen.world), Website: [https://www.veen.world/](https://www.veen.world/)* must be explicitly named. @@ -23,5 +24,5 @@ 7. **Ownership of Rights:** All rights, including copyright, trademark, and other forms of intellectual property related to the Software, belong exclusively to Kevin Veen-Birkenbach. -## Consent +### Consent By using, modifying, or distributing the Software, you agree to these terms. \ No newline at end of file diff --git a/Makefile b/Makefile index bc9a7c7c..b0c4d2f6 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = . +SOURCEDIR = /home/kevinveenbirkenbach/Repositories/github.com/kevinveenbirkenbach/cymais/ BUILDDIR = docs # Put it first so that "make" without argument is like "make help". diff --git a/README.md b/README.md index 7be49436..fb7c2c1e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# CyMaIS - Cyber Master Infrastructure Solution +# CyMaIS +## Cyber Master Infrastructure Solution [![GitHub Sponsors](https://img.shields.io/badge/Sponsor-GitHub%20Sponsors-blue?logo=github)](https://github.com/sponsors/kevinveenbirkenbach) [![Patreon](https://img.shields.io/badge/Support-Patreon-orange?logo=patreon)](https://www.patreon.com/c/kevinveenbirkenbach) [![Buy Me a Coffee](https://img.shields.io/badge/Buy%20me%20a%20Coffee-Funding-yellow?logo=buymeacoffee)](https://buymeacoffee.com/kevinveenbirkenbach) [![PayPal](https://img.shields.io/badge/Donate-PayPal-blue?logo=paypal)](https://s.veen.world/paypaldonate) @@ -14,7 +15,7 @@ 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. -## Vision +### Vision Our project is anchored in the vision of transforming IT infrastructure deployment into a seamless, secure, and scalable experience. We are committed to developing a fully automated solution that enables businesses of any size and industry to set up a 100% secure and infinitely scalable IT infrastructure in just 24 hours. @@ -25,7 +26,7 @@ This is not just a step towards simplifying IT management – it's a leap toward For a deeper understanding of our goals and the ethos driving our project, we invite you to explore our detailed **[Vision Statement](./VISION_STATEMENT.md)**. Here, you'll find the cornerstone principles that guide our development process and our commitment to making a lasting impact in the realm of IT infrastructure. -## Solutions Overview +### Solutions Overview To help you navigate through our repository, we have categorized our extensive range of tools and solutions into three key areas: @@ -57,7 +58,7 @@ Each of these documents provides a tailored overview, ensuring you can find the 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 +### 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. @@ -72,11 +73,11 @@ Contact me for more details: 📧 Email: [kevin@veen.world](mailto:kevin@veen.world)
☎️ Phone: [+ 49 178 179 80 23](tel:00491781798023) -## Showcases +### Showcases The following list showcases the extensive range of solutions that CyMaIS incorporates, each playing a vital role in providing a comprehensive, efficient, and secure IT infrastructure setup: [ELK Stack](./roles/docker-elk), [Intel Driver](./roles/driver-intel), [Nginx Docker Reverse Proxy](./roles/nginx-docker-reverse-proxy), [Sudo](./roles/sudo), [Funkwhale](./roles/docker-funkwhale), [MSI Keyboard Color Driver](./roles/driver-msi-keyboard-color), [Nginx Domain Redirect](./roles/nginx-redirect-domain), [GnuCash](./roles/pc-gnucash), [Backup Data to USB](./roles/backup-data-to-usb), [Gitea](./roles/docker-gitea), [Non-Free Driver](./roles/driver-non-free), [Nginx Homepage](./roles/nginx-serve-html), [Jrnl](./roles/pc-jrnl), [Systemd Notifier](./roles/systemd-notifier), [Backup Docker to Local](./roles/backup-docker-to-local), [Jenkins](./roles/docker-jenkins), [Git](./roles/git), [Nginx HTTPS](./roles/nginx-https), [Latex](./roles/pc-latex), [Email Notifier](./roles/systemd-notifier-email), [Remote to Local Backup Solution](./roles/backup-remote-to-local), [Joomla](./roles/docker-joomla), [Heal Defect Docker Installations](./roles/heal-docker), [Nginx Matomo Tracking](./roles/nginx-modifier-matomo), [LibreOffice](./roles/pc-libreoffice), [Telegram Notifier](./roles/systemd-notifier-telegram), [Listmonk](./roles/docker-listmonk), [Btrfs Health Check](./roles/health-btrfs), [Nginx WWW Redirect](./roles/nginx-redirect-www), [Network Analyze Tools](./roles/pc-network-analyze-tools), [System Security](./roles/system-security), [Mailu](./roles/docker-mailu), [Disc Space Health Check](./roles/health-disc-space), [Administrator Tools](./roles/pc-administrator-tools), [Nextcloud Client](./roles/pc-nextcloud), [Swapfile Setup](./roles/system-swapfile), [Backups Cleanup](./roles/cleanup-backups-service), [Mastodon](./roles/docker-mastodon), [Docker Container Health Checker](./roles/health-docker-container), [Blu-ray Player Tools](./roles/pc-bluray-player-tools), [Office](./roles/pc-office), [Update Solutions](./roles/update), [Matomo](./roles/docker-matomo), [Docker Volumes Health Checker](./roles/health-docker-volumes), [Caffeine](./roles/pc-caffeine), [Qbittorrent](./roles/pc-qbittorrent), [Update Apt](./roles/update-apt), [Disc Space Cleanup](./roles/cleanup-disc-space), [Matrix](./roles/docker-matrix), [Health Journalctl](./roles/health-journalctl), [Designer Tools](./roles/pc-designer-tools), [Security Tools](./roles/pc-security-tools), [Update Docker](./roles/update-docker), [Failed Docker Backups Cleanup](./roles/cleanup-failed-docker-backups), [MediaWiki](./roles/docker-mediawiki), [Nginx Health Checker](./roles/health-nginx), [Developer Tools](./roles/pc-developer-tools), [Spotify](./roles/pc-spotify), [Update Pacman](./roles/update-pacman), [Client Wireguard](./roles/client-wireguard), [MyBB](./roles/docker-mybb), [Developer Tools for Arduino](./roles/pc-developer-tools-arduino), [SSH](./roles/pc-ssh), [Update Yay](./roles/update-yay), [Client Setup for Wireguard Behind Firewall](./roles/client-wireguard-behind-firewall), [Nextcloud Server](./roles/docker-nextcloud), [Hunspell](./roles/hunspell), [Developer Tools for Bash](./roles/pc-developer-tools-bash), [Streaming Tools](./roles/pc-streaming-tools), [Administrator](./roles/user-administrator), [Docker](./roles/docker), [Peertube](./roles/docker-peertube), [Java](./roles/java), [Developer Tools for Java](./roles/pc-developer-tools-java), [Tor Browser](./roles/pc-torbrowser), [Video Conference](./roles/pc-video-conference), [Wireguard](./roles/wireguard), [Akaunting](./roles/docker-akaunting), [Pixelfed](./roles/docker-pixelfed), [Journalctl](./roles/journalctl), [Developer Tools for PHP](./roles/pc-developer-tools-php), [Virtual Box](./roles/pc-virtual-box), [Postfix](./roles/postfix), [Attendize](./roles/docker-attendize), [Wordpress](./roles/docker-wordpress), [Locales](./roles/locales), [Docker for End Users](./roles/pc-docker), [Games](./roles/pc-games), [Python Pip](./roles/python-pip), [Discourse](./roles/docker-discourse), [Epson Multiprinter Driver](./roles/driver-epson-multiprinter), [Nginx Certbot](./roles/nginx-certbot), [Git](./roles/pc-git), [SSHD](./roles/sshd), [YOURLS](./roles/docker-yourls), [BigBlueButton](./roles/docker-bigbluebutton),[System Maintenance Lock](./roles/system-maintenance-lock),[Open Project](./roles/docker-openproject)... -## License +### 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/conf.py b/conf.py index 518737af..8aaebfba 100644 --- a/conf.py +++ b/conf.py @@ -42,20 +42,21 @@ source_suffix = { '.md': 'markdown', } -# Erweiterungen hinzufügen – MyST-Parser aktivieren: extensions = [ - 'myst_parser', - # ... andere Extensions + "sphinx.ext.autosummary", + "sphinx.ext.autodoc", + "myst_parser", ] +autosummary_generate = True # Optional: Zusätzliche MyST-Konfigurationen myst_enable_extensions = [ "colon_fence", # Für erweiterte Syntax wie ::: Hinweisboxen etc. # weitere Erweiterungen nach Bedarf ] - -myst_xref_ignore = [ - r"\./roles/.*", - "../" -] +# +#myst_xref_ignore = [ +# r"\./roles/.*", +# "../" +#] diff --git a/index.rst b/index.rst index 222120b9..59d30c15 100644 --- a/index.rst +++ b/index.rst @@ -1,21 +1,10 @@ -.. CyMaIS - Cyber Master Infrastructure Solution documentation master file, created by - sphinx-quickstart on Fri Mar 14 14:55:53 2025. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -CyMaIS - Cyber Master Infrastructure Solution documentation +.. CyMaIS - Cyber Master Infrastructure Solution documentation =========================================================== -Add your content using ``reStructuredText`` syntax. See the -`reStructuredText `_ -documentation for details. - - .. toctree:: :maxdepth: 5 :caption: Index: :glob: + :titlesonly: - **/*.md - - + **