From 3a6f6970e3b4aaae1f14e352e61194e4e58d28e9 Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Wed, 13 Dec 2023 11:54:44 +0100 Subject: [PATCH] Restructured README.md --- COMMON_APPLICATIONS.md | 76 ++++++++++++ END_USER_APPLICATIONS.md | 43 +++++++ README.md | 252 ++++----------------------------------- SERVER_APPLICATIONS.md | 89 ++++++++++++++ VISION_STATEMENT.md | 9 ++ 5 files changed, 239 insertions(+), 230 deletions(-) create mode 100644 COMMON_APPLICATIONS.md create mode 100644 END_USER_APPLICATIONS.md create mode 100644 SERVER_APPLICATIONS.md create mode 100644 VISION_STATEMENT.md diff --git a/COMMON_APPLICATIONS.md b/COMMON_APPLICATIONS.md new file mode 100644 index 00000000..bf672e12 --- /dev/null +++ b/COMMON_APPLICATIONS.md @@ -0,0 +1,76 @@ +### Base Setup + +Provides essential configurations for system initialization, including hostname setting, systemd journal management, locale configurations, and swapfile handling. + +- **[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. + +### Administration Tools + +Includes necessary tools for effective system administration, such as Git setup, Linux admin tools, and sudo configuration. + +- **[Git](./roles/git/)**: Basic Git version control system setup. +- **[PC-Administrator-Tools](./roles/pc-administrator-tools/)**: Installs basic Linux administration tools. +- **[Sudo](./roles/sudo/)**: Installs and configures sudo. + +### Update +Covers automated updates and maintenance for the system and its components, including package managers and Docker containers. +- **[update](./roles/update/)**: Automates the process of system updates. +- **[update-apt](./roles/update-apt/)**: Updates system packages using apt (for Debian-based systems). +- **[update-docker](./roles/update-docker/)**: Keeps Docker containers up to date. +- **[update-pacman](./roles/update-pacman/)**: Updates system packages using Pacman (for Arch-based systems). +- **[update-yay](./roles/update-yay/)**: Updates system packages using yay. + +### Driver +Deals with the installation and configuration of various hardware drivers, catering to a range of devices and needs. +- **[driver-epson-multiprinter](./roles/driver-epson-multiprinter/)**: Installs drivers for Epson multi-function printers. +- **[driver-intel](./roles/driver-intel/)**: Installs Intel drivers, typically for graphics and other hardware. +- **[driver-msi-keyboard-color](./roles/driver-msi-keyboard-color/)**: Configures MSI keyboard color settings. +- **[driver-non-free](./roles/driver-non-free/)**: Installs non-free drivers, generally for specific hardware needs. + +### Security +Enhances system security through roles focused on security measures, swap file management, user configurations, and SSH settings. +- **[System Security](./roles/system-security/)**: Enhances overall system security. +- **[System Swapfile](./roles/system-swapfile/)**: Manages swap files for system memory. +- **[User Administrator](./roles/user-administrator/)**: Setup for system administrator user. +- **[User Alarm](./roles/user-alarm/)**: Manages the alarm user. +- **[PC SSH](./roles/pc-ssh/)**: Configuration of SSH for secure remote access. +- **[SSHD](./roles/sshd/)**: Configures SSH daemon settings. + +### Virtual Private Network (VPN) +Centers on VPN configurations, specifically for Wireguard, providing secure and efficient network connectivity. +- **[client-wireguard](./roles/client-wireguard/)**: Configures Wireguard VPN client. +- **[client-wireguard-behind-firewall](./roles/client-wireguard-behind-firewall/)**: Sets up Wireguard client functionality behind a firewall. +- **[wireguard](./roles/wireguard/)**: Installs and configures Wireguard for secure VPN connections. + +#### Notifier +Introduces roles for setting up system event notifications, with options for email and Telegram alerts. +- **[Systemd-Notifier](./roles/systemd-notifier/)**: Notifier service for systemd. +- **[Systemd-Notifier-Email](./roles/systemd-notifier-email/)**: Email notifications for systemd services. +- **[Systemd-Notifier-Telegram](./roles/systemd-notifier-telegram/)**: Telegram notifications for systemd services. + +### Backup Solutions +Focuses on comprehensive backup strategies and cleanup procedures, encompassing data backups, remote server backups, and maintenance of backup storage efficiency. + +#### Backups +- **[backup-data-to-usb](./roles/backup-data-to-usb/)**: Automates data backup to USB devices. +- **[backup-docker-to-local](./roles/backup-docker-to-local/)**: Backs up Docker volumes to local storage. +- **[backup-remote-to-local](./roles/backup-remote-to-local/)**: Pulls backups from remote servers for local storage. +- **[backups-provider](./roles/backups-provider/)**: Manages backup processes and storage solutions. +- **[backups-provider-user](./roles/backups-provider-user/)**: Creates and configures users for backup processes. + +#### Backups Cleanup +- **[cleanup-backups-service](./roles/cleanup-backups-service/)**: Service to clean up old backups automatically. +- **[cleanup-backups-timer](./roles/cleanup-backups-timer/)**: Timer for scheduling the backup cleanup service. +- **[cleanup-disc-space](./roles/cleanup-disc-space/)**: Manages and frees up disk space on the system. +- **[cleanup-failed-docker-backups](./roles/cleanup-failed-docker-backups/)**: Cleans up failed Docker backups. + +### Other +Encompasses miscellaneous essential tools and systems, including AUR helper, spellchecking, typesetting, and package management. +- **[System-Aur-Helper](./roles/system-aur-helper/)**: Installs and configures AUR helper (yay). +- **[Hunspell](./roles/hunspell/)**: Installation of Hunspell spellchecker. +- **[Latex](./roles/pc-latex/)**: Installation of LaTeX typesetting system. +- **[Java](./roles/java/)**: Installs Java Development Kit (JDK). +- **[Python Pip](./roles/python-pip/)**: Installation of Python Pip package manager. diff --git a/END_USER_APPLICATIONS.md b/END_USER_APPLICATIONS.md new file mode 100644 index 00000000..89f0c05c --- /dev/null +++ b/END_USER_APPLICATIONS.md @@ -0,0 +1,43 @@ +### Desktop and Personal Computing +Offers a range of tools and software to enhance the personal computing experience on desktops and laptops, covering multimedia, productivity, and virtualization. + +#### Desktop +This category focuses on tools and configurations that enhance the desktop computing experience. It includes utilities to maintain system activity, and software for optimizing the desktop environment, ensuring a seamless and user-friendly interface for day-to-day computer usage. +- **[PC Caffeine](./roles/pc-caffeine/)**: Utility to keep your computer awake. +- **[PC Gnome](./roles/pc-gnome/)**: Installation and configuration of Gnome desktop environment. + +#### Entertainment +Geared towards leisure and entertainment, this section includes software for playing Blu-ray media, accessing a vast collection of music, and installing various computer games. It's designed to enrich your personal computing experience with multimedia enjoyment and gaming. +- **[PC Bluray Player Tools](./roles/pc-bluray-player-tools/)**: Software for playing Blu-ray media on personal computers. +- **[PC Spotify](./roles/pc-spotify/)**: Installation of Spotify for music streaming. +- **[PC Games](./roles/pc-games/)**: Installation of various computer games. + +#### Office +This segment caters to professional productivity needs. It encompasses a range of office-related software, from comprehensive office suites and video conferencing tools to cloud storage solutions, facilitating efficient and organized work in various office environments. +- **[PC LibreOffice](./roles/pc-libreoffice/)**: Installation of the LibreOffice suite. +- **[PC Office](./roles/pc-office/)**: Various office productivity tools. +- **[PC Video Conference](./roles/pc-video-conference/)**: Video conferencing software setup. +- **[PC Nextcloud](./roles/pc-nextcloud/)**: Client setup for Nextcloud cloud storage service. +- **[PC GnuCash](./roles/pc-gnucash/)**: Software to manage finances +- **[PC Jrnl](./roles/pc-jrnl/)**: CLI Journaling + +#### Anonymization +Focusing on privacy and security, the Anonymization section offers tools for secure file sharing and anonymous web browsing. It includes software solutions that prioritize user privacy, ensuring secure online activities and data protection. +- **[PC Qbittorrent](./roles/pc-qbittorrent/)**: Installation of qBittorrent for file sharing. +- **[PC Torbrowser](./roles/pc-torbrowser/)**: Installation of Tor Browser for anonymous browsing. + +#### Content Creation +Dedicated to creatives and content producers, this category provides tools essential for video streaming, recording, graphic design, and 3D modeling. It's tailored for those involved in digital content creation, offering the necessary software to bring creative projects to life. +- **[PC Streaming Tools](./roles/pc-streaming-tools/)**: Software for video streaming and recording. +- **[PC Designer Tools](./roles/pc-designer-tools/)**: Graphic design and 3D modeling software. + +#### Development Environment +Targets software developers with tools and environments for various programming languages and development needs. +- **[PC Developer Tools](./roles/pc-developer-tools/)**: Basic developer tools setup. +- **[PC Developer Tools Arduino](./roles/pc-developer-tools-arduino/)**: Setup for Arduino development. +- **[PC Developer Tools Bash](./roles/pc-developer-tools-bash/)**: Tools for Bash scripting. +- **[PC Developer Tools Java](./roles/pc-developer-tools-java/)**: Java development environment setup. +- **[PC Developer Tools PHP](./roles/pc-developer-tools-php/)**: PHP development environment setup. +- **[PC Developer Tools Python](./roles/pc-developer-tools-python/)**: Python development environment setup. +- **[PC Virtual Box](./roles/pc-virtual-box/)**: VirtualBox setup for creating virtual machines. +- **[PC Network Analyze Tools](./roles/pc-network-analyze-tools/)**: Network analysis and troubleshooting utilities. \ No newline at end of file diff --git a/README.md b/README.md index de264e46..a18ac53a 100644 --- a/README.md +++ b/README.md @@ -3,250 +3,42 @@ -CyMaIS, powered by Ansible, is designed to streamline the setup and administration of a wide range of applications and Docker images on Linux-based systems. +Welcome to CyMaIS (Cyber Master Infrastructure Solution), a transformative tool designed to redefine IT infrastructure setup for organizations and individuals alike. At its core, CyMaIS leverages the power of Docker, Linux, and Ansible to offer a streamlined, automated solution for deploying and managing IT systems. Whether you're a small startup, a growing enterprise, or an individual seeking efficient IT management, CyMaIS provides a comprehensive suite of tools that cater to a wide range of needs. From simple system setups to complex server configurations and end-user PC management, CyMaIS simplifies the entire process. Our intuitive interface, coupled with in-depth documentation, makes it accessible to both tech-savvy users and those with limited IT experience. 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. -It's a versatile tool for configuring both bare metal servers and personal computers, offering solutions for base system setup, administration tools, backup solutions, system monitoring, updates, driver management, security enhancements, VPN configurations, and more. +## 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. Leveraging the power of Open Source, our tool not only promises to uphold the highest standards of security and adaptability but also embodies a commitment to transparency and community-driven innovation. This is not just a step towards simplifying IT management – it's a leap towards democratizing access to advanced technology, ensuring every business can quickly adapt and thrive in the digital age. -Whether for desktop computing, development environments, server management, or Docker containerization, this playbook provides comprehensive and customizable Ansible roles for efficient system management. +### Solutions Overview -It is designed to allow a super fast setup of small, medium and large business IT infrastructure, following the highest security standards. +To help you navigate through our repository, we have categorized our extensive range of tools and solutions into three key areas: -For detailed information about implementation services and more, visit [CyberMaster.Space](https://cybermaster.space). +1. **[Server Applications](./SERVER_APPLICATIONS.md)**: Detailed information on server-focused tools and configurations, ideal for managing and optimizing server environments. + +2. **[End User Applications](./END_USER_APPLICATIONS.md)**: A guide to applications and tools specifically designed for end-user PCs, enhancing personal computing experience. + +3. **[Common Applications](./COMMON_APPLICATIONS.md)**: A comprehensive list of tools and applications that are versatile and useful across both server and end-user environments. -## Integrated Solutions +Each of these documents provides a tailored overview, ensuring you can find the right tools and information relevant to your specific needs, whether for server management, personal computing, or general IT infrastructure. -### Base Setup +## Key Benefits of CyMaIS for Your Business -Provides essential configurations for system initialization, including hostname setting, systemd journal management, locale configurations, and swapfile handling. +**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: -- **[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. +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. -### Administration Tools +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. -Includes necessary tools for effective system administration, such as Git setup, Linux admin tools, and sudo configuration. +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. -- **[Git](./roles/git/)**: Basic Git version control system setup. -- **[PC-Administrator-Tools](./roles/pc-administrator-tools/)**: Installs basic Linux administration tools. -- **[Sudo](./roles/sudo/)**: Installs and configures sudo. +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. -### Backup Solutions -Focuses on comprehensive backup strategies and cleanup procedures, encompassing data backups, remote server backups, and maintenance of backup storage efficiency. +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. -#### Backups -- **[backup-data-to-usb](./roles/backup-data-to-usb/)**: Automates data backup to USB devices. -- **[backup-docker-to-local](./roles/backup-docker-to-local/)**: Backs up Docker volumes to local storage. -- **[backup-remote-to-local](./roles/backup-remote-to-local/)**: Pulls backups from remote servers for local storage. -- **[backups-provider](./roles/backups-provider/)**: Manages backup processes and storage solutions. -- **[backups-provider-user](./roles/backups-provider-user/)**: Creates and configures users for backup processes. +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. -#### Backups Cleanup -- **[cleanup-backups-service](./roles/cleanup-backups-service/)**: Service to clean up old backups automatically. -- **[cleanup-backups-timer](./roles/cleanup-backups-timer/)**: Timer for scheduling the backup cleanup service. -- **[cleanup-disc-space](./roles/cleanup-disc-space/)**: Manages and frees up disk space on the system. -- **[cleanup-failed-docker-backups](./roles/cleanup-failed-docker-backups/)**: Cleans up failed Docker backups. +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. -### Monitoring - -#### Notifier -Introduces roles for setting up system event notifications, with options for email and Telegram alerts. -- **[Systemd-Notifier](./roles/systemd-notifier/)**: Notifier service for systemd. -- **[Systemd-Notifier-Email](./roles/systemd-notifier-email/)**: Email notifications for systemd services. -- **[Systemd-Notifier-Telegram](./roles/systemd-notifier-telegram/)**: Telegram notifications for systemd services. - -#### Server Health -Addresses server maintenance and health monitoring, ensuring optimal performance and reliability of the server infrastructure. -- **[Health Btrfs](./roles/health-btrfs/)**: Monitors the health of Btrfs filesystems. -- **[Health Disc Space](./roles/health-disc-space/)**: Checks for available disk space. -- **[Health Docker Container](./roles/health-docker-container/)**: Monitors the health of Docker containers. -- **[Health Docker Volumes](./roles/health-docker-volumes/)**: Checks the status of Docker volumes. -- **[Health Journalctl](./roles/health-journalctl/)**: Monitors and manages the system journal. -- **[Health Nginx](./roles/health-nginx/)**: Ensures the Nginx server is running smoothly. -- **[Heal Docker](./roles/heal-docker/)**: Automated healing and maintenance tasks for Docker. - -### Update -Covers automated updates and maintenance for the system and its components, including package managers and Docker containers. -- **[update](./roles/update/)**: Automates the process of system updates. -- **[update-apt](./roles/update-apt/)**: Updates system packages using apt (for Debian-based systems). -- **[update-docker](./roles/update-docker/)**: Keeps Docker containers up to date. -- **[update-pacman](./roles/update-pacman/)**: Updates system packages using Pacman (for Arch-based systems). -- **[update-yay](./roles/update-yay/)**: Updates system packages using yay. - -### Driver -Deals with the installation and configuration of various hardware drivers, catering to a range of devices and needs. -- **[driver-epson-multiprinter](./roles/driver-epson-multiprinter/)**: Installs drivers for Epson multi-function printers. -- **[driver-intel](./roles/driver-intel/)**: Installs Intel drivers, typically for graphics and other hardware. -- **[driver-msi-keyboard-color](./roles/driver-msi-keyboard-color/)**: Configures MSI keyboard color settings. -- **[driver-non-free](./roles/driver-non-free/)**: Installs non-free drivers, generally for specific hardware needs. - -### Security -Enhances system security through roles focused on security measures, swap file management, user configurations, and SSH settings. -- **[System Security](./roles/system-security/)**: Enhances overall system security. -- **[System Swapfile](./roles/system-swapfile/)**: Manages swap files for system memory. -- **[User Administrator](./roles/user-administrator/)**: Setup for system administrator user. -- **[User Alarm](./roles/user-alarm/)**: Manages the alarm user. -- **[PC SSH](./roles/pc-ssh/)**: Configuration of SSH for secure remote access. -- **[SSHD](./roles/sshd/)**: Configures SSH daemon settings. - -### Virtual Private Network (VPN) -Centers on VPN configurations, specifically for Wireguard, providing secure and efficient network connectivity. -- **[client-wireguard](./roles/client-wireguard/)**: Configures Wireguard VPN client. -- **[client-wireguard-behind-firewall](./roles/client-wireguard-behind-firewall/)**: Sets up Wireguard client functionality behind a firewall. -- **[wireguard](./roles/wireguard/)**: Installs and configures Wireguard for secure VPN connections. - - -### Desktop and Personal Computing -Offers a range of tools and software to enhance the personal computing experience on desktops and laptops, covering multimedia, productivity, and virtualization. - -#### Desktop -This category focuses on tools and configurations that enhance the desktop computing experience. It includes utilities to maintain system activity, and software for optimizing the desktop environment, ensuring a seamless and user-friendly interface for day-to-day computer usage. -- **[PC Caffeine](./roles/pc-caffeine/)**: Utility to keep your computer awake. -- **[PC Gnome](./roles/pc-gnome/)**: Installation and configuration of Gnome desktop environment. - -#### Entertainment -Geared towards leisure and entertainment, this section includes software for playing Blu-ray media, accessing a vast collection of music, and installing various computer games. It's designed to enrich your personal computing experience with multimedia enjoyment and gaming. -- **[PC Bluray Player Tools](./roles/pc-bluray-player-tools/)**: Software for playing Blu-ray media on personal computers. -- **[PC Spotify](./roles/pc-spotify/)**: Installation of Spotify for music streaming. -- **[PC Games](./roles/pc-games/)**: Installation of various computer games. - -#### Office -This segment caters to professional productivity needs. It encompasses a range of office-related software, from comprehensive office suites and video conferencing tools to cloud storage solutions, facilitating efficient and organized work in various office environments. -- **[PC LibreOffice](./roles/pc-libreoffice/)**: Installation of the LibreOffice suite. -- **[PC Office](./roles/pc-office/)**: Various office productivity tools. -- **[PC Video Conference](./roles/pc-video-conference/)**: Video conferencing software setup. -- **[PC Nextcloud](./roles/pc-nextcloud/)**: Client setup for Nextcloud cloud storage service. -- **[PC GnuCash](./roles/pc-gnucash/)**: Software to manage finances -- **[PC Jrnl](./roles/pc-jrnl/)**: CLI Journaling - -#### Anonymization -Focusing on privacy and security, the Anonymization section offers tools for secure file sharing and anonymous web browsing. It includes software solutions that prioritize user privacy, ensuring secure online activities and data protection. -- **[PC Qbittorrent](./roles/pc-qbittorrent/)**: Installation of qBittorrent for file sharing. -- **[PC Torbrowser](./roles/pc-torbrowser/)**: Installation of Tor Browser for anonymous browsing. - -#### Content Creation -Dedicated to creatives and content producers, this category provides tools essential for video streaming, recording, graphic design, and 3D modeling. It's tailored for those involved in digital content creation, offering the necessary software to bring creative projects to life. -- **[PC Streaming Tools](./roles/pc-streaming-tools/)**: Software for video streaming and recording. -- **[PC Designer Tools](./roles/pc-designer-tools/)**: Graphic design and 3D modeling software. - -#### Development Environment -Targets software developers with tools and environments for various programming languages and development needs. -- **[PC Developer Tools](./roles/pc-developer-tools/)**: Basic developer tools setup. -- **[PC Developer Tools Arduino](./roles/pc-developer-tools-arduino/)**: Setup for Arduino development. -- **[PC Developer Tools Bash](./roles/pc-developer-tools-bash/)**: Tools for Bash scripting. -- **[PC Developer Tools Java](./roles/pc-developer-tools-java/)**: Java development environment setup. -- **[PC Developer Tools PHP](./roles/pc-developer-tools-php/)**: PHP development environment setup. -- **[PC Developer Tools Python](./roles/pc-developer-tools-python/)**: Python development environment setup. -- **[PC Virtual Box](./roles/pc-virtual-box/)**: VirtualBox setup for creating virtual machines. -- **[PC Network Analyze Tools](./roles/pc-network-analyze-tools/)**: Network analysis and troubleshooting utilities. - -### Server - -#### Webserver -Focuses on web server roles and applications, covering SSL certificates, Nginx configurations, reverse proxies, and email services. -- **[Letsencrypt](./roles/letsencrypt/)**: Configures Let's Encrypt for SSL certificates. -- **[Nginx](./roles/nginx/)**: Installs and configures Nginx web server. -- **[Nginx-Docker-Reverse-Proxy](./roles/nginx-docker-reverse-proxy/)**: Sets up a reverse proxy for Docker containers. -- **[Nginx-Homepage](./roles/nginx-homepage/)**: Configures a homepage for Nginx. -- **[Nginx-Https](./roles/nginx-https/)**: Enables HTTPS configuration for Nginx. -- **[Nginx-Matomo-Tracking](./roles/nginx-matomo-tracking/)**: Integrates Matomo tracking with Nginx. -- **[Nginx-Redirect](./roles/nginx-domain-redirect/)**: Manages URL redirects in Nginx. -- **[Certbot Nginx](./roles/nginx-certbot/)**: Integrates Certbot with Nginx for SSL certificates. -- **[Postfix](./roles/postfix/)**: Setup for the Postfix mail transfer agent. - -#### Docker and Containerization -Dedicated to Docker container setups and application management, offering a wide array of software deployment options. -- **[Docker](./roles/docker/)**: Basic Docker and Docker Compose setup. - -##### Financial Management -Facilitating the deployment of finance-related applications. -- **[Docker Akaunting](./roles/docker-akaunting/)**: Deployment of the Akaunting finance software. - -##### Developer Tools -Setups for development platforms and version control systems. -- **[Docker Gitea](./roles/docker-gitea/)**: Setup for the Gitea git server. -- **[Docker Jenkins](./roles/docker-jenkins/)**: Jenkins automation server setup. -- **[Docker ELK](./roles/docker-elk/)**: Elasticsearch, Logstash, and Kibana (ELK) stack setup. - -##### Content Management -Deployment of various content management systems for web platforms. -- **[Docker Wordpress](./roles/docker-wordpress/)**: Wordpress blog and website platform setup. -- **[Docker Joomla](./roles/docker-joomla/)**: Joomla content management system setup. - -##### Fediverse Networks -Implementing federated and decentralized social platforms. -- **[Docker Funkwhale](./roles/docker-funkwhale/)**: Deployment of Funkwhale, a federated music streaming server. -- **[Docker Mastodon](./roles/docker-mastodon/)**: Deployment of the Mastodon social network server. -- **[Docker Peertube](./roles/docker-peertube/)**: Deployment of the PeerTube video platform. -- **[Docker Pixelfed](./roles/docker-pixelfed/)**: Pixelfed, a federated image sharing platform, setup. - -##### Analytics Solutions -Tools for web and data analytics. -- **[Docker Matomo](./roles/docker-matomo/)**: Setup for Matomo, an open-source analytics platform. - -##### Forum Software -Deployments for community-driven forum platforms. -- **[Docker MyBB](./roles/docker-mybb/)**: Setup for MyBB forum software. -- **[Docker Discourse](./roles/docker-discourse/)**: Setup of Discouse a forum and community platform. - -##### Wiki and Documentation -Setting up platforms for collaborative information sharing. -- **[Docker MediaWiki](./roles/docker-mediawiki/)**: MediaWiki setup for creating wikis. - -##### Event and Shop Management -Tools for managing events and online retail. -- **[Docker Attendize](./roles/docker-attendize/)**: Setup for the Attendize event management tool. - -##### Data and Cloud Storage -Solutions for data management and cloud-based storage. -- **[Docker Baserow](./roles/docker-baserow/)**: Deployment of Baserow, an open-source no-code database tool. -- **[Docker Nextcloud](./roles/docker-nextcloud/)**: Cloud storage solution setup. - -##### Communication and Collaboration -Platforms for enhancing communication and collaborative efforts. -- **[Docker BigBlueButton](./roles/docker-bigbluebutton/)**: Setup for the BigBlueButton video conferencing tool. -- **[Docker Mailu](./roles/docker-mailu/)**: Complete mail server solution. -- **[Docker Matrix](./roles/docker-matrix/)**: Setup and deployment of the Matrix server for secure, decentralized communication. - -##### Marketing and Communication Tools -Focusing on tools that assist in communication, marketing, and outreach efforts. -- **[Docker Listmonk](./roles/docker-listmonk/)**: Setup for Listmonk, a self-hosted newsletter and mailing list manager. - -##### Web Utilities and Services -Encompassing tools that enhance web functionality or provide essential web services. -- **[Docker YOURLS](./roles/docker-yourls/)**: Setup for YOURLS, a URL shortening service. - -##### Miscellaneous -Diverse tools for specific needs and utilities. -- **[Docker Roulette Wheel](./roles/docker-roulette-wheel/)**: Setup for a custom roulette wheel application. - -### Other -Encompasses miscellaneous essential tools and systems, including AUR helper, spellchecking, typesetting, and package management. -- **[System-Aur-Helper](./roles/system-aur-helper/)**: Installs and configures AUR helper (yay). -- **[Hunspell](./roles/hunspell/)**: Installation of Hunspell spellchecker. -- **[Latex](./roles/pc-latex/)**: Installation of LaTeX typesetting system. -- **[Java](./roles/java/)**: Installs Java Development Kit (JDK). -- **[Python Pip](./roles/python-pip/)**: Installation of Python Pip package manager. - -## Key Advantages of CyMaIS -**CyMaIS - Cyber Master Infrastructure Solution** is a comprehensive and agile tool designed for efficient IT infrastructure management and deployment. Here are its key advantages and unique selling points (USP): - -1. **Versatile Automation**: Powered by Ansible, CyMaIS offers streamlined setup and administration across a wide range of applications and Docker images, suitable for both Linux-based servers and personal computers. - -2. **Comprehensive Configuration Suite**: The solution includes a full spectrum of IT infrastructure components – from basic system setup and administration tools to advanced features like VPN configurations and Docker containerization. - -3. **Customizable for Varied Needs**: Whether it's for desktop computing, server management, development environments, or personal computing, CyMaIS provides customizable Ansible roles, ensuring flexibility and adaptability to different requirements. - -4. **Efficient System Monitoring and Updates**: Incorporates roles for system event notifications and health monitoring, ensuring optimal performance and reliability. It also covers automated system updates, keeping the infrastructure current and secure. - -5. **Security and Backup Solutions**: With a strong focus on security, CyMaIS includes roles for enhanced system security, driver management, and comprehensive backup solutions, ensuring data integrity and protection against threats. - -6. **Ease of Use**: Its user-friendly approach, combined with detailed documentation, makes system management accessible even for those with limited technical expertise. - -7. **Open Source Advantage**: Licensed under the GNU Affero General Public License v3.0, CyMaIS aligns with the ethos of open-source software, promoting transparency, community-driven development, and security. - -CyMaIS stands out for its all-encompassing approach to IT infrastructure management, offering a one-stop solution for diverse IT needs, particularly catering to small and medium-sized businesses. +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 @@ -265,4 +57,4 @@ Contact me for more details: ## License -This project is licensed under the GNU Affero General Public License v3.0. The full license text is available in the `LICENSE` file of this repository. +This project is licensed under the GNU Affero General Public License v3.0. The full license text is available in the [LICENSE file](./LICENSE.txt) of this repository. diff --git a/SERVER_APPLICATIONS.md b/SERVER_APPLICATIONS.md new file mode 100644 index 00000000..7d0f4441 --- /dev/null +++ b/SERVER_APPLICATIONS.md @@ -0,0 +1,89 @@ +### Server + +#### Server Health +Addresses server maintenance and health monitoring, ensuring optimal performance and reliability of the server infrastructure. +- **[Health Btrfs](./roles/health-btrfs/)**: Monitors the health of Btrfs filesystems. +- **[Health Disc Space](./roles/health-disc-space/)**: Checks for available disk space. +- **[Health Docker Container](./roles/health-docker-container/)**: Monitors the health of Docker containers. +- **[Health Docker Volumes](./roles/health-docker-volumes/)**: Checks the status of Docker volumes. +- **[Health Journalctl](./roles/health-journalctl/)**: Monitors and manages the system journal. +- **[Health Nginx](./roles/health-nginx/)**: Ensures the Nginx server is running smoothly. +- **[Heal Docker](./roles/heal-docker/)**: Automated healing and maintenance tasks for Docker. + +#### Webserver +Focuses on web server roles and applications, covering SSL certificates, Nginx configurations, reverse proxies, and email services. +- **[Letsencrypt](./roles/letsencrypt/)**: Configures Let's Encrypt for SSL certificates. +- **[Nginx](./roles/nginx/)**: Installs and configures Nginx web server. +- **[Nginx-Docker-Reverse-Proxy](./roles/nginx-docker-reverse-proxy/)**: Sets up a reverse proxy for Docker containers. +- **[Nginx-Homepage](./roles/nginx-homepage/)**: Configures a homepage for Nginx. +- **[Nginx-Https](./roles/nginx-https/)**: Enables HTTPS configuration for Nginx. +- **[Nginx-Matomo-Tracking](./roles/nginx-matomo-tracking/)**: Integrates Matomo tracking with Nginx. +- **[Nginx-Redirect](./roles/nginx-domain-redirect/)**: Manages URL redirects in Nginx. +- **[Certbot Nginx](./roles/nginx-certbot/)**: Integrates Certbot with Nginx for SSL certificates. +- **[Postfix](./roles/postfix/)**: Setup for the Postfix mail transfer agent. + +#### Docker and Containerization +Dedicated to Docker container setups and application management, offering a wide array of software deployment options. +- **[Docker](./roles/docker/)**: Basic Docker and Docker Compose setup. + +##### Financial Management +Facilitating the deployment of finance-related applications. +- **[Docker Akaunting](./roles/docker-akaunting/)**: Deployment of the Akaunting finance software. + +##### Developer Tools +Setups for development platforms and version control systems. +- **[Docker Gitea](./roles/docker-gitea/)**: Setup for the Gitea git server. +- **[Docker Jenkins](./roles/docker-jenkins/)**: Jenkins automation server setup. +- **[Docker ELK](./roles/docker-elk/)**: Elasticsearch, Logstash, and Kibana (ELK) stack setup. + +##### Content Management +Deployment of various content management systems for web platforms. +- **[Docker Wordpress](./roles/docker-wordpress/)**: Wordpress blog and website platform setup. +- **[Docker Joomla](./roles/docker-joomla/)**: Joomla content management system setup. + +##### Fediverse Networks +Implementing federated and decentralized social platforms. +- **[Docker Funkwhale](./roles/docker-funkwhale/)**: Deployment of Funkwhale, a federated music streaming server. +- **[Docker Mastodon](./roles/docker-mastodon/)**: Deployment of the Mastodon social network server. +- **[Docker Peertube](./roles/docker-peertube/)**: Deployment of the PeerTube video platform. +- **[Docker Pixelfed](./roles/docker-pixelfed/)**: Pixelfed, a federated image sharing platform, setup. + +##### Analytics Solutions +Tools for web and data analytics. +- **[Docker Matomo](./roles/docker-matomo/)**: Setup for Matomo, an open-source analytics platform. + +##### Forum Software +Deployments for community-driven forum platforms. +- **[Docker MyBB](./roles/docker-mybb/)**: Setup for MyBB forum software. +- **[Docker Discourse](./roles/docker-discourse/)**: Setup of Discouse a forum and community platform. + +##### Wiki and Documentation +Setting up platforms for collaborative information sharing. +- **[Docker MediaWiki](./roles/docker-mediawiki/)**: MediaWiki setup for creating wikis. + +##### Event and Shop Management +Tools for managing events and online retail. +- **[Docker Attendize](./roles/docker-attendize/)**: Setup for the Attendize event management tool. + +##### Data and Cloud Storage +Solutions for data management and cloud-based storage. +- **[Docker Baserow](./roles/docker-baserow/)**: Deployment of Baserow, an open-source no-code database tool. +- **[Docker Nextcloud](./roles/docker-nextcloud/)**: Cloud storage solution setup. + +##### Communication and Collaboration +Platforms for enhancing communication and collaborative efforts. +- **[Docker BigBlueButton](./roles/docker-bigbluebutton/)**: Setup for the BigBlueButton video conferencing tool. +- **[Docker Mailu](./roles/docker-mailu/)**: Complete mail server solution. +- **[Docker Matrix](./roles/docker-matrix/)**: Setup and deployment of the Matrix server for secure, decentralized communication. + +##### Marketing and Communication Tools +Focusing on tools that assist in communication, marketing, and outreach efforts. +- **[Docker Listmonk](./roles/docker-listmonk/)**: Setup for Listmonk, a self-hosted newsletter and mailing list manager. + +##### Web Utilities and Services +Encompassing tools that enhance web functionality or provide essential web services. +- **[Docker YOURLS](./roles/docker-yourls/)**: Setup for YOURLS, a URL shortening service. + +##### Miscellaneous +Diverse tools for specific needs and utilities. +- **[Docker Roulette Wheel](./roles/docker-roulette-wheel/)**: Setup for a custom roulette wheel application. \ No newline at end of file diff --git a/VISION_STATEMENT.md b/VISION_STATEMENT.md new file mode 100644 index 00000000..95e92b94 --- /dev/null +++ b/VISION_STATEMENT.md @@ -0,0 +1,9 @@ +At the heart of our endeavor lies the creation of an unparalleled tool, designed to revolutionize the way IT infrastructure is deployed and managed in businesses of all scales and across various industries. Our vision is to develop a fully automated solution capable of establishing a 100% secure and infinitely scalable corporate IT infrastructure. + +This tool, grounded firmly in Open Source principles, will not only champion transparency and innovation but also ensure adaptability and accessibility for every business, regardless of its size or industry. We aim to make the complex process of IT setup not just simpler but also faster – achieving full deployment within an audacious timeframe of 24 hours. + +We envision a future where businesses are no longer constrained by the complexities of IT infrastructure setup. Instead, they will be empowered with a tool that seamlessly integrates into their operational fabric, offering a robust, secure, and scalable digital backbone. This tool will not only cater to the immediate IT needs of a company but also be agile enough to evolve with their growing demands and the ever-changing technological landscape. + +Our commitment is to break down barriers to advanced IT infrastructure, democratizing access to high-level technology solutions. By harnessing the power of Open Source, our solution will not only uphold the highest standards of security and scalability but also foster a community-driven approach to continuous improvement and innovation. + +In essence, our vision is to redefine the paradigm of IT infrastructure deployment, making it a swift, secure, and scalable journey for every business, and setting a new benchmark in the industry for efficiency and reliability. \ No newline at end of file