From b78c344df78f250eb60f7c55bfa074b7a64b1fbf Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Sat, 2 Dec 2023 20:52:29 +0100 Subject: [PATCH] Updated README.md --- README.md | 50 ++++++++++++++++++++++++++++++++------------------ 1 file changed, 32 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index ba12ede1..f96a7d24 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,24 @@ With this tool you can setup all of the following application on bare metal serv ## Solutions ### Base Setup + +Provides essential configurations for system initialization, including hostname setting, systemd journal management, locale configurations, and swapfile handling. + - **[Hostname](./roles/hostname/README.md)**: Sets the system's hostname. - **[Journalctl](./roles/journalctl/README.md)**: Configures systemd journal settings. - **[Locales](./roles/locales/README.md)**: Configures system locales. - **[System-Swapfile](./roles/system-swapfile/README.md)**: 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/README.md)**: Installs basic Linux administration tools. - **[Sudo](./roles/sudo/README.md)**: Installs and configures sudo. ### 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/README.md)**: Automates data backup to USB devices. @@ -33,40 +40,56 @@ With this tool you can setup all of the following application on bare metal serv - **[cleanup-disc-space](./roles/cleanup-disc-space/README.md)**: Manages and frees up disk space on the system. - **[cleanup-failed-docker-backups](./roles/cleanup-failed-docker-backups/README.md)**: Cleans up failed Docker backups. -### Notifier +### Monitoring + +#### Notifier +Introduces roles for setting up system event notifications, with options for email and Telegram alerts. - **[Systemd-Notifier](./roles/systemd-notifier/README.md)**: Notifier service for systemd. - **[Systemd-Notifier-Email](./roles/systemd-notifier-email/README.md)**: Email notifications for systemd services. - **[Systemd-Notifier-Telegram](./roles/systemd-notifier-telegram/README.md)**: 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/README.md)**: Automates the process of system updates. - **[update-apt](./roles/update-apt/README.md)**: Updates system packages using apt (for Debian-based systems). - **[update-docker](./roles/update-docker/README.md)**: Keeps Docker containers up to date. - **[update-pacman](./roles/update-pacman/README.md)**: Updates system packages using Pacman (for Arch-based systems). ### 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/README.md)**: Installs drivers for Epson multi-function printers. - **[driver-intel](./roles/driver-intel/README.md)**: Installs Intel drivers, typically for graphics and other hardware. - **[driver-msi-keyboard-color](./roles/driver-msi-keyboard-color/README.md)**: Configures MSI keyboard color settings. - **[driver-non-free](./roles/driver-non-free/README.md)**: 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/README.md)**: Configures SSH daemon settings. +- **[SSHD](./roles/sshd/README.md)**: Configures SSH daemon settings. -### Virtual Private Network +### Virtual Private Network (VPN) +Centers on VPN configurations, specifically for Wireguard, providing secure and efficient network connectivity. - **[client-wireguard](./roles/client-wireguard/README.md)**: Configures Wireguard VPN client. - **[client-wireguard-behind-firewall](./roles/client-wireguard-behind-firewall/README.md)**: Sets up Wireguard client functionality behind a firewall. - **[wireguard](./roles/wireguard/README.md)**: Installs and configures Wireguard for secure VPN connections. ### Desktop and Personal Computing -Tools and software enhancing personal computing on desktops or laptops: - +Offers a range of tools and software to enhance the personal computing experience on desktops and laptops, covering multimedia, productivity, and virtualization. - **[PC Bluray Player Tools](./roles/pc-bluray-player-tools/)**: Software for playing Blu-ray media on personal computers. - **[PC Caffeine](./roles/pc-caffeine/)**: Utility to keep your computer awake. - **[PC Designer Tools](./roles/pc-designer-tools/)**: Graphic design and 3D modeling software. @@ -84,7 +107,7 @@ Tools and software enhancing personal computing on desktops or laptops: - **[PC Virtual Box](./roles/pc-virtual-box/)**: VirtualBox setup for creating virtual machines. ### Development Environment -Tools and environments for software development. +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. @@ -93,6 +116,7 @@ Tools and environments for software development. - **[PC Developer Tools Python](./roles/pc-developer-tools-python/)**: Python development environment setup. ### Other +Encompasses miscellaneous essential tools and systems, including AUR helper, spellchecking, typesetting, and package management. - **[System-Aur-Helper](./roles/system-aur-helper/README.md)**: Installs and configures AUR helper (yay). - **[Hunspell](./roles/hunspell/)**: Installation of Hunspell spellchecker. - **[Latex](./roles/latex/)**: Installation of LaTeX typesetting system. @@ -102,7 +126,7 @@ Tools and environments for software development. ## Server ### Webserver -Roles for web servers and related applications. +Focuses on web server roles and applications, covering SSL certificates, Nginx configurations, reverse proxies, and email services. - **[Letsencrypt](./roles/letsencrypt/README.md)**: Configures Let's Encrypt for SSL certificates. - **[Nginx](./roles/nginx/README.md)**: Installs and configures Nginx web server. - **[Nginx-Docker-Reverse-Proxy](./roles/nginx-docker-reverse-proxy/README.md)**: Sets up a reverse proxy for Docker containers. @@ -114,8 +138,7 @@ Roles for web servers and related applications. - **[Postfix](./roles/postfix/)**: Setup for the Postfix mail transfer agent. ### Docker and Containerization -Setting up Docker containers and managing applications. - +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. - **[Docker Akaunting](./roles/docker-akaunting/)**: Deployment of the Akaunting finance software. - **[Docker Attendize](./roles/docker-attendize/)**: Setup for the Attendize event management tool. @@ -139,15 +162,6 @@ Setting up Docker containers and managing applications. - **[Docker Wordpress](./roles/docker-wordpress/)**: Wordpress blog and website platform setup. - **[Docker YOURLS](./roles/docker-yourls/)**: Setup for YOURLS, a URL shortening service. -## Server Health -- **[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. - ### Setup Run: