kevinveenbirkenbach/computer-playbook
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2024-11-24 21:51:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Optimized README's.md

Browse Source
This commit is contained in:
Kevin Veen-Birkenbach 2023-12-13 14:22:42 +01:00
parent f56ba4a744
commit a835972086
2 changed files with 74 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
COMMON_APPLICATIONS.md
View File

@ -1,74 +1,78 @@
### Base Setup # Common Applications
This section outlines the common applications tailored for both servers and end-users, offering a wide range of functionalities to enhance system performance, security, and usability.
Provides essential configurations for system initialization, including hostname setting, systemd journal management, locale configurations, and swapfile handling. ## 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. - **[Journalctl](./roles/journalctl/)**: Configures systemd journal settings.
- **[Locales](./roles/locales/)**: Configures system locales. - **[Locales](./roles/locales/)**: Configures system locales.
- **[System-Swapfile](./roles/system-swapfile/)**: Configures swapfile creation and management. - **[System-Swapfile](./roles/system-swapfile/)**: Configures swapfile creation and management.
### Administration Tools ## Administration Tools
These tools are crucial for effective system administration, encompassing Git setup, Linux admin tools, and sudo configuration, suitable for both server environments and power users.
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. - **[Git](./roles/git/)**: Basic Git version control system setup.
- **[PC-Administrator-Tools](./roles/pc-administrator-tools/)**: Installs basic Linux administration tools. - **[Administrator-Tools](./roles/pc-administrator-tools/)**: Installs basic Linux administration tools.
- **[Sudo](./roles/sudo/)**: Installs and configures sudo. - **[Sudo](./roles/sudo/)**: Installs and configures sudo.
### Update ## Update
Covers automated updates and maintenance for the system and its components, including package managers and Docker containers. This category focuses on automated updates and maintenance for the system and its components, including package managers and Docker containers, ensuring systems are up-to-date and secure.
- **[update](./roles/update/)**: Automates the process of system updates. - **[update](./roles/update/)**: Automates the process of system updates.
- **[update-apt](./roles/update-apt/)**: Updates system packages using apt (for Debian-based systems). - **[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-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-pacman](./roles/update-pacman/)**: Updates system packages using Pacman (for Arch-based systems).
- **[update-yay](./roles/update-yay/)**: Updates system packages using yay. - **[update-yay](./roles/update-yay/)**: Updates system packages using yay.
### Driver ## Driver
Deals with the installation and configuration of various hardware drivers, catering to a range of devices and needs. Caters to a range of devices and needs for hardware driver installation and configuration, an integral part for both server hardware optimization and end-user device functionality.
- **[driver-epson-multiprinter](./roles/driver-epson-multiprinter/)**: Installs drivers for Epson multi-function printers. - **[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-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-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. - **[driver-non-free](./roles/driver-non-free/)**: Installs non-free drivers, generally for specific hardware needs.
### Security ## Security
Enhances system security through roles focused on security measures, swap file management, user configurations, and SSH settings. Enhances system security with roles focused on security measures, user configurations, and SSH settings. It's vital for protecting both server environments and end-user systems.
- **[System Security](./roles/system-security/)**: Enhances overall system security. - **[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 Administrator](./roles/user-administrator/)**: Setup for system administrator user.
- **[User Alarm](./roles/user-alarm/)**: Manages the alarm user. - **[User Alarm](./roles/user-alarm/)**: Manages the alarm user.
- **[PC SSH](./roles/pc-ssh/)**: Configuration of SSH for secure remote access. - **[PC SSH](./roles/pc-ssh/)**: Configuration of SSH for secure remote access.
- **[SSHD](./roles/sshd/)**: Configures SSH daemon settings. - **[SSHD](./roles/sshd/)**: Configures SSH daemon settings.
### Virtual Private Network (VPN) ## Virtual Private Network (VPN)
Centers on VPN configurations, specifically for Wireguard, providing secure and efficient network connectivity. Centers on VPN configurations for secure and efficient network connectivity, particularly crucial for remote server access and end-users needing secure connections.
- **[client-wireguard](./roles/client-wireguard/)**: Configures Wireguard VPN client. - **[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. - **[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. - **[wireguard](./roles/wireguard/)**: Installs and configures Wireguard for secure VPN connections.
#### Notifier ## Notifier
Introduces roles for setting up system event notifications, with options for email and Telegram alerts. Sets up system event notifications via email and Telegram, a versatile feature for server administrators and end-users alike to stay informed about their system's status.
- **[Systemd-Notifier](./roles/systemd-notifier/)**: Notifier service for systemd. - **[Systemd-Notifier](./roles/systemd-notifier/)**: Notifier service for systemd.
- **[Systemd-Notifier-Email](./roles/systemd-notifier-email/)**: Email notifications for systemd services. - **[Systemd-Notifier-Email](./roles/systemd-notifier-email/)**: Email notifications for systemd services.
- **[Systemd-Notifier-Telegram](./roles/systemd-notifier-telegram/)**: Telegram notifications for systemd services. - **[Systemd-Notifier-Telegram](./roles/systemd-notifier-telegram/)**: Telegram notifications for systemd services.
### Backup Solutions ## Backup Solutions
Focuses on comprehensive backup strategies and cleanup procedures, encompassing data backups, remote server backups, and maintenance of backup storage efficiency. Focuses on comprehensive backup strategies and cleanup procedures, encompassing data backups, remote server backups, and maintenance of backup storage efficiency, crucial for data integrity in both servers and personal devices.
#### Backups ### Backups
For USB devices, Docker volumes, remote servers, and user configurations.
- **[backup-data-to-usb](./roles/backup-data-to-usb/)**: Automates data backup to USB devices. - **[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-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. - **[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](./roles/backups-provider/)**: Manages backup processes and storage solutions.
- **[backups-provider-user](./roles/backups-provider-user/)**: Creates and configures users for backup processes. - **[backups-provider-user](./roles/backups-provider-user/)**: Creates and configures users for backup processes.
#### Backups Cleanup ### Backups Cleanup
Manages disk space and cleans up old or failed backups.
- **[cleanup-backups-service](./roles/cleanup-backups-service/)**: Service to clean up old backups automatically. - **[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-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-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. - **[cleanup-failed-docker-backups](./roles/cleanup-failed-docker-backups/)**: Cleans up failed Docker backups.
### Other ## Other
Encompasses miscellaneous essential tools and systems, including AUR helper, spellchecking, typesetting, and package management. Encompasses miscellaneous essential tools and systems, including package management, spellchecking, and typesetting, beneficial for both server maintenance and enhancing end-user experience.
- **[System-Aur-Helper](./roles/system-aur-helper/)**: Installs and configures AUR helper (yay). - **[System-Aur-Helper](./roles/system-aur-helper/)**: Installs and configures AUR helper (yay).
- **[Hunspell](./roles/hunspell/)**: Installation of Hunspell spellchecker. - **[Hunspell](./roles/hunspell/)**: Installation of Hunspell spellchecker.
- **[Latex](./roles/pc-latex/)**: Installation of LaTeX typesetting system. - **[Latex](./roles/pc-latex/)**: Installation of LaTeX typesetting system.

89
SERVER_APPLICATIONS.md
View File

@ -1,6 +1,10 @@
### Server # Server Applications
Server applications encompass a wide array of functionalities designed to enhance the performance, reliability, and usability of server infrastructures. These applications are essential for maintaining server health, managing web services, facilitating containerization, and providing various tools for specific server needs.
#### Server Health ## Common Applications
For a detailed overview of the broad spectrum of server applications, including base setup, administration tools, update mechanisms, driver installations, security enhancements, VPN configurations, notifier services, backup solutions, and other essential tools and systems, please refer to the **[COMMON_APPLICATIONS.md](./COMMON_APPLICATIONS.md)**. This document provides insights into categories and specific roles catered to both server and end-user environments, ensuring comprehensive server management and optimization.
## Server Health
Addresses server maintenance and health monitoring, ensuring optimal performance and reliability of the server infrastructure. 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 Btrfs](./roles/health-btrfs/)**: Monitors the health of Btrfs filesystems.
- **[Health Disc Space](./roles/health-disc-space/)**: Checks for available disk space. - **[Health Disc Space](./roles/health-disc-space/)**: Checks for available disk space.
@ -10,7 +14,7 @@ Addresses server maintenance and health monitoring, ensuring optimal performance
- **[Health Nginx](./roles/health-nginx/)**: Ensures the Nginx server is running smoothly. - **[Health Nginx](./roles/health-nginx/)**: Ensures the Nginx server is running smoothly.
- **[Heal Docker](./roles/heal-docker/)**: Automated healing and maintenance tasks for Docker. - **[Heal Docker](./roles/heal-docker/)**: Automated healing and maintenance tasks for Docker.
#### Webserver ## Webserver
Focuses on web server roles and applications, covering SSL certificates, Nginx configurations, reverse proxies, and email services. 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. - **[Letsencrypt](./roles/letsencrypt/)**: Configures Let's Encrypt for SSL certificates.
- **[Nginx](./roles/nginx/)**: Installs and configures Nginx web server. - **[Nginx](./roles/nginx/)**: Installs and configures Nginx web server.
@ -18,72 +22,73 @@ Focuses on web server roles and applications, covering SSL certificates, Nginx c
- **[Nginx-Homepage](./roles/nginx-homepage/)**: Configures a homepage for Nginx. - **[Nginx-Homepage](./roles/nginx-homepage/)**: Configures a homepage for Nginx.
- **[Nginx-Https](./roles/nginx-https/)**: Enables HTTPS configuration 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-Matomo-Tracking](./roles/nginx-matomo-tracking/)**: Integrates Matomo tracking with Nginx.
- **[Nginx-Redirect](./roles/nginx-domain-redirect/)**: Manages URL redirects in Nginx. - **[Nginx-Domain-Redirect](./roles/nginx-domain-redirect/)**: Manages URL redirects in Nginx.
- **[Certbot Nginx](./roles/nginx-certbot/)**: Integrates Certbot with Nginx for SSL certificates. - **[Nginx-WWW-Redirect](./roles/nginx-www-redirect/)**: Redirects all domains with the prefix www. from www.domain.tld to domain.tld
- **[Nginx-Certbot](./roles/nginx-certbot/)**: Integrates Certbot with Nginx for SSL certificates.
- **[Postfix](./roles/postfix/)**: Setup for the Postfix mail transfer agent. - **[Postfix](./roles/postfix/)**: Setup for the Postfix mail transfer agent.
#### Docker and Containerization ## Docker and Containerization
Dedicated to Docker container setups and application management, offering a wide array of software deployment options. 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](./roles/docker/)**: Basic Docker and Docker Compose setup.
##### Financial Management ### Financial Management
Facilitating the deployment of finance-related applications. Facilitating the deployment of finance-related applications.
- **[Docker Akaunting](./roles/docker-akaunting/)**: Deployment of the Akaunting finance software. - **[Docker Akaunting](./roles/docker-akaunting/)**: Deployment of the Akaunting finance software.
##### Developer Tools ### Continues Integration and Continues Delivery
Setups for development platforms and version control systems. Setups for development platforms and version control systems.
- **[Docker Gitea](./roles/docker-gitea/)**: Setup for the Gitea git server. - **[Gitea](./roles/docker-gitea/)**: Setup for the Gitea git server.
- **[Docker Jenkins](./roles/docker-jenkins/)**: Jenkins automation server setup. - **[Jenkins](./roles/docker-jenkins/)**: Jenkins automation server setup.
- **[Docker ELK](./roles/docker-elk/)**: Elasticsearch, Logstash, and Kibana (ELK) stack setup. - **[ELK](./roles/docker-elk/)**: Elasticsearch, Logstash, and Kibana (ELK) stack setup.
##### Content Management ### Content Management
Deployment of various content management systems for web platforms. Deployment of various content management systems for web platforms.
- **[Docker Wordpress](./roles/docker-wordpress/)**: Wordpress blog and website platform setup. - **[Wordpress](./roles/docker-wordpress/)**: Wordpress blog and website platform setup.
- **[Docker Joomla](./roles/docker-joomla/)**: Joomla content management system setup. - **[Joomla](./roles/docker-joomla/)**: Joomla content management system setup.
##### Fediverse Networks ### Fediverse Networks
Implementing federated and decentralized social platforms. Implementing federated and decentralized social platforms.
- **[Docker Funkwhale](./roles/docker-funkwhale/)**: Deployment of Funkwhale, a federated music streaming server. - **[Funkwhale](./roles/docker-funkwhale/)**: Deployment of Funkwhale, a federated music streaming server.
- **[Docker Mastodon](./roles/docker-mastodon/)**: Deployment of the Mastodon social network server. - **[Mastodon](./roles/docker-mastodon/)**: Deployment of the Mastodon social network server.
- **[Docker Peertube](./roles/docker-peertube/)**: Deployment of the PeerTube video platform. - **[Peertube](./roles/docker-peertube/)**: Deployment of the PeerTube video platform.
- **[Docker Pixelfed](./roles/docker-pixelfed/)**: Pixelfed, a federated image sharing platform, setup. - **[Pixelfed](./roles/docker-pixelfed/)**: Pixelfed, a federated image sharing platform, setup.
##### Analytics Solutions ### Analytics Solutions
Tools for web and data analytics. Tools for web and data analytics.
- **[Docker Matomo](./roles/docker-matomo/)**: Setup for Matomo, an open-source analytics platform. - **[Matomo](./roles/docker-matomo/)**: Setup for Matomo, an open-source analytics platform.
##### Forum Software ### Forum Software
Deployments for community-driven forum platforms. Deployments for community-driven forum platforms.
- **[Docker MyBB](./roles/docker-mybb/)**: Setup for MyBB forum software. - **[MyBB](./roles/docker-mybb/)**: Setup for MyBB forum software.
- **[Docker Discourse](./roles/docker-discourse/)**: Setup of Discouse a forum and community platform. - **[Discourse](./roles/docker-discourse/)**: Setup of Discouse a forum and community platform.
##### Wiki and Documentation ### Wiki and Documentation
Setting up platforms for collaborative information sharing. Setting up platforms for collaborative information sharing.
- **[Docker MediaWiki](./roles/docker-mediawiki/)**: MediaWiki setup for creating wikis. - **[MediaWiki](./roles/docker-mediawiki/)**: MediaWiki setup for creating wikis.
##### Event and Shop Management ### Event and Shop Management
Tools for managing events and online retail. Tools for managing events and online retail.
- **[Docker Attendize](./roles/docker-attendize/)**: Setup for the Attendize event management tool. - **[Attendize](./roles/docker-attendize/)**: Setup for the Attendize event management tool.
##### Data and Cloud Storage ### Data and Cloud Storage
Solutions for data management and cloud-based storage. Solutions for data management and cloud-based storage.
- **[Docker Baserow](./roles/docker-baserow/)**: Deployment of Baserow, an open-source no-code database tool. - **[Baserow](./roles/docker-baserow/)**: Deployment of Baserow, an open-source no-code database tool.
- **[Docker Nextcloud](./roles/docker-nextcloud/)**: Cloud storage solution setup. - **[Nextcloud](./roles/docker-nextcloud/)**: Cloud storage solution setup.
##### Communication and Collaboration ### Communication and Collaboration
Platforms for enhancing communication and collaborative efforts. Platffor enhancing communication and collaborative efforts.
- **[Docker BigBlueButton](./roles/docker-bigbluebutton/)**: Setup for the BigBlueButton video conferencing tool. - **[BigBlueButton](./roles/docker-bigbluebutton/)**: Setup for the BigBlueButton video conferencing tool.
- **[Docker Mailu](./roles/docker-mailu/)**: Complete mail server solution. - **[Mailu](./roles/docker-mailu/)**: Complete mail server solution.
- **[Docker Matrix](./roles/docker-matrix/)**: Setup and deployment of the Matrix server for secure, decentralized communication. - **[Matrix](./roles/docker-matrix/)**: Setup and deployment of the Matrix server for secure, decentralized communication.
##### Marketing and Communication Tools ### Marketing and Communication Tools
Focusing on tools that assist in communication, marketing, and outreach efforts. 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. - **[Listmonk](./roles/docker-listmonk/)**: Setup for Listmonk, a self-hosted newsletter and mailing list manager.
##### Web Utilities and Services ### Web Utilities and Services
Encompassing tools that enhance web functionality or provide essential web services. Encompassing tools that enhance web functionality or provide essential web services.
- **[Docker YOURLS](./roles/docker-yourls/)**: Setup for YOURLS, a URL shortening service. - **[YOURLS](./roles/docker-yourls/)**: Setup for YOURLS, a URL shortening service.
##### Miscellaneous ### Miscellaneous
Diverse tools for specific needs and utilities. Diverse tools for specific needs and utilities.
- **[Docker Roulette Wheel](./roles/docker-roulette-wheel/)**: Setup for a custom roulette wheel application. - **[Roulette Wheel](./roles/docker-roulette-wheel/)**: Setup for a custom roulette wheel application.